Skip to content

Synology DSM

At the end of this page Ferrule will be reading your Synology: volumes, every drive's health and temperature, and DSM's own temperature warning.

In DSM

Go to Control Panel → User & Group:

  1. Create a user telemetry with a long random password, and add it to the administrators group.
  2. On the Applications tab, deny everything. On Shared Folders, give it no access.
  3. Leave 2-step verification off for this account.
Why an administrator?

DSM shows disk and volume health only to administrators. Denying every app and folder means the account can read health and nothing else.

In Ferrule

  1. Click Settings ⚙ and find Add a source.
  2. Kind: Synology DSM. Fill in Name (anything you'll recognise), Address and User.
  3. Ferrule writes two lines, such as SOURCE_1=... and SOURCE_1_SECRET=.... Click Copy.
  4. Add both lines to your settings, and replace the placeholder in the _SECRET line with the password:
  1. Open the ferrule stack and find Environment variables.
  2. Add or change the lines. In Advanced mode you can paste several at once.
  3. Click Pull and redeploy.
  1. Open .env in the folder where you cloned ferrule-deploy.
  2. Add or change the lines.
  3. Run docker compose up -d in that folder.

Ferrule never asks for the password

It only goes into your settings. The Settings page shows whether it's set, never what it is.

  • Address: https://<synology>:5001
  • User: telemetry

How to know it worked

  • Settings → Sources lists it, with the state polling. Right after an update it says waiting for first poll for up to a minute.
  • It appears on the Storage tab.

What it alerts on

A volume degraded or crashed, a drive DSM flags or whose SMART check has failed, a volume nearly full, and DSM saying the box is too hot.