portnox/portnox-unifi-agent repository overview

⁠Portnox UniFi agent

The portnox-unifi-agent container connects a Ubiquiti UniFi controller to the Portnox Cloud guest network captive portal, using UniFi's external portal server feature. It is required if you want to use Portnox Cloud's guest network portal with a UniFi network, since UniFi does not talk to Portnox Cloud directly.

Before you run the container, set up the guest network in Portnox Cloud and note down the Captive Portal ID, the Captive Portal Proxy URL, and an API access token. In your UniFi controller, create a service account with site admin rights (a dedicated service account is recommended, but you can also use your own administrator login). You then set up the guest WiFi network and point its captive portal at an external portal server, using the values from Portnox Cloud. The exact menus for this vary between UniFi controller versions, so refer to the documentation (link below) for the current steps.

⁠Deploy

Install Docker on a machine on the same local network as your UniFi controller, then run the container with the values gathered above:

docker run -d --name portnox-unifi-agent --restart=on-failure --pull always \
  -e UNIFI_HOST=<unifi_host> \
  -e UNIFI_PORT=<unifi_port> \
  -e UNIFI_LOGIN=<unifi_login> \
  -e UNIFI_PASSWORD=<unifi_password> \
  -e PORTNOX_ECP_ID=<portnox_ecp_id> \
  -e PORTNOX_ACCESS_TOKEN=<portnox_access_token> \
  -e UNIFI_SITE=<unifi_site> \
  -e IGNORE_TLS_ERRORS=true \
  portnox/portnox-unifi-agent:latest

Use UNIFI_SITE if your controller manages more than one site. Use IGNORE_TLS_ERRORS=true only if your UniFi controller uses a self-signed certificate.

⁠Updating

Update the container by redeploying it manually, or automate updates with the portnox-autoupdate container⁠.

⁠Full documentation

For full documentation, see: docs.portnox.com⁠.