Merge pull request #76 from linuxserver/readme-mongo-versions

Update supported mongodb versions
This commit is contained in:
Adam 2024-03-19 19:46:42 +00:00 committed by GitHub
commit dc1faeba10
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 8 additions and 8 deletions

View file

@ -64,7 +64,7 @@ After setup, the web UI is available at https://ip:8443. The application can be
### Setting Up Your External Database ### Setting Up Your External Database
Formally only mongodb 3.6 through 4.4 are supported, however, it has been reported that newer versions will work. If you choose to use a newer version be aware that you will not be operating a supported configuration. Starting with version 8.1 of Unifi Network Application, mongodb 3.6 through 7.0 are supported.
**Make sure you pin your database image version and do not use `latest`, as mongodb does not support automatic upgrades between major versions.** **Make sure you pin your database image version and do not use `latest`, as mongodb does not support automatic upgrades between major versions.**
@ -155,7 +155,7 @@ services:
- MONGO_TLS= #optional - MONGO_TLS= #optional
- MONGO_AUTHSOURCE= #optional - MONGO_AUTHSOURCE= #optional
volumes: volumes:
- /path/to/data:/config - /path/to/unifi-network-application/data:/config
ports: ports:
- 8443:8443 - 8443:8443
- 3478:3478/udp - 3478:3478/udp
@ -195,7 +195,7 @@ docker run -d \
-p 8880:8880 `#optional` \ -p 8880:8880 `#optional` \
-p 6789:6789 `#optional` \ -p 6789:6789 `#optional` \
-p 5514:5514/udp `#optional` \ -p 5514:5514/udp `#optional` \
-v /path/to/data:/config \ -v /path/to/unifi-network-application/data:/config \
--restart unless-stopped \ --restart unless-stopped \
lscr.io/linuxserver/unifi-network-application:latest lscr.io/linuxserver/unifi-network-application:latest
``` ```
@ -227,7 +227,7 @@ Containers are configured using parameters passed at runtime (such as those abov
| `-e MEM_STARTUP=1024` | Optionally change the Java initial/minimum memory (in Megabytes). Set to `default` to reset to default | | `-e MEM_STARTUP=1024` | Optionally change the Java initial/minimum memory (in Megabytes). Set to `default` to reset to default |
| `-e MONGO_TLS=` | Mongodb enable [TLS](https://www.mongodb.com/docs/manual/reference/connection-string/#mongodb-urioption-urioption.tls). Only evaluated on first run. | | `-e MONGO_TLS=` | Mongodb enable [TLS](https://www.mongodb.com/docs/manual/reference/connection-string/#mongodb-urioption-urioption.tls). Only evaluated on first run. |
| `-e MONGO_AUTHSOURCE=` | Mongodb [authSource](https://www.mongodb.com/docs/manual/reference/connection-string/#mongodb-urioption-urioption.authSource). For Atlas set to `admin`.Defaults to `MONGO_DBNAME`.Only evaluated on first run. | | `-e MONGO_AUTHSOURCE=` | Mongodb [authSource](https://www.mongodb.com/docs/manual/reference/connection-string/#mongodb-urioption-urioption.authSource). For Atlas set to `admin`.Defaults to `MONGO_DBNAME`.Only evaluated on first run. |
| `-v /config` | All Unifi data stored here | | `-v /config` | Persistent config files |
## Environment variables from files (Docker secrets) ## Environment variables from files (Docker secrets)

View file

@ -19,7 +19,7 @@ development_versions: false
param_container_name: "{{ project_name }}" param_container_name: "{{ project_name }}"
param_usage_include_vols: true param_usage_include_vols: true
param_volumes: param_volumes:
- { vol_path: "/config", vol_host_path: "/path/to/data", desc: "All Unifi data stored here" } - { vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/data", desc: "Persistent config files" }
param_usage_include_ports: true param_usage_include_ports: true
param_ports: param_ports:
@ -61,7 +61,7 @@ app_setup_block: |
### Setting Up Your External Database ### Setting Up Your External Database
Formally only mongodb 3.6 through 4.4 are supported, however, it has been reported that newer versions will work. If you choose to use a newer version be aware that you will not be operating a supported configuration. Starting with version 8.1 of Unifi Network Application, mongodb 3.6 through 7.0 are supported.
**Make sure you pin your database image version and do not use `latest`, as mongodb does not support automatic upgrades between major versions.** **Make sure you pin your database image version and do not use `latest`, as mongodb does not support automatic upgrades between major versions.**
@ -95,9 +95,9 @@ app_setup_block: |
### Device Adoption ### 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). 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. 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.** **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: In order to manually adopt a device take these steps: