The Unifi-network-application software is a powerful, enterprise wireless software engine ideal for high-density client deployments requiring low latency and high uptime performance.
lscr.io/linuxserver/unifi-network-application:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
The architectures supported by this image are:
After setup, the web UI is available at https://ip:8443. The application can be configured, or a backup restored, using the first run wizard.
This container requires an external mongodb database instance.
Setting Up Your External Database¶
Formally only mongodb 3.6 through 4.4 are supported, however, it has been reported that newer versions will work. If you choose to use a newer version be aware that you will not be operating a supported configuration.
Make sure you pin your database image version and do not use
latest, as mongodb does not support automatic upgrades between major versions.
If you are using the official mongodb container, you can create your user using an
init-mongo.js file with the following contents:
Being sure to replace the placeholders with the same values you supplied to the Unifi container, and mount it into your mongodb container.
Note that the init script method will only work on first run. If you start the mongodb container without an init script it will generate test data automatically and you will have to manually create your databases, or restart with a clean
/data/db volume and an init script mounted.
If you are using the init script method do not also set
MONGO_INITDB_ROOT_PASSWORD, or any other "INITDB" values as they will cause conflicts.
You can also run the commands directly against the database using either
mongo (< 6.0) or
mongosh (>= 6.0).
For Unifi to adopt other devices, e.g. an Access Point, it is required to change the inform IP address. Because Unifi runs inside Docker by default it uses an IP address not accessible by other devices. To change this go to Settings > System > Advanced and set the Inform Host to a hostname or IP address accessible by your devices. Additionally the checkbox "Override" has to be checked, so that devices can connect to the controller during adoption (devices use the inform-endpoint during adoption).
Please note, Unifi change the location of this option every few releases so if it's not where it says, search for "Inform" or "Inform Host" in the settings.
In order to manually adopt a device take these steps:
The default device password is
$address is the IP address of the host you are running this container on and
$AP-IP is the Access Point IP address.
When using a Security Gateway (router) it could be that network connected devices are unable to obtain an ip address. This can be fixed by setting "DHCP Gateway IP", under Settings > Networks > network_name, to a correct (and accessible) ip address.
Migration From Unifi-Controller¶
If you were using the
mongoless tag for the Unifi Controller container, you can switch directly to the Unifi Network Application container without needing to perform any migration steps.
You cannot perform an in-place upgrade from an existing Unifi-Controller container, you must run a backup and then a restore.
The simplest migration approach is to take a full backup of your existing install, including history, from the Unifi-Controller web UI, then shut down the old container.
You can then start up the new container with a clean
/config mount (and a database container configured), and perform a restore using the setup wizard.
Strict reverse proxies¶
This image uses a self-signed certificate by default. This naturally means the scheme is
https. If you are using a reverse proxy which validates certificates, you need to disable this check for the container.
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
docker-compose (recommended, click here for more info)¶
--- version: "2.1" services: unifi-network-application: image: lscr.io/linuxserver/unifi-network-application:latest container_name: unifi-network-application environment: - PUID=1000 - PGID=1000 - TZ=Etc/UTC - MONGO_USER=unifi - MONGO_PASS= - MONGO_HOST=unifi-db - MONGO_PORT=27017 - MONGO_DBNAME=unifi - MEM_LIMIT=1024 #optional - MEM_STARTUP=1024 #optional - MONGO_TLS= #optional - MONGO_AUTHSOURCE= #optional volumes: - /path/to/data:/config ports: - 8443:8443 - 3478:3478/udp - 10001:10001/udp - 8080:8080 - 1900:1900/udp #optional - 8843:8843 #optional - 8880:8880 #optional - 6789:6789 #optional - 5514:5514/udp #optional restart: unless-stopped
docker cli (click here for more info)¶
docker run -d \ --name=unifi-network-application \ -e PUID=1000 \ -e PGID=1000 \ -e TZ=Etc/UTC \ -e MONGO_USER=unifi \ -e MONGO_PASS= \ -e MONGO_HOST=unifi-db \ -e MONGO_PORT=27017 \ -e MONGO_DBNAME=unifi \ -e MEM_LIMIT=1024 `#optional` \ -e MEM_STARTUP=1024 `#optional` \ -e MONGO_TLS= `#optional` \ -e MONGO_AUTHSOURCE= `#optional` \ -p 8443:8443 \ -p 3478:3478/udp \ -p 10001:10001/udp \ -p 8080:8080 \ -p 1900:1900/udp `#optional` \ -p 8843:8843 `#optional` \ -p 8880:8880 `#optional` \ -p 6789:6789 `#optional` \ -p 5514:5514/udp `#optional` \ -v /path/to/data:/config \ --restart unless-stopped \ lscr.io/linuxserver/unifi-network-application:latest
Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate
<external>:<internal> respectively. For example,
-p 8080:80 would expose port
80 from inside the container to be accessible from the host's IP on port
8080 outside the container.
| ||Unifi web admin port|
| ||Unifi STUN port|
| ||Required for AP discovery|
| ||Required for device communication|
| ||Required for |
| ||Unifi guest portal HTTPS redirect port|
| ||Unifi guest portal HTTP redirect port|
| ||For mobile throughput test|
| ||Remote syslog port|
Environment Variables (
| ||for UserID - see below for explanation|
| ||for GroupID - see below for explanation|
| ||specify a timezone to use, see this list.|
| ||Mongodb Username. Only evaluated on first run. Special characters must be url encoded.|
| ||Mongodb Password. Only evaluated on first run. Special characters must be url encoded.|
| ||Mongodb Hostname. Only evaluated on first run.|
| ||Mongodb Port. Only evaluated on first run.|
| ||Mongodb Database Name (stats DB is automatically suffixed with |
| ||Optionally change the Java memory limit (in Megabytes). Set to |
| ||Optionally change the Java initial/minimum memory (in Megabytes). Set to |
| ||Mongodb enable TLS. Only evaluated on first run.|
| ||Mongodb authSource. For Atlas set to |
Volume Mappings (
| ||All Unifi data stored here|
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend
As an example:
Will set the environment variable
MYVAR based on the contents of the
Umask for running applications¶
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional
-e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.
User / Group Identifiers¶
When using volumes (
-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user
PUID and group
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
In this instance
PGID=1000, to find yours use
id your_user as below:
We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
Shell access whilst the container is running:
To monitor the logs of the container in realtime:
Container version number:
Image version number:
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.
Below are the instructions for updating containers:
Via Docker Compose¶
You can also remove the old dangling images:
Via Docker Run¶
Update the image:
Stop the running container:
Delete the container:
Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your
/configfolder and settings will be preserved)
You can also remove the old dangling images:
Via Watchtower auto-updater (only use if you don't remember the original parameters)¶
Pull the latest image at its tag and replace it with the same env variables in one run:
You can also remove the old dangling images:
docker image prune
We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, we highly recommend using Docker Compose.
Image Update Notifications - Diun (Docker Image Update Notifier)¶
We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
If you want to make local modifications to these images for development purposes or just to customize the logic:
The ARM variants can be built on x86_64 hardware using
Once registered you can define the dockerfile to use with
- 17.10.23: - Add environment variables for TLS and authSource to support Atlas and new MongoDB versions.
- 05.09.23: - Initial release.
Created: December 8, 2023