Skip to content

Commit

Permalink
linux.md: mention firewall and port requirements (#2007)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
Mithi83 authored Mar 5, 2023
1 parent 94cf65c commit 7f0d7bb
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions installation/linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -261,6 +261,7 @@ sudo systemctl enable openhab.service
The first start may take **up to 15 minutes**, this is a good time to reward yourself with hot coffee or a freshly brewed tea!

You should be able to reach the openHAB Dashboard at `http://openhab-device:8080` at this point.
Be sure to check whether you need to adjust your [firewall settings](#required-ports-and-firewalls).
If you're new to openHAB, then you should checkout the [beginner's tutorial]({{base}}/tutorial/first_steps.html)!

![The openHAB Dashboard page](images/Home_Openhab_3.png)
Expand Down Expand Up @@ -836,3 +837,22 @@ When asked, authenticate with the username "openhab" and the chosen password.
If you are not able to connect, try with the IP of your device (e.g. `smb://[email protected]` or `\\192.168.0.2`).
If everything went well, you are set and ready to start [configuring]({{base}}/configuration/index.html) your openHAB system.
### Required Ports and Firewalls
Depending on your Linux distribution your system might come with a preconfigured firewall that could prevent access to the openHAB Dashboard.
Refer to your distribution's firewall documentation to open the required ports.
| Port | Protocol | Purpose |
|------|----------|---------|
| 8080 | TCP | openHAB Dashboard via HTTP |
| 8443 | TCP | openHAB Dashboard via HTTPS |
| 5007 | TCP | Language Server Protocol (LSP) for VS Code |
On a system using firewalld you could use the following commands:
```shell
sudo firewall-cmd --permanent --add-port=8080/tcp
sudo firewall-cmd --permanent --add-port=8443/tcp
sudo firewall-cmd --permanent --add-port=5007/tcp
```

0 comments on commit 7f0d7bb

Please sign in to comment.