Skip to content

TrueNAS

At the end of this page Ferrule will be reading TrueNAS SCALE or CORE: pools, every disk's errors and temperature, and TrueNAS's own alerts.

In TrueNAS

  1. Credentials → Users → Add: a user telemetry with the Read-only Admin role.
  2. Create an API key for that user, and copy it now.

In Ferrule

  1. Click Settings ⚙ and find Add a source.
  2. Kind: TrueNAS. Fill in Name (anything you'll recognise), Address and User (blank for an API key).
  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 API key:
  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 API key

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

  • Address: https://<truenas>
  • User: leave it blank to use the API key.

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

TrueNAS's own alerts, just as TrueNAS shows them. Dismissing an alert in TrueNAS clears it in Ferrule.