Skip to content

Watching without UniFi

Ferrule works without any UniFi equipment. It can watch only your hypervisors and storage, or only up-checks of anything with an address.

In the setup wizard

  1. On the What you have page, untick A UniFi console (gateway, UDM, Cloud Gateway).
  2. Under Servers and storage, enter how many of each system you have. You need at least one.
  3. Fill in each system's page and click Test. Each type has its own page on making the read-only account: Proxmox VE, Proxmox Backup Server, vCenter, Synology, QNAP or TrueNAS.

The wizard writes UNIFI_ENABLED=false into ferrule.env for you. See the setup wizard for the rest.

Editing the stack by hand

Use UNIFI_ENABLED=false in place of every UNIFI_ and PROTECT_ line, and add at least one SOURCE_n line with its SOURCE_n_SECRET, or a CHECKS line. See Every variable.

Ferrule won't start with nothing to watch. With UniFi off, no source and no up-check, the log says:

UNIFI_ENABLED=false and no SOURCE_1..SOURCE_8 or CHECKS is set, so there is nothing to watch

What changes

The WAN and Cameras tabs don't appear, nor does LAN unless you have up-checks. You get the Virtualization and Storage tabs for what you added, and Settings. Everything else works the same: alerts, notifications, history, sign-in and backups.

Trying Ferrule beside another monitoring stack

UNIFI_ENABLED=false is also the way to try Ferrule next to a stack that already reads your UniFi console, so the console isn't read twice. See Running beside another stack.