From 7f0d7bbdb184acc14a5d562df77d194fde88bcc0 Mon Sep 17 00:00:00 2001 From: Mithi83 Date: Sun, 5 Mar 2023 20:58:40 +0100 Subject: [PATCH] linux.md: mention firewall and port requirements (#2007) As requested here https://github.com/openhab/openhab-docs/issues/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. --- installation/linux.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/installation/linux.md b/installation/linux.md index 72785916d2..68972e7053 100644 --- a/installation/linux.md +++ b/installation/linux.md @@ -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) @@ -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://openhab@192.168.0.2` 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 +```