mirror of
https://github.com/karl0ss/homepage.git
synced 2025-04-29 12:03:41 +01:00
33 lines
1.1 KiB
Markdown
33 lines
1.1 KiB
Markdown
---
|
|
title: Unifi Controller
|
|
description: Unifi Controller Widget Configuration
|
|
---
|
|
|
|
Learn more about [Unifi Controller](https://ui.com/).
|
|
|
|
_(Find the Unifi Controller information widget [here](../info/unifi_controller.md))_
|
|
|
|
You can display general connectivity status from your Unifi (Network) Controller.
|
|
|
|
!!! warning
|
|
|
|
When authenticating you will want to use a local account that has at least read privileges.
|
|
|
|
An optional 'site' parameter can be supplied, if it is not the widget will use the default site for the controller.
|
|
|
|
Allowed fields: `["uptime", "wan", "lan", "lan_users", "lan_devices", "wlan", "wlan_users", "wlan_devices"]` (maximum of four). Fields unsupported by the unifi device will not be shown.
|
|
|
|
!!! hint
|
|
|
|
If you enter e.g. incorrect credentials and receive an "API Error", you may need to recreate the container or restart the service to clear the cache.
|
|
|
|
```yaml
|
|
widget:
|
|
type: unifi
|
|
url: https://unifi.host.or.ip:port
|
|
site: Site Name # optional
|
|
username: user
|
|
password: pass
|
|
key: unifiapikey # required if using API key instead of username/password
|
|
```
|