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. - [ ] Outbound internet from that host, to download Ferrule.
- [ ] 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.
- [ ] A license key, if you were sent one. Without one, Ferrule starts a 30-day trial with everything turned on, and then carries on with the free features (Editions).
- [ ] About fifteen minutes.
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.
Write each password down somewhere safe
You enter them in your settings once. Ferrule never shows them again, not even to you.