Syncthing
Show whether your Syncthing folders are up to date, what is syncing and which devices are connected.
The Syncthing widget shows whether each shared folder is up to date, how far a sync has gone and what is left to receive, folders with failed files, the other devices (connected or not) and the transfer rate. It only reads: NasDash never changes Syncthing's configuration.
Connect it
- In Syncthing, open Actions → Settings → General and copy the API key.
- In NasDash, open Settings → Integrations → File sync → Syncthing.
- Enter the address of Syncthing's web interface, for example
http://nas.example.com:8384, and paste the key. Turn on Accept a self-signed certificate if the interface uses Syncthing's own HTTPS certificate. - Save and test the connection, then add the Syncthing widget and choose the connection in its settings.
The address must be reachable from the NasDash container. Syncthing's interface listens on 127.0.0.1:8384 by default: set its GUI listen address to 0.0.0.0:8384 (and keep a GUI password), or run both in the same Docker network and use the service name.
What it reads
NasDash reads the status, version, configured folders and devices, connections and each folder's status (at most 24 folders). Syncthing documents the folder status as expensive, so one reading is shared for 30 seconds by every widget on the same connection. The transfer rate is the difference between two readings; it appears from the second one.
Display and access
The widget can be full or compact. It lists every folder or only the active ones (syncing, waiting or in error), leaves out the folders you hide, and can hide the devices and the transfer rate. Viewers need the Syncthing permission (Settings → Users and access). The API key gives full access to Syncthing: it stays on the NasDash server, encrypted on disk, and is never sent to a browser. The public demo shows fictional folders.