From 7ee9ab831acf000e8f7c1a6e3bd65f284f571d78 Mon Sep 17 00:00:00 2001 From: <> Date: Tue, 3 Dec 2024 17:42:53 +0000 Subject: [PATCH] Deployed 0831a6ae6 with MkDocs version: 1.6.1 --- images/docker-unifi-network-application/index.html | 6 +++--- search/search_index.json | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/images/docker-unifi-network-application/index.html b/images/docker-unifi-network-application/index.html index aa8a04e0eb..4318ead840 100644 --- a/images/docker-unifi-network-application/index.html +++ b/images/docker-unifi-network-application/index.html @@ -33,7 +33,7 @@ restart: unless-stopped

Note that the init script method will only work on first run. If you start the Mongodb container without an init script it will generate test data automatically and you will have to manually create your databases, or restart with a clean /data/db volume and an init script mounted.

You can also run the commands directly against the database using either mongo (< 6.0) or mongosh (>= 6.0).

Device Adoption

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 > Advanced and set the Inform Host to a hostname or IP address accessible by your devices. Additionally the checkbox "Override" has to be checked, so that devices can connect to the controller during adoption (devices use the inform-endpoint during adoption).

Note that you must use 8080:8080. If you MUST change the port, it must be changed on both sides and manually changed in your system.properties file. Otherwise, devices will initially communicate and then break after.

Please note, Unifi change the location of this option every few releases so if it's not where it says, search for "Inform" or "Inform Host" in the settings.

In order to manually adopt a device take these steps:

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

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.

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

Migration From Unifi-Controller

If you were using the mongoless tag for the Unifi Controller container, you can switch directly to the Unifi Network Application container without needing to perform any migration steps.

You cannot perform an in-place upgrade from an existing Unifi-Controller container, you must run a backup and then a restore.

The simplest migration approach is to take a full backup of your existing install, including history, from the Unifi-Controller web UI, then shut down the old container.

You can then start up the new container with a clean /config mount (and a database container configured), and perform a restore using the setup wizard.

Strict reverse proxies

This image uses a self-signed certificate by default. This naturally means the scheme is https. If you are using a reverse proxy which validates certificates, you need to disable this check for the container.

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.

---
+

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.

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

Migration From Unifi-Controller

If you were using the mongoless tag for the Unifi Controller container, you can switch directly to the Unifi Network Application container without needing to perform any migration steps.

You cannot perform an in-place upgrade from an existing Unifi-Controller container, you must run a backup and then a restore.

The simplest migration approach is to take a full backup of your existing install, including history, from the Unifi-Controller web UI, then shut down the old container.

You can then start up the new container with a clean /config mount (and a database container configured), and perform a restore using the setup wizard.

Strict reverse proxies

This image uses a self-signed certificate by default. This naturally means the scheme is https. If you are using a reverse proxy which validates certificates, you need to disable this check for the container.

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.

Info

Unless a parameter is flaged as 'optional', it is mandatory and a value must be provided.

---
 services:
   unifi-network-application:
     image: lscr.io/linuxserver/unifi-network-application:latest
@@ -90,7 +90,7 @@
   -v /path/to/unifi-network-application/data:/config \
   --restart unless-stopped \
   lscr.io/linuxserver/unifi-network-application:latest
-

Parameters

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.

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

Environment Variables (-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.
MONGO_AUTHSOURCE=admin Mongodb authSource. For Atlas set to admin. 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.

Volume Mappings (-v)

Volume Function
/config Persistent config files

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:

-e FILE__MYVAR=/run/secrets/mysecretvariable
+

Parameters

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.

Ports (-p)

Parameter Function
8443:8443 Unifi web admin port
3478:3478/udp Unifi STUN port
10001:10001/udp Required for AP discovery
8080:8080 Required for device communication
1900:1900/udp Required for Make controller discoverable on L2 network option
8843:8843 Unifi guest portal HTTPS redirect port
8880:8880 Unifi guest portal HTTP redirect port
6789:6789 For mobile throughput test
5514: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
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.
MONGO_AUTHSOURCE=admin Mongodb authSource. For Atlas set to admin. 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.

Volume Mappings (-v)

Volume Function
/config Persistent config files

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:

-e FILE__MYVAR=/run/secrets/mysecretvariable
 

Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable 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 your_user as below:

id your_user
 

Example output:

uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
 

Docker Mods

Docker Mods Docker Universal 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