Search…
Images
Powered By GitBook
linuxserver/unifi-controller
The Unifi-controller Controller software is a powerful, enterprise wireless software engine ideal for high-density client deployments requiring low latency and high uptime performance.

Supported Architectures

Our images support multiple architectures such as x86-64, arm64 and armhf. We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
Simply pulling lscr.io/linuxserver/unifi-controller 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:
Architecture
Tag
x86-64
amd64-latest
arm64
arm64v8-latest
armhf
arm32v7-latest

Application Setup

The webui is at https://ip:8443, setup with the first run wizard.
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 Settings > Controller Configuration and set the Controller Hostname/IP to a hostname or IP address accessible by your devices. Additionally the checkbox "Override inform host with controller hostname/IP" has to be checked, so that devices can connect to the controller during adoption (devices use the inform-endpoint during adoption).
In order to manually adopt a device take these steps:
2
set-inform http://$address:8080/inform
Copied!
The default device password is ubnt. $address is the IP address of the host you are running this container on and $AP-IP is the Access Point IP address.

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.
1
---
2
version: "2.1"
3
services:
4
unifi-controller:
5
image: lscr.io/linuxserver/unifi-controller
6
container_name: unifi-controller
7
environment:
8
- PUID=1000
9
- PGID=1000
10
- MEM_LIMIT=1024M #optional
11
- MEM_STARTUP=1024M #optional
12
volumes:
13
- <path to data>:/config
14
ports:
15
- 3478:3478/udp
16
- 10001:10001/udp
17
- 8080:8080
18
- 8443:8443
19
- 1900:1900/udp #optional
20
- 8843:8843 #optional
21
- 8880:8880 #optional
22
- 6789:6789 #optional
23
- 5514:5514/udp #optional
24
restart: unless-stopped
Copied!
1
docker run -d \
2
--name=unifi-controller \
3
-e PUID=1000 \
4
-e PGID=1000 \
5
-e MEM_LIMIT=1024M `#optional` \
6
-e MEM_STARTUP=1024M `#optional` \
7
-p 3478:3478/udp \
8
-p 10001:10001/udp \
9
-p 8080:8080 \
10
-p 8443:8443 \
11
-p 1900:1900/udp `#optional` \
12
-p 8843:8843 `#optional` \
13
-p 8880:8880 `#optional` \
14
-p 6789:6789 `#optional` \
15
-p 5514:5514/udp `#optional` \
16
-v <path to data>:/config \
17
--restart unless-stopped \
18
lscr.io/linuxserver/unifi-controller
Copied!

Version Tags

This image provides various versions that are available via tags. latest tag provides the latest stable build from Unifi, but if this is a permanent setup you might consider using the LTS tag.
Tag
Description
latest
releases from the latest stable branch.
LTS
DEPRECATED - releases from the now EOL 5.6.x "LTS Stable" branch.
5.9
DEPRECATED - releases from the now EOL 5.9.x branch.
5.8
DEPRECATED - releases from the now EOL 5.8.x branch.
5.7
DEPRECATED - releases from the now EOL 5.7.x branch.

Common problems

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 accessable) ip address.

Parameters

Docker images 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.

Ports (-p)

Parameter
Function
3478/udp
Unifi STUN port
10001/udp
Required for AP discovery
8080
Required for device communication
8443
Unifi web admin port
1900/udp
Required for Make controller discoverable on L2 network option
8843
Unifi guest portal HTTPS redirect port
8880
Unifi guest portal HTTP redirect port
6789
For mobile throughput test
5514/udp
Remote syslog port

Environment Variables (-e)

Env
Function
PUID=1000
for UserID - see below for explanation
PGID=1000
for GroupID - see below for explanation
MEM_LIMIT=1024M
Optionally change the Java memory limit (-Xmx) (default is 1024M).
MEM_STARTUP=1024M
Optionally change the Java initial memory (-Xms) (default is 1024M).

Volume Mappings (-v)

Volume
Function
/config
All Unifi data stored here

Miscellaneous Options

Parameter
Function

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.
As an example:
1
-e FILE__PASSWORD=/run/secrets/mysecretpassword
Copied!
Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.

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 PGID.
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 PUID=1000 and PGID=1000, to find yours use id user as below:
1
$ id username
2
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
Copied!

Docker Mods

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.

Support Info

    Shell access whilst the container is running:
      docker exec -it unifi-controller /bin/bash
    To monitor the logs of the container in realtime:
      docker logs -f unifi-controller
    Container version number
      docker inspect -f '{{ index .Config.Labels "build_version" }}' unifi-controller
    Image version number
      docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/unifi-controller

Versions

    11.06.21: - Allow for changing Java initial mem via new optional environment variable.
    12.01.21: - Deprecate the LTS tag as Unifi no longer releases LTS stable builds. Existing users can switch to the latest tag. Direct upgrade from 5.6.42 (LTS) to 6.0.42 (latest) tested successfully.
    17.07.20: - Rebase 64 bit containers to Bionic and Mongo 3.6.
    16.06.20: - Add logrotate.
    02.06.20: - Updated port list & descriptions. Moved some ports to optional.
    14.11.19: - Changed url for deb package to match new Ubiquity domain.
    29.07.19: - Allow for changing Java mem limit via new optional environment variable.
    23.03.19: - Switching to new Base images, shift to arm32v7 tag.
    10.02.19: - Initial release of new unifi-controller image with new tags and pipeline logic
Last modified 22d ago