</code></pre><p>The default device password is <code>ubnt</code>. <code>$address</code> is the IP address of the host you are running this container on and <code>$AP-IP</code> is the Access Point IP address.</p><p>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.</p><h3id=strict-reverse-proxies>Strict reverse proxies</h3><p>This image uses a self-signed certificate by default. This naturally means the scheme is <code>https</code>. If you are using a reverse proxy which validates certificates, you need to <ahref=https://docs.linuxserver.io/faq#strict-proxy>disable this check for the container</a>.</p><h2id=usage>Usage</h2><p>To help you get started creating a container from this image you can either use docker-compose or the docker cli.</p><h3id=docker-compose-recommended-click-here-for-more-info>docker-compose (recommended, <ahref=https://docs.linuxserver.io/general/docker-compose>click here for more info</a>)</h3><pre><codeclass=language-yaml>---
</code></pre><h3id=docker-cli-click-here-for-more-info>docker cli (<ahref=https://docs.docker.com/engine/reference/commandline/cli/>click here for more info</a>)</h3><pre><codeclass=language-bash>docker run -d \
--name=unifi-controller \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Europe/London \
-e MEM_LIMIT=1024 `#optional` \
-e MEM_STARTUP=1024 `#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-controller:latest
</code></pre><h2id=parameters>Parameters</h2><p>Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <code><external>:<internal></code> respectively. For example, <code>-p 8080:80</code> would expose port <code>80</code> from inside the container to be accessible from the host's IP on port <code>8080</code> outside the container.</p><h3id=ports-p>Ports (<code>-p</code>)</h3><table><thead><tr><thalign=center>Parameter</th><th>Function</th></tr></thead><tbody><tr><tdalign=center><code>8443</code></td><td>Unifi web admin port</td></tr><tr><tdalign=center><code>3478/udp</code></td><td>Unifi STUN port</td></tr><tr><tdalign=center><code>10001/udp</code></td><td>Required for AP discovery</td></tr><tr><tdalign=center><code>8080</code></td><td>Required for device communication</td></tr><tr><tdalign=center><code>1900/udp</code></td><td>Required for <code>Make controller discoverable on L2 network</code> option</td></tr><tr><tdalign=center><code>8843</code></td><td>Unifi guest portal HTTPS redirect port</td></tr><tr><tdalign=center><code>8880</code></td><td>Unifi guest portal HTTP redirect port</td></tr><tr><tdalign=center><code>6789</code></td><td>For mobile throughput test</td></tr><tr><tdalign=center><code>5514/udp</code></td><td>Remote syslog port</td></tr></tbody></table><h3id=environment-variables-e>Environment Variables (<code>-e</code>)</h3><table><thead><tr><thalign=center>Env</th><th>Function</th></tr></thead><tbody><tr><tdalign=center><code>PUID=1000</code></td><td>for UserID - see below for explanation</td></tr><tr><tdalign=center><code>PGID=1000</code></td><td>for GroupID - see below for explanation</td></tr><tr><tdalign=center><code>TZ=Europe/London</code></td><td>Specify a timezone to use (e.g. Europe/London) - <ahref=https://en.wikipedia.org/wiki/List_of_tz_database_time_zones>see list</a></td></tr><tr><tdalign=center><code>MEM_LIMIT=1024</code></td><td>Optionally change the Java memory limit (in Megabytes). Set to <code>default</code> to reset to default</td></tr><tr><tdalign=center><code>MEM_STARTUP=1024</code></td><td>Optionally change the Java initial/minimum memory (in Megabytes). Set to <code>default</code> to reset to default</td></tr></tbody></table><h3id=volume-mappings-v>Volume Mappings (<code>-v</code>)</h3><table><thead><tr><thalign=center>Volume</th><th>Function</th></tr></thead><tbody><tr><tdalign=center><code>/config</code></td><td>All Unifi data stored here</td></tr></tbody></table><h4id=miscellaneous-options>Miscellaneous Options</h4><table><thead><tr><thalign=center>Parameter</th><th>Function</th></tr></thead><tbody><tr><td></td><td></td></tr></tbody></table><h2id=environment-variables-from-files-docker-secrets>Environment variables from files (Docker secrets)</h2><p>You can set any environment variable from a file by using a special prepend <code>FILE__</code>.</p><p>As an example:</p><pre><codeclass=language-bash>-e FILE__PASSWORD=/run/secrets/mysecretpassword
</code></pre><p>Will set the environment variable <code>PASSWORD</code> based on the contents of the <code>/run/secrets/mysecretpassword</code> file.</p><h2id=umask-for-running-applications>Umask for running applications</h2><p>For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional <code>-e UMASK=022</code> setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up <ahref=https://en.wikipedia.org/wiki/Umask>here</a> before asking for support.</p><h2id=user-group-identifiers>User / Group Identifiers</h2><p>When using volumes (<code>-v</code> flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user <code>PUID</code> and group <code>PGID</code>.</p><p>Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.</p><p>In this instance <code>PUID=1000</code> and <code>PGID=1000</code>, to find yours use <code>id user</code> as below:</p><pre><codeclass=language-bash> $ id username
</code></pre><h2id=docker-mods>Docker Mods</h2><p><ahref="https://mods.linuxserver.io/?mod=unifi-controller"title="view available mods for this container."><imgalt="Docker Mods"src="https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=unifi-controller&query=%24.mods%5B%27unifi-controller%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml"></a><ahref="https://mods.linuxserver.io/?mod=universal"title="view available universal mods."><imgalt="Docker Universal Mods"src="https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml"></a></p><p>We publish various <ahref=https://github.com/linuxserver/docker-mods>Docker Mods</a> 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.</p><h2id=support-info>Support Info</h2><ul><li>Shell access whilst the container is running:</li><li><code>docker exec -it unifi-controller /bin/bash</code></li><li>To monitor the logs of the container in realtime:</li><li><code>docker logs -f unifi-controller</code></li><li>Container version number</li><li><code>docker inspect -f '{{ index .Config.Labels "build_version" }}' unifi-controller</code></li><li>Image version number</li><li><code>docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/unifi-controller:latest</code></li></ul><h2id=versions>Versions</h2><ul><li><strong>30.11.22:</strong> - Bump JRE to 11.</li><li><strong>01.06.22:</strong> - Deprecate armhf.</li><li><strong>23.12.21:</strong> - Move min/max memory config from run to system.properties.</li><li><strong>22.12.21:</strong> - Move deb package install to first init to avoid overlayfs performance issues.</li><li><strong>13.12.21:</strong> - Rebase 64 bit containers to Focal.</li><li><strong>11.12.21:</strong> - Add java opts to mitigate CVE-2021-44228.</li><li><strong>11.06.21:</strong> - Allow for changing Java initial mem via new optional environment variable.</li><li><strong>12.01.21:</strong> - Deprecate the <code>LTS</code> tag as Unifi no longer releases LTS stable builds. Existing users can switch to the <code>latest</code> tag. Direct upgrade from 5.6.42 (LTS) to 6.0.42 (latest) tested successfully.</li><li><strong>17.07.20:</strong> - Rebase 64 bit containers to Bionic and Mongo 3.6.</li><li><strong>16.06.20:</strong> - Add logrotate.</li><li><strong>02.06.20:</strong> - Updated port list & descriptions. Moved some ports to optional.</li><li><strong>14.11.19:</strong> - Changed url for deb package to match new Ubiquity domain.</li><li><strong>29.07.19:</strong> - Allow for changing Java mem limit via new optional environment variable.</li><li><strong>23.03.19:</strong> - Switching to new Base images, shift to arm32v7 tag.</li><li><strong>10.02.19:</strong> - Initial release of new unifi-controller image with new tags and pipeline logic</li></ul></article></div></div></main><footerclass=md-footer><navclass="md-footer__inner md-grid"aria-label=Footer><ahref=../docker-ubooquity/class="md-footer__link md-footer__link--prev"aria-label="Previous: ubooquity"rel=prev><divclass="md-footer__button md-icon"><svgxmlns=http://www.w3.org/2000/svgviewbox="0 0 24 24"><pathd="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg></div><divclass=md-footer__title><divclass=md-ellipsis><spanclass=md-footer__direction> Previous </span> ubooquity </div></div></a><ahref=../docker-webgrabplus/class="md-footer__link md-footer__link--next"aria-label="Next: webgrabplus"rel=next><divclass=md-footer__title><divclass=md-ellipsis><spanclass=md-footer__direction> Next </span> we
