Images

linuxserver/unifi-controller

GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry MicroBadger Layers Docker Pulls Docker Stars Jenkins Build LSIO CI

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 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

Usage

Here are some example snippets to help you get started creating a container from this image.

docker

docker create \
--name=unifi-controller \
-e PUID=1000 \
-e PGID=1000 \
-e MEM_LIMIT=1024M `#optional` \
-p 3478:3478/udp \
-p 10001:10001/udp \
-p 8080:8080 \
-p 8443:8443 \
-p 1900:1900/udp `#optional` \
-p 8843:8843 `#optional` \
-p 8880:8880 `#optional` \
-p 6789:6789 `#optional` \
-p 5514:5514 `#optional` \
-v <path to data>:/config \
--restart unless-stopped \
linuxserver/unifi-controller

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

releases from the 5.6.x "LTS Stable" branch.

5.9

releases from the now EOL 5.9.x branch.

5.8

releases from the now EOL 5.8.x branch.

5.7

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.

docker-compose

Compatible with docker-compose v2 schemas.

---
version: "2.1"
services:
unifi-controller:
image: linuxserver/unifi-controller
container_name: unifi-controller
environment:
- PUID=1000
- PGID=1000
- MEM_LIMIT=1024M #optional
volumes:
- <path to data>:/config
ports:
- 3478:3478/udp
- 10001:10001/udp
- 8080:8080
- 8443:8443
ports:
- 1900:1900/udp #optional
- 8843:8843 #optional
- 8880:8880 #optional
- 6789:6789 #optional
- 5514:5514 #optional
restart: unless-stopped

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

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).

Volume Mappings (-v)

Volume

Function

/config

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 FILE__.

As an example:

-e FILE__PASSWORD=/run/secrets/mysecretpassword

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:

$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

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 accessable by other devices. To change this go to Settings > Controller > Controller Settings and set the Controller Hostname/IP to an ip address accessable by other devices.

Alternatively to manually adopt a device take these steps:

ssh ubnt@$AP-IP
set-inform http://$address:8080/inform

Use ubnt as the password to login and $address is the IP address of the host you are running this container on and $AP-IP is the Access Point IP address.

Docker Mods

Docker Mods

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) can be accessed via the dynamic badge 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" }}' linuxserver/unifi-controller

Versions

  • 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