diff --git a/images/docker-unifi-network-application/index.html b/images/docker-unifi-network-application/index.html index 376acfb466..061dca057e 100644 --- a/images/docker-unifi-network-application/index.html +++ b/images/docker-unifi-network-application/index.html @@ -25,19 +25,21 @@ - MONGO_DBNAME=unifi - MEM_LIMIT=1024 #optional - MEM_STARTUP=1024 #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 + - 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 run -d \
--name=unifi-network-application \
-e PUID=1000 \
@@ -50,19 +52,21 @@
-e MONGO_DBNAME=unifi \
-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-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.
-p
)¶Parameter | Function |
---|---|
8443 | Unifi web admin port |
3478/udp | Unifi STUN port |
10001/udp | Required for AP discovery |
8080 | Required for device communication |
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 |
-e
)¶Env | Function |
---|---|
PUID=1000 | for UserID - see below for explanation |
PGID=1000 | for GroupID - see below for explanation |
TZ=Etc/UTC | specify a timezone to use, see this list. |
MONGO_USER=unifi | Mongodb Username. Only evaluated on first run. Special characters must be url encoded. |
MONGO_PASS= | Mongodb Password. Only evaluated on first run. Special characters must be url encoded. |
MONGO_HOST=unifi-db | Mongodb Hostname. Only evaluated on first run. |
MONGO_PORT=27017 | Mongodb Port. Only evaluated on first run. |
MONGO_DBNAME=unifi | Mongodb Database Name (stats DB is automatically suffixed with _stat ). Only evaluated on first run. |
MEM_LIMIT=1024 | Optionally change the Java memory limit (in Megabytes). Set to default to reset to default |
MEM_STARTUP=1024 | Optionally change the Java initial/minimum memory (in Megabytes). Set to default to reset to default |
-v
)¶Volume | Function |
---|---|
/config | All Unifi data stored here |
Parameter | Function |
---|---|
You can set any environment variable from a file by using a special prepend FILE__
.
As an example:
-e FILE__MYVAR=/run/secrets/mysecretvariable
+ -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.
-p
)¶Parameter | Function |
---|---|
8443 | Unifi web admin port |
3478/udp | Unifi STUN port |
10001/udp | Required for AP discovery |
8080 | Required for device communication |
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 |
-e
)¶Env | Function |
---|---|
PUID=1000 | for UserID - see below for explanation |
PGID=1000 | for GroupID - see below for explanation |
TZ=Etc/UTC | specify a timezone to use, see this list. |
MONGO_USER=unifi | Mongodb Username. Only evaluated on first run. Special characters must be url encoded. |
MONGO_PASS= | Mongodb Password. Only evaluated on first run. Special characters must be url encoded. |
MONGO_HOST=unifi-db | Mongodb Hostname. Only evaluated on first run. |
MONGO_PORT=27017 | Mongodb Port. Only evaluated on first run. |
MONGO_DBNAME=unifi | Mongodb Database Name (stats DB is automatically suffixed with _stat ). Only evaluated on first run. |
MEM_LIMIT=1024 | Optionally change the Java memory limit (in Megabytes). Set to default to reset to default |
MEM_STARTUP=1024 | Optionally change the Java initial/minimum memory (in Megabytes). Set to default to reset to default |
MONGO_TLS= | Mongodb enable TLS. Only evaluated on first run. |
MONGO_AUTHSOURCE= | Mongodb authSource. For Atlas set to admin .Defaults to MONGO_DBNAME .Only evaluated on first run. |
-v
)¶Volume | Function |
---|---|
/config | All Unifi data stored here |
Parameter | Function |
---|---|
You can set any environment variable from a file by using a special prepend FILE__
.
As an example:
Will set the environment variable MYVAR
based on the contents of the /run/secrets/mysecretvariable
file.
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.
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 your_user
as below:
Example output:
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:
docker exec -it unifi-network-application /bin/bash
@@ -89,4 +93,4 @@
--pull \
-t lscr.io/linuxserver/unifi-network-application:latest .
The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static
Once registered you can define the dockerfile to use with -f Dockerfile.aarch64
.