Skip to content
This repository has been archived by the owner on Sep 28, 2024. It is now read-only.

Commit

Permalink
📝 Add information about HA syncthing integration
Browse files Browse the repository at this point in the history
closes #420
closes #414
closes #357
  • Loading branch information
Poeschl committed Oct 13, 2023
1 parent 8a6899e commit 9f94cbe
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
1 change: 1 addition & 0 deletions syncthing/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
## 1.16.4 - 2023-10-??

* 🔨 DOCS.md: Add information about HA Syncthing Integration (thanks @reedy & @salim-b | #420)
* 🔨 DOCS.md: Improve Configuration section (thanks @reedy | #419)
* 🔼 Updated syncthing to `1.25.0-r0` (thanks @salim-b | #412)

Expand Down
12 changes: 11 additions & 1 deletion syncthing/DOCS.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
## Configuration

Configuration is done via [Syncthing's web UI](/hassio/ingress/243ffc37_syncthing) (embedded into Home Assistant). First start the add-on from the [*Info* tab](/hassio/addon/243ffc37_syncthing/info) and then click <kbd>OPEN WEB UI</kbd>.
Configuration is done via [Syncthing's web UI](/hassio/ingress/243ffc37_syncthing) (embedded into Home Assistant). First start the add-on from the [*Info* tab](/hassio/addon/243ffc37_syncthing/info) and then click `OPEN WEB UI`.

## Syncthing Home Assistant integration

If you want to monitor the Syncthing add-on via Home Assistant's [**Syncthing** integration](https://www.home-assistant.io/integrations/syncthing/), you need to expose Syncthing's web UI to the (local) network rather than only to the [Home Assistant Supervisor](https://developers.home-assistant.io/docs/supervisor).

To do so, go to the add-on's [*Configuration* tab](/hassio/addon/243ffc37_syncthing/config), toggle `Show disabled ports` and enter a port number in the field labelled *Web frontend (not needed with Ingress)* (`8384`, as per the default, is fine). Click `SAVE`, switch to the [*Info* tab](/hassio/addon/243ffc37_syncthing/info) and click `RESTART`.

To finish the setup, follow the sections [*Prerequisites*](https://www.home-assistant.io/integrations/syncthing/#prerequisites) and [*Configuration*](https://www.home-assistant.io/integrations/syncthing/#configuration) from the integration's documentation.

NOTE that if your Home Assistant installation is reachable from the internet (e.g. because you enabled [remote access](https://www.home-assistant.io/docs/configuration/remote/)), setting the above port has security implications. It's strongly advised to set a `GUI Authentication User` and a strong `GUI Authentication Password` via Syncthing's settings in that case. See [*Security Principles*](https://docs.syncthing.net/users/security) for further information.

## Available directories

Expand Down

0 comments on commit 9f94cbe

Please sign in to comment.