2024.12.5
Home ▸ Integrations ▸

Syncthing

Syncthing is a continuous file synchronization program. It synchronizes files between two or more computers in real-time, safely protected from prying eyes.

The Syncthing integration allows you to monitor states of your synced folders from within Home Assistant and set up automations based on the information.

Prerequisites

To set up the monitoring you need to get an API key. Open the Syncthing web interface (e.g., http://127.0.0.1:8384) in the browser and go to Actions > Settings. You will find the key on the right of the settings dialog.

Configuration

To add the Syncthing integration to your Home Assistant instance, use this My button:

Manual configuration steps

If the above My button doesn’t work, you can also perform the following steps manually:

  • Browse to your Home Assistant instance.

  • Go to Settings > Devices & Services.

  • In the bottom right corner, select the Add Integration button.

  • From the list, select Syncthing.

  • Follow the instructions on screen to complete the setup.

Integration entities

The Syncthing integration adds one sensor per syncing folder:

Syncthing Sensors

Syncthing Sensors