Before you begin¶
At the end of this page you'll know you have everything you need, and you'll have the read-only accounts Ferrule will use.
You need¶
- [ ] A Docker host, with either Portainer or Docker Compose
(the
docker composecommand). Any Linux machine or VM that runs Docker will do, and it can share the host with other containers. - [ ] Port 8090 free on that host, for the dashboard. (It can be changed in the setup wizard.)
- [ ] Outbound internet from that host, to download Ferrule.
- [ ] No other Ferrule stack on that host. Two clash: their containers have the same names.
- [ ] Something to watch. At least one of:
- a UniFi console: a gateway such as a UDM, UDM-SE or Cloud Gateway, and a UNVR if Protect runs on its own box;
- Proxmox VE, Proxmox Backup Server, or VMware vCenter;
- a Synology, QNAP or TrueNAS.
- [ ] The license key you were sent. Ferrule is in private beta and watches nothing without one. No key yet? Ask for one on the Ferrule Discord.
- [ ] About twenty minutes, most of it making the accounts below.
Make the read-only accounts first¶
Ferrule signs in to each system with an account that can look but not change anything. Make these before you install, so you have them to hand. Each page below has the exact clicks:
| You have | Make this | Page |
|---|---|---|
| A UniFi gateway | an API key and a read-only local admin | UniFi Network |
| A UNVR running Protect | the same again, on the UNVR | UniFi Protect |
| Proxmox VE | a user and an API token, with the PVEAuditor role | Proxmox VE |
| Proxmox Backup Server | a user and an API token, with the Audit role | Proxmox Backup Server |
| VMware vCenter | a user with the Read-only role | vCenter |
| Synology | a user in the administrators group, with no app or folder access | Synology |
| QNAP | an SNMPv3 user | QNAP |
| TrueNAS | a Read-only Admin user and an API key | TrueNAS |
You can start with UniFi alone and add the others later.
Keep each password somewhere safe
You type them into the setup wizard once, which tests them and writes them into your settings. Ferrule never shows them again, not even to you.
A $ in a password
The setup wizard handles it for you. If you ever type a value into the
stack by hand, write each $ as $$: Docker Compose reads $name as a
variable, so a password starting with $ would arrive cut short.
Next¶
Install: start an empty stack, and the setup wizard opens.