Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Suggestion: Mention firewall and port requirements in the Linux installation guide #2006

Open
Mithi83 opened this issue Feb 10, 2023 · 2 comments

Comments

@Mithi83
Copy link
Contributor

Mithi83 commented Feb 10, 2023

I've followed the guide on https://www.openhab.org/docs/installation/linux.html to install openHAB on a Fedora 37 VM. At the point where I wanted to access the fresh installation via HTTP I could not connect to the webservice and it took me a rather long time and a wireshark log to figure out what was wrong. In the end, my problem was the default firewall of the Fedora system that blocked port 8080 and 8443.

I can imagine that many Linux distributions come with some sort of restrictive default firewall config and mentioning the need to allow certain ports in the firewall could be necessary. While it is probably out of scope for the openHAB documentation to walk the user through their distributions firewall setup, it would have saved me some time if the need for a proper firewall configuration.

Therefore I suggest you add a section with a list of required ports and the hint to check if a firewall could get in the way. From what I've seen so far it seems to be 8080/tcp and 8443/tcp, but maybe that is incomplete. This could be part of a troubleshooting section or be an item in the "Recommended Additional Setup Steps" section.

For those interested what was necessary on Fedora (using firewalld):
sudo firewall-cmd --permanent --add-port=8080/tcp
sudo firewall-cmd --permanent --add-port=8443/tcp

@rkoshak
Copy link
Contributor

rkoshak commented Feb 10, 2023

Therefore I suggest you add a section with a list of required ports and the hint to check if a firewall could get in the way.

We would welcome it if you were to offer the change. You can do it all in the browser even. There's an "Edit this page in GitHub" link at the bottom of the page which will take you straight to the place to add your suggested changes.

https://community.openhab.org/t/wiki-how-to-contribute-to-the-openhab-documentation/111308 provides a great tutorial if you need it for how to do it but it's really simple.

Note: Port 5007 is used to host an LSP which VS Code can connect to to syntactically check your config as you type it. Some bindings may open additional ports.

Mithi83 added a commit to Mithi83/openhab-docs that referenced this issue Feb 14, 2023
As requested here openhab#2006 I tried to write a small firewall section for the Linux installation documentation to help new users that struggle to open the dashboard after a fresh install due to an interfering firewall.
stefan-hoehn pushed a commit that referenced this issue Mar 5, 2023
As requested here #2006 I tried to write a small firewall section for the Linux installation documentation to help new users that struggle to open the dashboard after a fresh install due to an interfering firewall.
@wborn
Copy link
Member

wborn commented Aug 12, 2023

This issue can be closed as it was fixed with #2007.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants