You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jan 7, 2024. It is now read-only.
The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring :-
9
4
10
-
The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at:
11
-
*[forum.linuxserver.io][forumurl]
12
-
*[IRC][ircurl] on freenode at `#linuxserver.io`
13
-
*[Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation!
5
+
* regular and timely application updates
6
+
* easy user mappings (PGID, PUID)
7
+
* custom base image with s6 overlay
8
+
* weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
9
+
* regular security updates
14
10
15
-
# linuxserver/unifi
16
-
[](https://microbadger.com/images/linuxserver/unifi"Get your own version badge on microbadger.com")[](https://microbadger.com/images/linuxserver/unifi"Get your own image badge on microbadger.com")[][hub][][hub][](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-unifi/)
11
+
Find us at:
12
+
*[Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team.
13
+
*[IRC](https://irc.linuxserver.io) - on freenode at `#linuxserver.io`. Our primary support channel is Discord.
14
+
*[Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more!
15
+
*[Podcast](https://anchor.fm/linuxserverio) - on hiatus. Coming back soon (late 2018).
17
16
18
-
The [UniFi®](https://www.ubnt.com/enterprise/#unifi) Controller software is a powerful, enterprise wireless software engine ideal for high-density client deployments requiring low latency and high uptime performance.
17
+
# PSA: Changes are happening
18
+
19
+
From August 2018 onwards, Linuxserver are in the midst of switching to a new CI platform which will enable us to build and release multiple architectures under a single repo. To this end, existing images for `arm64` and `armhf` builds are being deprecated. They are replaced by a manifest file in each container which automatically pulls the correct image for your architecture. You'll also be able to pull based on a specific architecture tag.
20
+
21
+
TLDR: Multi-arch support is changing from multiple repos to one repo per container image.
[](https://microbadger.com/images/linuxserver/unifi-controller"Get your own version badge on microbadger.com")
26
+
[](https://microbadger.com/images/linuxserver/unifi-controller"Get your own version badge on microbadger.com")
The [Unifi-controller](https://www.ubnt.com/enterprise/#unifi) Controller software is a powerful, enterprise wireless software engine ideal for high-density client deployments requiring low latency and high uptime performance.
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](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list).
40
+
41
+
Simply pulling `linuxserver/unifi-controller` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
Here are some example snippets to help you get started creating a container.
55
+
56
+
### docker
57
+
24
58
```
25
59
docker create \
26
-
--name=unifi \
27
-
-v <path to data>:/config \
28
-
-e PGID=<gid> -e PUID=<uid> \
60
+
--name=unifi-controller \
61
+
-e PUID=1001 \
62
+
-e PGID=1001 \
29
63
-p 3478:3478/udp \
30
64
-p 10001:10001/udp \
31
65
-p 8080:8080 \
@@ -34,57 +68,90 @@ docker create \
34
68
-p 8843:8843 \
35
69
-p 8880:8880 \
36
70
-p 6789:6789 \
37
-
linuxserver/unifi
71
+
-v <path to data>:/config \
72
+
--restart unless-stopped \
73
+
linuxserver/unifi-controller
38
74
```
39
75
40
-
Using tags, you can choose between either the latest "LTS Stable" branch (the default, no tag required) or the "Unstable" branch of UniFi. See the UniFi [FAQ Page](https://help.ubnt.com/hc/en-us/articles/360008240754#1) for a breakdown of their various branches.
76
+
### Version Tags
41
77
42
-
Add one of the tags, if required, to the linuxserver/unifi line of the run/create command in the following format, linuxserver/unifi:unstable
78
+
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.
43
79
44
-
#### Tags
80
+
| Tag | Description |
81
+
| :----: | --- |
82
+
| latest | releases from the latest stable branch. |
83
+
| LTS | releases from the 5.6.x "LTS Stable" branch. |
84
+
| 5.9 | releases from the 5.9.x branch. |
85
+
| 5.8 | releases from the 5.8.x branch. |
86
+
| 5.7 | releases from the 5.7.x branch. |
45
87
46
-
+**latest** : releases from the latest stable branch.
47
-
+**LTS** : releases from the 5.6.x "LTS Stable" branch.
48
-
+**5.9** : releases from the 5.9.x branch.
49
-
+**5.8** : releases from the 5.8.x branch.
50
-
+**5.7** : releases from the 5.7.x branch.
88
+
## Common problems
89
+
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.
51
90
52
91
92
+
### docker-compose
53
93
54
-
## Parameters
94
+
Compatible with docker-compose v2 schemas.
95
+
96
+
```
97
+
---
98
+
version: "2"
99
+
services:
100
+
unifi-controller:
101
+
image: linuxserver/unifi-controller
102
+
container_name: unifi-controller
103
+
environment:
104
+
- PUID=1001
105
+
- PGID=1001
106
+
volumes:
107
+
- <path to data>:/config
108
+
ports:
109
+
- 3478:3478/udp
110
+
- 10001:10001/udp
111
+
- 8080:8080
112
+
- 8081:8081
113
+
- 8443:8443
114
+
- 8843:8843
115
+
- 8880:8880
116
+
- 6789:6789
117
+
mem_limit: 4096m
118
+
restart: unless-stopped
119
+
```
55
120
56
-
`The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side.
57
-
For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container.
58
-
So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080
59
-
http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.`
121
+
## Parameters
60
122
123
+
Container 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.
61
124
62
-
*`-p 3478` - port(s)
63
-
*`-p 10001` - port(s) required for AP discovery
64
-
*`-p 8080` - port(s) required for Unifi to function
65
-
*`-p 8081` - port(s)
66
-
*`-p 8443` - port(s)
67
-
*`-p 8843` - port(s)
68
-
*`-p 8880` - port(s)
69
-
*`-p 6789` - port(s) For throughput test
70
-
*`-v /config` - where unifi stores it config files etc, needs 3gb free
71
-
*`-e PGID` for GroupID - see below for explanation
72
-
*`-e PUID` for UserID - see below for explanation
125
+
| Parameter | Function |
126
+
| :----: | --- |
127
+
|`-p 3478/udp`| Unifi communication port |
128
+
|`-p 10001/udp`| required for AP discovery |
129
+
|`-p 8080`| required for Unifi to function |
130
+
|`-p 8081`| Unifi communication port |
131
+
|`-p 8443`| Unifi communication port |
132
+
|`-p 8843`| Unifi communication port |
133
+
|`-p 8880`| Unifi communication port |
134
+
|`-p 6789`| For throughput test |
135
+
|`-e PUID=1001`| for UserID - see below for explanation |
136
+
|`-e PGID=1001`| for GroupID - see below for explanation |
137
+
|`-v /config`| All Unifi data stored here |
73
138
74
-
It is based on xenial with s6 overlay, for shell access whilst the container is running do `docker exec -it unifi /bin/bash`.
139
+
## User / Group Identifiers
75
140
76
-
### User / Group Identifiers
141
+
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`.
77
142
78
-
Sometimes when using data 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 the data volume directory on the host is owned by the same user you specify and it will "just work" <sup>TM</sup>.
143
+
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
79
144
80
-
In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below:
145
+
In this instance `PUID=1001` and `PGID=1001`, to find yours use `id user` as below:
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.
102
169
103
-
## Common problems
104
-
105
-
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.
106
-
107
-
## Info
108
170
109
-
* Shell access whilst the container is running: `docker exec -it unifi /bin/bash`
110
-
* To monitor the logs of the container in realtime: `docker logs -f unifi`
111
171
172
+
## Support Info
112
173
113
-
* container version number
114
-
115
-
`docker inspect -f '{{ index .Config.Labels "build_version" }}' unifi`
116
-
174
+
*Shell access whilst the container is running: `docker exec -it unifi-controller /bin/bash`
175
+
* To monitor the logs of the container in realtime: `docker logs -f unifi-controller`
176
+
* container version number
177
+
*`docker inspect -f '{{ index .Config.Labels "build_version" }}' unifi-controller`
117
178
* image version number
118
-
119
-
`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/unifi`
179
+
*`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/unifi-controller`
180
+
181
+
## Updating Info
182
+
183
+
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](#application-setup) section above to see if it is recommended for the image.
184
+
185
+
Below are the instructions for updating containers:
186
+
187
+
### Via Docker Run/Create
188
+
* Update the image: `docker pull linuxserver/unifi-controller`
189
+
* Stop the running container: `docker stop unifi-controller`
190
+
* Delete the container: `docker rm unifi-controller`
191
+
* Recreate a new container with the same docker create parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
192
+
* Start the new container: `docker start unifi-controller`
193
+
* You can also remove the old dangling images: `docker image prune`
194
+
195
+
### Via Docker Compose
196
+
* Update the image: `docker-compose pull linuxserver/unifi-controller`
197
+
* Let compose update containers as necessary: `docker-compose up -d`
198
+
* You can also remove the old dangling images: `docker image prune`
120
199
121
200
## Versions
122
201
123
-
+**27.01.19:** Adding pipeline logic and multi arch.
124
-
+**14.09.18:** Update to 5.6.40.
125
-
+**06.07.18:** Update to 5.6.39.
126
-
+**26.04.18:** Update to 5.6.37.
127
-
+**24.03.18:** Update to 5.6.36.
128
-
+**14.03.18:** Add unstable branch for 5.7x releases.
129
-
+**19.02.18:** Add port 6789 to support throughput test
130
-
+**09.02.18:** Update to 5.6.30.
131
-
+**08.02.18:** Use loop to simplify symlinks.
132
-
+**08.01.18:** Update to 5.6.29.
133
-
+**15.12.17:** Update to 5.6.26.
134
-
+**09.12.17:** Fix continuation lines.
135
-
+**12.11.17:** Add STUN server port 3478 mapping to example.
136
-
+**11.11.17:** Update to 5.6.22.
137
-
+**22.10.17:** Fix typos in Dockerfile and cert gen.
138
-
+**05.10.17:** Update to 5.5.24.
139
-
+**03.08.17:** Update to 5.5.20.
140
-
+**15.07.17:** Update to 5.5.19 and switch to using .deb package, no need to keep up with the unifi repo merry-go-round.
141
-
+**05.07.17:** Change repo to stable. Remove execstack command, no longer required.
142
-
+**18.03.17:** Fix execstack warning.
143
-
+**14.10.16:** Add version layer information.
144
-
+**20.09.16** Bump to pick up ver 5.27.
145
-
+**10.09.16** Add layer badges to README.
146
-
+**28.08.16** Add badges to README.
147
-
+**01.07.16** Switch to lsiobase/xenial for conformity.
148
-
+**25.06.16** Rebase to xenial and use updated repository.
149
-
+**02.11.15** Initial Release.
202
+
***10.02.19:** - Initial release of new unifi-controller image with new tags and pipeline logic
0 commit comments