Important: Please ensure that your firewalls and third-party tools are configured to allow the new Portnox Cloud IP ranges. Click here for more information.

Home
Portnox tools and applications
VMs and Docker containers
In this collection of topics, you will learn about several Portnox™ virtual machines and Docker containers that Extend Portnox Cloud services to on-premises environments and private clouds.
UniFi agent
In this topic, you will learn what the portnox-unifi-agent Docker container does, its requirements, how to deploy it, and how its update behavior works.

Portnox tools and applications
- AgentP
  In this collection of topics, you will learn about Portnox™ AgentP, a lightweight agent for end-user devices.
- Portnox Connect
  In this collection of topics, you will learn about Portnox™ Connect, a zero-footprint configuration utility for BYOD devices.
- LDAP Broker
  In this collection of topics, you will learn about Portnox™ LDAP Broker, a software that allows Portnox Cloud to work together with on-premises repositories.
- VMs and Docker containers
  In this collection of topics, you will learn about several Portnox™ virtual machines and Docker containers that Extend Portnox Cloud services to on-premises environments and private clouds.
  - Local RADIUS
    In this topic, you will learn what is the Portnox™ local RADIUS server software, its requirements, and where to find deployment, troubleshooting, and update instructions.
  - Local TACACS+
    In this topic, you will learn what is the Portnox™ local TACACS+ server software, its requirements, and where to find deployment, troubleshooting, and update instructions.
  - Container updater
    In this topic, you will learn what the portnox-autoupdate Docker container does, its requirements, how to deploy it, and how its update behavior works.
  - SIEM gateway
    In this topic, you will learn what the portnox-siem Docker container does, its requirements, how to deploy it, and how its update behavior works.
  - DHCP relay
    In this topic, you will learn what the portnox-dhcp Docker container does, its requirements, how to deploy it, and how its update behavior works.
  - ZTNA gateway
    In this topic, you will learn what the ztna-gateway Docker container does, its requirements, how to deploy it, and how its update behavior works.
  - UniFi agent
    In this topic, you will learn what the portnox-unifi-agent Docker container does, its requirements, how to deploy it, and how its update behavior works.
- Portnox Cloud API
- Free tools, utilities, and scripts

The UniFi agent Docker container (portnox-unifi-agent)

In this topic, you will learn what the portnox-unifi-agent Docker container does, its requirements, how to deploy it, and how its update behavior works.

Overview

The portnox-unifi-agent Docker container connects a Ubiquiti UniFi controller to the Portnox Cloud guest network captive portal, using UniFi’s external portal server feature. It is available in the public Docker repository as portnox/portnox-unifi-agent. It has no virtual machine equivalent.

Requirements

The container can run on Linux, or on Windows or macOS via Docker Desktop. If running in a VM environment, we recommend Linux for the best results, since Windows and macOS would require double virtualization.
The container needs network access to your UniFi controller on the same local network.
You need a UniFi account with Site Admin privileges. A dedicated service account is recommended over using your own administrator credentials.
Follow the firewall rules in the following topic: How to set up the firewall for Portnox Docker containers to connect to Portnox Cloud.

Deployment

For step-by-step instructions on configuring your UniFi controller and this container together, see the following topic: Guest access – Ubiquiti UniFi.

Troubleshooting

To collect Docker container logs for troubleshooting, see the following topic: How to collect Portnox Docker container logs for support.

Updates

If you use a Docker container running on a local Docker host, it does not update automatically, unless you also use the autoupdate container. The autoupdate container updates all Portnox Docker containers when new versions are available. Updating requires recreating the Docker container, so there may be a short service interruption.
If you deploy the Docker container in a cloud environment, you cannot use the autoupdate container, because it requires direct access to the local Docker engine, which these managed cloud services do not expose. You must update containers deployed this way manually by redeploying them with the latest image.