mirror of
https://github.com/jokob-sk/NetAlertX.git
synced 2025-12-07 09:36:05 -08:00
27 lines
1.2 KiB
Markdown
Executable File
27 lines
1.2 KiB
Markdown
Executable File
## Overview
|
|
|
|
A plugin allowing for importing devices from a UniFi controller. The plugin also tries to import the network map.
|
|
|
|
### Usage
|
|
|
|
Specify the following settings in the Settings section of NetAlertX:
|
|
|
|
- `UNFIMP_username` - Username used to log in the UNIFI controller.
|
|
- `UNFIMP_password` - Password used to log in the UNIFI controller.
|
|
- `UNFIMP_host` - Host URL or IP address where the UNIFI controller is hosted (excluding `http://`)
|
|
- `UNFIMP_sites` - Name of the sites (usually 'default', check the URL in your UniFi controller UI if unsure. The site id is in the following part of the URL: `https://192.168.1.1:8443/manage/site/this-is-the-site-id/settings/`).
|
|
- `UNFIMP_protocol` - https:// or http://
|
|
- `UNFIMP_port` - Usually `8443` or `8843`
|
|
- `UNFIMP_version` - see below table for details
|
|
|
|
|
|
#### Version table
|
|
|
|
| Controller | `UNFIMP_version` |
|
|
| ------------------------------------------------------ | ------------------------- |
|
|
| Cloud Gateway Ultra / UCK cloudkey V2 plus (v4.0.18) | `UDMP-unifiOS` |
|
|
| Docker hosted | `v5` |
|
|
|
|
### Notes
|
|
|
|
- It is recommended to create a read-only user in your UniFi controller |