Unifi Controller
Unifi Controller is a network management platform for Unifi devices.
This integration is using the node-unifi library under the hood to connect to the Unifi Controller. Therefore it should support CloudKey Gen1, CloudKey Gen2, UnifiOS-based UDM-Pro controllers as well as self-hosted UniFi controllers.
Widgets & Capabilities
VPN users are counted from active remote VPN sessions across all sites. Controllers that return HTTP 404 for
stat/remoteuservpn use the legacy health counter instead; a successful empty session list counts as zero.
This avoids the stale L2TP health counter on UniFi Network 10.6.106. VPN types absent from that endpoint cannot be
counted. If a site's session request fails or returns an invalid response, the VPN user total is shown as unknown
while the other network metrics remain available. VPN status still uses the controller's health subsystem.
Adding the integration
Create the connection under Management → Integrations. See Managing integrations.
Use the local HTTPS address of your controller:
- UniFi OS consoles such as Dream Router, Dream Machine, Cloud Gateway, and CloudKey use
https://<host>(port 443). - Self-hosted UniFi Network Servers normally use
https://<host>:8443. - If you omit the port, Homarr tries port 443 first and then port 8443 when the first port cannot be reached.
Use a local administrator account. Cloud-only accounts and accounts with multi-factor authentication are not supported by the underlying client.
Secrets
| Name | Description |
|---|---|
Username | Account username for authentication. |
Password | Account password for authentication. |