From f94df1728542aa6ed29e1040e72c805ed6b4c1b9 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 28 Aug 2023 02:55:41 +0000 Subject: [PATCH 01/38] Bump actions/checkout from 3.5.3 to 3.6.0 Bumps [actions/checkout](https://github.com/actions/checkout) from 3.5.3 to 3.6.0. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/v3.5.3...v3.6.0) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] --- .github/workflows/deploy.yml | 4 ++-- .github/workflows/sync.yml | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 80a54c9334..7325695056 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -8,7 +8,7 @@ jobs: name: Build docs runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3.5.3 + - uses: actions/checkout@v3.6.0 - uses: actions/setup-python@v4.7.0 with: python-version: 3.x @@ -28,7 +28,7 @@ jobs: name: Deploy docs runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3.5.3 + - uses: actions/checkout@v3.6.0 with: fetch-depth: '0' - uses: actions/setup-python@v4.7.0 diff --git a/.github/workflows/sync.yml b/.github/workflows/sync.yml index 732415fa1d..96d69740f9 100644 --- a/.github/workflows/sync.yml +++ b/.github/workflows/sync.yml @@ -12,7 +12,7 @@ jobs: summary-syncer: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3.5.3 + - uses: actions/checkout@v3.6.0 with: fetch-depth: "0" From c96d8daca017888d001f02323ea5cd05e5512c68 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Fri, 1 Sep 2023 10:25:24 +0000 Subject: [PATCH 02/38] Bot Updating Documentation --- images/docker-grocy.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/images/docker-grocy.md b/images/docker-grocy.md index 39a7b0542a..aa5d1ed5b2 100644 --- a/images/docker-grocy.md +++ b/images/docker-grocy.md @@ -42,6 +42,10 @@ The architectures supported by this image are: Grocy is simple to get running. Configure the container with instructions below, start it, and you can then access it by visiting http://your.ip:9283 - once the page loads, you can log in with the default username and password of admin / admin +### Upgrading + +Following a container upgrade ensure that you visit the root (`/`) route (click on the logo in the left upper edge) in order to run any necessary database migrations. See [https://github.com/grocy/grocy#how-to-update](https://github.com/grocy/grocy#how-to-update) for more details. + ## Usage To help you get started creating a container from this image you can either use docker-compose or the docker cli. From 54606b6d6a48b141488f7182c59ab5063d484a56 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Sun, 3 Sep 2023 13:36:39 +0000 Subject: [PATCH 03/38] Bot Updating Documentation --- images/docker-webtop.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/images/docker-webtop.md b/images/docker-webtop.md index c7210aa499..d345eb2afa 100755 --- a/images/docker-webtop.md +++ b/images/docker-webtop.md @@ -78,7 +78,7 @@ The Webtop can be accessed at: **Modern GUI desktop apps (including some flavors terminals) have issues with the latest Docker and syscall compatibility, you can use Docker with the `--security-opt seccomp=unconfined` setting to allow these syscalls** -**Unlike our other containers these Desktops are not designed to be upgraded by Docker, you will keep your home directoy but anything you installed system level will be lost if you upgrade an existing container. To keep packages up to date instead use Ubuntu/Debians's own apt, Alpine's apk, Fedora's dnf, or Arch's pacman program** +**Unlike our other containers these Desktops are not designed to be upgraded by Docker, you will keep your home directory but anything you installed system level will be lost if you upgrade an existing container. To keep packages up to date instead use Ubuntu/Debians's own apt, Alpine's apk, Fedora's dnf, or Arch's pacman program** ### Options in all KasmVNC based GUI containers @@ -104,11 +104,11 @@ This container is based on [Docker Baseimage KasmVNC](https://github.com/linuxse | :----: | --- | | `--privileged` | Will start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE `-v /home/user/docker-data:/var/lib/docker`. | | `-v /var/run/docker.sock:/var/run/docker.sock` | Mount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. | -| `--device /dev/dri:/dev/dri` | Mount a GPU into the container, this can be used in conjunction with the `DRINODE` environment variable to leverage a host video card for GPU accelerated appplications. Only **Open Source** drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau) | +| `--device /dev/dri:/dev/dri` | Mount a GPU into the container, this can be used in conjunction with the `DRINODE` environment variable to leverage a host video card for GPU accelerated applications. Only **Open Source** drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau) | ### Language Support - Internationalization -The [universal internationalization](https://github.com/linuxserver/docker-mods/tree/universal-internationalization) docker mod can be used with any of these variants to provide non english language support. All you need to know is your specific iso-639 code for your your desired language. For example German is `de_DE.UTF-8` Chinese `zh_CN.UTF-8` a full list is here: +The [universal internationalization](https://github.com/linuxserver/docker-mods/tree/universal-internationalization) docker mod can be used with any of these variants to provide non english language support. All you need to know is your specific iso-639 code for your your desired language. For example German is `de_DE.UTF-8` Chinese `zh_CN.UTF-8` a full list is here: [https://github.com/linuxserver/docker-mods/tree/universal-internationalization#other-languages](https://github.com/linuxserver/docker-mods/tree/universal-internationalization#other-languages) From 50c1213c049b84c733d4e514c3d761493666216c Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 4 Sep 2023 02:33:15 +0000 Subject: [PATCH 04/38] Bump mkdocs-material from 9.1.21 to 9.2.7 Bumps [mkdocs-material](https://github.com/squidfunk/mkdocs-material) from 9.1.21 to 9.2.7. - [Release notes](https://github.com/squidfunk/mkdocs-material/releases) - [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG) - [Commits](https://github.com/squidfunk/mkdocs-material/compare/9.1.21...9.2.7) --- updated-dependencies: - dependency-name: mkdocs-material dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 87e8b119d0..7f15edae80 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,5 +1,5 @@ mkdocs-awesome-pages-plugin==2.9.2 mkdocs-git-revision-date-localized-plugin==1.2.0 -mkdocs-material==9.1.21 +mkdocs-material==9.2.7 mkdocs-minify-plugin==0.7.1 mkdocs-redirects==1.2.1 From a94f02fa0bf3df868ad9c0fe0a663b000a0b4b87 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Mon, 4 Sep 2023 11:03:33 +0000 Subject: [PATCH 05/38] Bot Updating Documentation --- images/docker-bookstack.md | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/images/docker-bookstack.md b/images/docker-bookstack.md index becf52dd64..b605d0512a 100644 --- a/images/docker-bookstack.md +++ b/images/docker-bookstack.md @@ -64,7 +64,7 @@ Below is a mapping of container `/config` paths to those relative within a BookS ### Advanced Users (full control over the .env file) If you wish to use the extra functionality of BookStack such as email, Memcache, LDAP and so on you will need to make your own .env file with guidance from the BookStack documentation. - + When you create the container, do not set any arguments for any SQL settings. The container will copy an exemplary .env file to /config/www/.env on your host system for you to edit. ## Usage @@ -121,12 +121,13 @@ docker run -d \ -e PUID=1000 \ -e PGID=1000 \ -e TZ=Etc/UTC \ - -e APP_URL= \ - -e DB_HOST= \ - -e DB_PORT= \ - -e DB_USER= \ - -e DB_PASS= \ + -e APP_URL=yourbaseurl \ + -e DB_HOST=yourdbhost \ + -e DB_PORT=yourdbport \ + -e DB_USER=yourdbuser \ + -e DB_PASS=yourdbpass \ -e DB_DATABASE=bookstackapp \ + -e QUEUE_CONNECTION= `#optional` \ -p 6875:80 \ -v /path/to/data:/config \ --restart unless-stopped \ @@ -151,12 +152,13 @@ Docker images are configured using parameters passed at runtime (such as those a | `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](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). | -| `APP_URL=` | for specifying the IP:port or URL your application will be accessed on (ie. `http://192.168.1.1:6875` or `https://bookstack.mydomain.com` | -| `DB_HOST=` | for specifying the database host | -| `DB_PORT=` | for specifying the database port if not default 3306 | -| `DB_USER=` | for specifying the database user | -| `DB_PASS=` | for specifying the database password (minimum 4 characters & non-alphanumeric passwords must be properly escaped.) | +| `APP_URL=yourbaseurl` | for specifying the IP:port or URL your application will be accessed on (ie. `http://192.168.1.1:6875` or `https://bookstack.mydomain.com` | +| `DB_HOST=yourdbhost` | for specifying the database host | +| `DB_PORT=yourdbport` | for specifying the database port if not default 3306 | +| `DB_USER=yourdbuser` | for specifying the database user | +| `DB_PASS=yourdbpass` | for specifying the database password (minimum 4 characters & non-alphanumeric passwords must be properly escaped.) | | `DB_DATABASE=bookstackapp` | for specifying the database to be used | +| `QUEUE_CONNECTION=` | Set to `database` to enable async actions like sending email or triggering webhooks. See [documentation](https://www.bookstackapp.com/docs/admin/email-webhooks/#async-action-handling). | ### Volume Mappings (`-v`) From d9d1dc740822fda5568a4cdd804795e668e8efa0 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Tue, 5 Sep 2023 12:30:06 +0000 Subject: [PATCH 06/38] Bot Updating Documentation --- images/docker-syncthing.md | 1 + 1 file changed, 1 insertion(+) diff --git a/images/docker-syncthing.md b/images/docker-syncthing.md index 5fe8da9d32..45e82e0fcd 100644 --- a/images/docker-syncthing.md +++ b/images/docker-syncthing.md @@ -172,6 +172,7 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to ## Versions +* **05.09.23:** - Rebase to Alpine 3.18. * **01.07.23:** - Deprecate armhf. As announced [here](https://www.linuxserver.io/blog/a-farewell-to-arm-hf) * **13.02.23:** - Rebase to Alpine 3.17, migrate to s6v3. * **17.08.22:** - Build on alpine 3.16 for go 1.18). From 73df36dd3f087c0a1eb805308acb41e6751181fb Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Tue, 5 Sep 2023 12:56:40 +0000 Subject: [PATCH 07/38] Bot Updating Documentation --- images/docker-unifi-controller.md | 1 + 1 file changed, 1 insertion(+) diff --git a/images/docker-unifi-controller.md b/images/docker-unifi-controller.md index 4d76c9f7a3..70f4ce6fe9 100644 --- a/images/docker-unifi-controller.md +++ b/images/docker-unifi-controller.md @@ -212,6 +212,7 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to ## Versions +* **04.09.23:** - Bump JRE to 17 to support v7.5. * **02.05.23:** - Cleanup `apt-get install` during build to reduce image size. * **18.03.23:** - Add mongoless branch. * **10.03.23:** - Test writing to /run/unifi and symlink to /config/run if it fails. From 17123631f9020e8e61618190c2063c25a898d0d1 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Tue, 5 Sep 2023 22:09:19 +0000 Subject: [PATCH 08/38] Bot Updating Documentation --- images/docker-digikam.md | 1 + 1 file changed, 1 insertion(+) diff --git a/images/docker-digikam.md b/images/docker-digikam.md index 1e20fb5bad..fc67d9a215 100644 --- a/images/docker-digikam.md +++ b/images/docker-digikam.md @@ -197,6 +197,7 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to ## Versions +* **05.09.23:** - Add openexr dependency. * **18.03.23:** - Rebase to KasmVNC base image. * **20.01.23:** - Added breeze-icons package for icon support. * **21.11.22:** - Trigger upon baseimage updates (arch being a rolling distro has too many dependency breaks otherwise). Release version will be the baseimage build date going forward. From 34ce595a280d30e61eaaa5a37366a6745caf09f7 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Wed, 6 Sep 2023 12:00:55 +0000 Subject: [PATCH 09/38] Bot Updating Documentation --- images/docker-phpmyadmin.md | 1 + 1 file changed, 1 insertion(+) diff --git a/images/docker-phpmyadmin.md b/images/docker-phpmyadmin.md index 9be63de3a0..f59f654ccc 100755 --- a/images/docker-phpmyadmin.md +++ b/images/docker-phpmyadmin.md @@ -164,6 +164,7 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to ## Versions +* **06.09.23:** - Add support for custom themes. * **25.05.23:** - Rebase to Alpine 3.18, deprecate armhf. * **13.04.23:** - Move ssl.conf include to default.conf. * **20.01.23:** - Rebase to alpine 3.17 with php8.1. From 9fa8c68afe8bb44b325b63c2607c804ab07493e8 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Wed, 6 Sep 2023 13:39:11 +0000 Subject: [PATCH 10/38] Bot Updating Documentation --- images/docker-unifi-network-application.md | 257 +++++++++++++++++++++ 1 file changed, 257 insertions(+) create mode 100755 images/docker-unifi-network-application.md diff --git a/images/docker-unifi-network-application.md b/images/docker-unifi-network-application.md new file mode 100755 index 0000000000..e8bd22f435 --- /dev/null +++ b/images/docker-unifi-network-application.md @@ -0,0 +1,257 @@ +--- +title: unifi-network-application +--- + + + +# [linuxserver/unifi-network-application](https://github.com/linuxserver/docker-unifi-network-application) + +[![Scarf.io pulls](https://scarf.sh/installs-badge/linuxserver-ci/linuxserver%2Funifi-network-application?color=94398d&label-color=555555&logo-color=ffffff&style=for-the-badge&package-type=docker)](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Funifi-network-application) +[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-unifi-network-application.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-unifi-network-application) +[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-unifi-network-application.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-unifi-network-application/releases) +[![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-unifi-network-application/packages) +[![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/linuxserver.io/docker-unifi-network-application/container_registry) +[![Quay.io](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/unifi-network-application) +[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/unifi-network-application.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/unifi-network-application) +[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/unifi-network-application.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/unifi-network-application) +[![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-unifi-network-application%2Fjob%2Fmain%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-unifi-network-application/job/main/) + +The [Unifi-network-application](https://ui.com/) software is a powerful, enterprise wireless software engine ideal for high-density client deployments requiring low latency and high uptime performance. + +## Supported Architectures + +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) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/). + +Simply pulling `lscr.io/linuxserver/unifi-network-application:latest` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. + +The architectures supported by this image are: + +| Architecture | Available | Tag | +| :----: | :----: | ---- | +| x86-64 | ✅ | amd64-\ | +| arm64 | ✅ | arm64v8-\ | +| armhf | ❌ | | + +## Application Setup + +### This container requires an external mongodb database instance. + +The web UI is at https://ip:8443, setup with the first run wizard. + +### 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. + +If you are using the [official mongodb container](https://hub.docker.com/_/mongo/), you can create your databases using an `init-mongo.js` file with the following contents: + +```js +db.getSiblingDB("MONGO_DBNAME").createUser({user: "MONGO_USER", pwd: "MONGO_PASS", roles: [{role: "readWrite", db: "MONGO_DBNAME"}]}); +db.getSiblingDB("MONGO_DBNAME_stat").createUser({user: "MONGO_USER", pwd: "MONGO_PASS", roles: [{role: "readWrite", db: "MONGO_DBNAME_stat"}]}); +``` + +Being sure to replace the placeholders with the same values you supplied to the Unifi container, and mount it into your *mongodb* container. + +```yaml +volumes: + - ./init-mongo.js:/docker-entrypoint-initdb.d/init-mongo.js:ro +``` + +*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). + +**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](https://github.com/linuxserver/docker-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](https://docs.linuxserver.io/faq#strict-proxy). + +## Usage + +To help you get started creating a container from this image you can either use docker-compose or the docker cli. + +### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose)) + +```yaml +--- +version: "2.1" +services: + unifi-network-application: + image: lscr.io/linuxserver/unifi-network-application:latest + container_name: unifi-network-application + environment: + - PUID=1000 + - PGID=1000 + - TZ=Etc/UTC + - MONGO_USER=unifi + - MONGO_PASS= + - MONGO_HOST=unifi-db + - MONGO_PORT=27017 + - 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 +``` + +### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/)) + +```bash +docker run -d \ + --name=unifi-network-application \ + -e PUID=1000 \ + -e PGID=1000 \ + -e TZ=Etc/UTC \ + -e MONGO_USER=unifi \ + -e MONGO_PASS= \ + -e MONGO_HOST=unifi-db \ + -e MONGO_PORT=27017 \ + -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 + +``` + +## Parameters + +Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). | +| `MONGO_USER=unifi` | Mongodb Username. Only evaluated on first run. | +| `MONGO_PASS=` | Mongodb Password. Only evaluated on first run. | +| `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 | + +### Volume Mappings (`-v`) + +| Volume | Function | +| :----: | --- | +| `/config` | All Unifi data stored here | + +#### 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: + +```bash +-e FILE__PASSWORD=/run/secrets/mysecretpassword +``` + +Will set the environment variable `PASSWORD` based on the contents of the `/run/secrets/mysecretpassword` 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](https://en.wikipedia.org/wiki/Umask) 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 user` as below: + +```bash + $ id username + uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup) +``` + +## Docker Mods + +[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=unifi-network-application&query=%24.mods%5B%27unifi-network-application%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=unifi-network-application "view available mods for this container.") [![Docker Universal Mods](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)](https://mods.linuxserver.io/?mod=universal "view available universal mods.") + +We publish various [Docker Mods](https://github.com/linuxserver/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 + +* Shell access whilst the container is running: + * `docker exec -it unifi-network-application /bin/bash` +* To monitor the logs of the container in realtime: + * `docker logs -f unifi-network-application` +* Container version number + * `docker inspect -f '{{ index .Config.Labels "build_version" }}' unifi-network-application` +* Image version number + * `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/unifi-network-application:latest` + +## Versions + +* **05.09.23:** - Initial release. From 6ed72b6d49aec7b139db29da406c1e952e4eea93 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Wed, 6 Sep 2023 13:39:30 +0000 Subject: [PATCH 11/38] Automated syncing of SUMMARY --- SUMMARY.md | 1 + 1 file changed, 1 insertion(+) diff --git a/SUMMARY.md b/SUMMARY.md index 52578883ce..3e99042319 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -156,6 +156,7 @@ * [linuxserver/tvheadend](images/docker-tvheadend.md) * [linuxserver/ubooquity](images/docker-ubooquity.md) * [linuxserver/unifi-controller](images/docker-unifi-controller.md) +* [linuxserver/unifi-network-application](images/docker-unifi-network-application.md) * [linuxserver/vscodium](images/docker-vscodium.md) * [linuxserver/webcord](images/docker-webcord.md) * [linuxserver/webgrabplus](images/docker-webgrabplus.md) From ec68d40b673ea7b1edee66cfbc723f9e7e2b48f8 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Wed, 6 Sep 2023 17:17:48 +0000 Subject: [PATCH 12/38] Bot Updating Documentation --- images/docker-unifi-controller.md | 1 + 1 file changed, 1 insertion(+) diff --git a/images/docker-unifi-controller.md b/images/docker-unifi-controller.md index 70f4ce6fe9..58680d4bb6 100644 --- a/images/docker-unifi-controller.md +++ b/images/docker-unifi-controller.md @@ -212,6 +212,7 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to ## Versions +* **05.09.23:** - Add deprecation warning as per [https://info.linuxserver.io/issues/2023-09-06-unifi-controller](https://info.linuxserver.io/issues/2023-09-06-unifi-controller). * **04.09.23:** - Bump JRE to 17 to support v7.5. * **02.05.23:** - Cleanup `apt-get install` during build to reduce image size. * **18.03.23:** - Add mongoless branch. From 2ce5c87c0772ac253744f4269b6fd1e81440fdc7 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Thu, 7 Sep 2023 11:21:30 +0000 Subject: [PATCH 13/38] Bot Updating Documentation --- images/docker-unifi-network-application.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/images/docker-unifi-network-application.md b/images/docker-unifi-network-application.md index e8bd22f435..27b21c5605 100755 --- a/images/docker-unifi-network-application.md +++ b/images/docker-unifi-network-application.md @@ -42,6 +42,8 @@ The web UI is at https://ip:8443, setup with the first run wizard. 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. +**Make sure you pin your database image version and do not use `latest`, as mongodb does not support automatic upgrades between major versions.** + If you are using the [official mongodb container](https://hub.docker.com/_/mongo/), you can create your databases using an `init-mongo.js` file with the following contents: ```js From 33f8ea5d47f0f21a2e4c775816e1ee227f83275e Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Thu, 7 Sep 2023 14:15:30 +0000 Subject: [PATCH 14/38] Bot Updating Documentation --- images/docker-unifi-network-application.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/images/docker-unifi-network-application.md b/images/docker-unifi-network-application.md index 27b21c5605..4de38d0e5b 100755 --- a/images/docker-unifi-network-application.md +++ b/images/docker-unifi-network-application.md @@ -60,6 +60,8 @@ volumes: *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.* +*If you are using the init script method do not also set `MONGO_INITDB_ROOT_USERNAME` or `MONGO_INITDB_ROOT_PASSWORD` values as they will cause conflicts.* + You can also run the commands directly against the database using either `mongo` (< 6.0) or `mongosh` (>= 6.0). ### Device Adoption From 9a1b81788c8168d711dbc7f3529dd218d8b18cbe Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Thu, 7 Sep 2023 14:17:34 +0000 Subject: [PATCH 15/38] Bot Updating Documentation --- images/docker-unifi-controller.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/images/docker-unifi-controller.md b/images/docker-unifi-controller.md index 58680d4bb6..55549c8943 100644 --- a/images/docker-unifi-controller.md +++ b/images/docker-unifi-controller.md @@ -43,12 +43,16 @@ This image provides various versions that are available via tags. Please read th | mongoless | ✅ | Stable Unifi Controller releases without mongodb included. | ## Application Setup +### From 2024-01-01 this image will be deprecated and it will no longer be updated. Please migrate to our [Unifi Network Application](https://github.com/linuxserver/docker-unifi-network-application) image instead + +See: [https://info.linuxserver.io/issues/2023-09-06-unifi-controller](https://info.linuxserver.io/issues/2023-09-06-unifi-controller) for more information. + The webui is at https://ip:8443, setup with the first run wizard. -### 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. - 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). +**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: ``` From a613396a1a7aaf1728503bd5232f3eb83c7922f0 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 11 Sep 2023 02:44:43 +0000 Subject: [PATCH 16/38] Bump actions/checkout from 3.6.0 to 4.0.0 Bumps [actions/checkout](https://github.com/actions/checkout) from 3.6.0 to 4.0.0. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/v3.6.0...v4.0.0) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] --- .github/workflows/deploy.yml | 4 ++-- .github/workflows/sync.yml | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 7325695056..caf945e65d 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -8,7 +8,7 @@ jobs: name: Build docs runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3.6.0 + - uses: actions/checkout@v4.0.0 - uses: actions/setup-python@v4.7.0 with: python-version: 3.x @@ -28,7 +28,7 @@ jobs: name: Deploy docs runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3.6.0 + - uses: actions/checkout@v4.0.0 with: fetch-depth: '0' - uses: actions/setup-python@v4.7.0 diff --git a/.github/workflows/sync.yml b/.github/workflows/sync.yml index 96d69740f9..1d330a81b4 100644 --- a/.github/workflows/sync.yml +++ b/.github/workflows/sync.yml @@ -12,7 +12,7 @@ jobs: summary-syncer: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3.6.0 + - uses: actions/checkout@v4.0.0 with: fetch-depth: "0" From 4949d9ba9a8bf1b604692526ed0e314478e0603d Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 11 Sep 2023 02:44:46 +0000 Subject: [PATCH 17/38] Bump actions/cache from 3.3.1 to 3.3.2 Bumps [actions/cache](https://github.com/actions/cache) from 3.3.1 to 3.3.2. - [Release notes](https://github.com/actions/cache/releases) - [Changelog](https://github.com/actions/cache/blob/main/RELEASES.md) - [Commits](https://github.com/actions/cache/compare/v3.3.1...v3.3.2) --- updated-dependencies: - dependency-name: actions/cache dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- .github/workflows/deploy.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 7325695056..00de98be40 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -12,7 +12,7 @@ jobs: - uses: actions/setup-python@v4.7.0 with: python-version: 3.x - - uses: actions/cache@v3.3.1 + - uses: actions/cache@v3.3.2 with: key: ${{ github.ref }} path: .cache @@ -34,7 +34,7 @@ jobs: - uses: actions/setup-python@v4.7.0 with: python-version: 3.x - - uses: actions/cache@v3.3.1 + - uses: actions/cache@v3.3.2 with: key: ${{ github.ref }} path: .cache From 9452118c78dd995cdd2f5ec03ccb86d48e274fae Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Tue, 12 Sep 2023 11:13:23 +0000 Subject: [PATCH 18/38] Bot Updating Documentation --- images/docker-unifi-network-application.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/images/docker-unifi-network-application.md b/images/docker-unifi-network-application.md index 4de38d0e5b..ed16b3bbbc 100755 --- a/images/docker-unifi-network-application.md +++ b/images/docker-unifi-network-application.md @@ -190,8 +190,8 @@ Docker images are configured using parameters passed at runtime (such as those a | `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](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). | -| `MONGO_USER=unifi` | Mongodb Username. Only evaluated on first run. | -| `MONGO_PASS=` | Mongodb Password. Only evaluated on first run. | +| `MONGO_USER=unifi` | Mongodb Username. Only evaluated on first run. **Special characters must be [url encoded](https://en.wikipedia.org/wiki/Percent-encoding)**. | +| `MONGO_PASS=` | Mongodb Password. Only evaluated on first run. **Special characters must be [url encoded](https://en.wikipedia.org/wiki/Percent-encoding)**. | | `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. | From 37f7b92711ef5c9d8189d0bfac924230653af46f Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Tue, 12 Sep 2023 19:02:36 +0000 Subject: [PATCH 19/38] Bot Updating Documentation --- images/docker-jellyfin.md | 1 + 1 file changed, 1 insertion(+) diff --git a/images/docker-jellyfin.md b/images/docker-jellyfin.md index 5fc495ce12..188f31fd67 100644 --- a/images/docker-jellyfin.md +++ b/images/docker-jellyfin.md @@ -239,6 +239,7 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to ## Versions +* **12.09.23:** - Take ownership of plugin directories. * **04.07.23:** - Deprecate armhf. As announced [here](https://www.linuxserver.io/blog/a-farewell-to-arm-hf) * **07.12.22:** - Rebase master to Jammy, migrate to s6v3. * **11.06.22:** - Switch to upstream repo's ffmpeg5 build. From c295c4fdf295d5c2ebea6b8d76a902eab9adbda3 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 12 Sep 2023 19:31:01 +0000 Subject: [PATCH 20/38] Bump mkdocs-material from 9.2.7 to 9.3.1 Bumps [mkdocs-material](https://github.com/squidfunk/mkdocs-material) from 9.2.7 to 9.3.1. - [Release notes](https://github.com/squidfunk/mkdocs-material/releases) - [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG) - [Commits](https://github.com/squidfunk/mkdocs-material/compare/9.2.7...9.3.1) --- updated-dependencies: - dependency-name: mkdocs-material dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 7f15edae80..2f6a78bc6d 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,5 +1,5 @@ mkdocs-awesome-pages-plugin==2.9.2 mkdocs-git-revision-date-localized-plugin==1.2.0 -mkdocs-material==9.2.7 +mkdocs-material==9.3.1 mkdocs-minify-plugin==0.7.1 mkdocs-redirects==1.2.1 From 253cb3305823c9749be0c7c9987fa4419210b9cf Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Wed, 13 Sep 2023 16:31:21 +0000 Subject: [PATCH 21/38] Bot Updating Documentation --- images/docker-sabnzbd.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/images/docker-sabnzbd.md b/images/docker-sabnzbd.md index fe7932dfc0..11afaa6f3c 100755 --- a/images/docker-sabnzbd.md +++ b/images/docker-sabnzbd.md @@ -58,7 +58,7 @@ In Sabnzbd gui settings, under `Folders`, make sure to set the `Completed Downlo We have set `/incomplete-downloads` and `/downloads` as ***optional paths***, this is because it is the easiest way to get started. While easy to use, it has some drawbacks. Mainly losing the ability to hardlink (TL;DR a way for a file to exist in multiple places on the same file system while only consuming one file worth of space), or atomic move (TL;DR instant file moves, rather than copy+delete) files while processing content. -Use the optional paths if you dont understand, or dont want hardlinks/atomic moves. +Use the optional paths if you dont understand, or dont want hardlinks/atomic moves. The folks over at servarr.com wrote a good [write-up](https://wiki.servarr.com/docker-guide#consistent-and-well-planned-paths) on how to get started with this. @@ -185,6 +185,7 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to ## Versions +* **13.09.23:** - Use par2cmdline-turbo in place of par2cmdline. * **16.08.23:** - Install unrar from [linuxserver repo](https://github.com/linuxserver/docker-unrar). * **10.08.23:** - Bump unrar to 6.2.10. * **16.05.23:** - Rebase stable to Alpine 3.18, deprecate armhf. From 5f3785710eb5687809099e1ad4fba028d3428159 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Sat, 16 Sep 2023 19:39:09 +0000 Subject: [PATCH 22/38] Bot Updating Documentation --- images/docker-emulatorjs.md | 1 + 1 file changed, 1 insertion(+) diff --git a/images/docker-emulatorjs.md b/images/docker-emulatorjs.md index c160289c92..e9046e71dc 100755 --- a/images/docker-emulatorjs.md +++ b/images/docker-emulatorjs.md @@ -215,6 +215,7 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to ## Versions +* **09.08.23:** - Rebase to Alpine 3.18, migrate to s6v3. * **06.07.23:** - Deprecate armhf. As announced [here](https://www.linuxserver.io/blog/a-farewell-to-arm-hf) * **24.11.22:** - Update IPFS links for chdman. * **04.04.22:** - Ingest pre-built chdman bins during build time. From df315fdc51192f47dd663e41a40c40954794d7d0 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Tue, 19 Sep 2023 19:10:10 +0000 Subject: [PATCH 23/38] Bot Updating Documentation --- images/docker-swag.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/images/docker-swag.md b/images/docker-swag.md index 80c1752d04..9cffc8c3f0 100755 --- a/images/docker-swag.md +++ b/images/docker-swag.md @@ -197,7 +197,7 @@ Docker images are configured using parameters passed at runtime (such as those a | `VALIDATION=http` | Certbot validation method to use, options are `http` or `dns` (`dns` method also requires `DNSPLUGIN` variable set). | | `SUBDOMAINS=www,` | Subdomains you'd like the cert to cover (comma separated, no spaces) ie. `www,ftp,cloud`. For a wildcard cert, set this *exactly* to `wildcard` (wildcard cert is available via `dns` validation only) | | `CERTPROVIDER=` | Optionally define the cert provider. Set to `zerossl` for ZeroSSL certs (requires existing [ZeroSSL account](https://app.zerossl.com/signup) and the e-mail address entered in `EMAIL` env var). Otherwise defaults to Let's Encrypt. | -| `DNSPLUGIN=cloudflare` | Required if `VALIDATION` is set to `dns`. Options are `acmedns`, `aliyun`, `azure`, `bunny`, `cloudflare`, `cpanel`, `desec`, `digitalocean`, `directadmin`, `dnsimple`, `dnsmadeeasy`, `dnspod`, `do`, `domeneshop`, `dreamhost`, `duckdns`, `dynu`, `freedns`, `gandi`, `gehirn`, `godaddy`, `google`, `google-domains`, `he`, `hetzner`, `infomaniak`, `inwx`, `ionos`, `linode`, `loopia`, `luadns`, `netcup`, `njalla`, `nsone`, `ovh`, `porkbun`, `rfc2136`, `route53`, `sakuracloud`, `standalone`, `transip`, and `vultr`. Also need to enter the credentials into the corresponding ini (or json for some plugins) file under `/config/dns-conf`. | +| `DNSPLUGIN=cloudflare` | Required if `VALIDATION` is set to `dns`. Options are `acmedns`, `aliyun`, `azure`, `bunny`, `cloudflare`, `cpanel`, `desec`, `digitalocean`, `directadmin`, `dnsimple`, `dnsmadeeasy`, `dnspod`, `do`, `domeneshop`, `dreamhost`, `duckdns`, `dynu`, `freedns`, `gandi`, `gehirn`, `godaddy`, `google`, `google-domains`, `he`, `hetzner`, `infomaniak`, `inwx`, `ionos`, `linode`, `loopia`, `luadns`, `namecheap`, `netcup`, `njalla`, `nsone`, `ovh`, `porkbun`, `rfc2136`, `route53`, `sakuracloud`, `standalone`, `transip`, and `vultr`. Also need to enter the credentials into the corresponding ini (or json for some plugins) file under `/config/dns-conf`. | | `PROPAGATION=` | Optionally override (in seconds) the default propagation time for the dns plugins. | | `EMAIL=` | Optional e-mail address used for cert expiration notifications (Required for ZeroSSL). | | `ONLY_SUBDOMAINS=false` | If you wish to get certs only for certain subdomains, but not the main domain (main domain may be hosted on another machine and cannot be validated), set this to `true` | @@ -270,6 +270,7 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to ## Versions +* **28.08.23:** - Add Namecheap DNS plugin. * **12.08.23:** - Add FreeDNS plugin. Detect certbot DNS authenticators using CLI. * **07.08.23:** - Add Bunny DNS Configuration. * **27.07.23:** - Added support for dreamhost validation. From f0592e563d8166c667427f0027a2826ed1b5962c Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Wed, 20 Sep 2023 00:07:11 +0000 Subject: [PATCH 24/38] Bot Updating Documentation --- images/docker-series-troxide.md | 192 ++++++++++++++++++++++++++++++++ 1 file changed, 192 insertions(+) create mode 100755 images/docker-series-troxide.md diff --git a/images/docker-series-troxide.md b/images/docker-series-troxide.md new file mode 100755 index 0000000000..d24da4d9f2 --- /dev/null +++ b/images/docker-series-troxide.md @@ -0,0 +1,192 @@ +--- +title: series-troxide +--- + + + +# [linuxserver/series-troxide](https://github.com/linuxserver/docker-series-troxide) + +[![Scarf.io pulls](https://scarf.sh/installs-badge/linuxserver-ci/linuxserver%2Fseries-troxide?color=94398d&label-color=555555&logo-color=ffffff&style=for-the-badge&package-type=docker)](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Fseries-troxide) +[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-series-troxide.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-series-troxide) +[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-series-troxide.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-series-troxide/releases) +[![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-series-troxide/packages) +[![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/linuxserver.io/docker-series-troxide/container_registry) +[![Quay.io](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/series-troxide) +[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/series-troxide.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/series-troxide) +[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/series-troxide.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/series-troxide) +[![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-series-troxide%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-series-troxide/job/master/) +[![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Fseries-troxide%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/series-troxide/latest/index.html) + +[Series Troxide](https://github.com/MaarifaMaarifa/series-troxide) a Simple and Modern Series Tracker + +## Supported Architectures + +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) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/). + +Simply pulling `lscr.io/linuxserver/series-troxide:latest` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. + +The architectures supported by this image are: + +| Architecture | Available | Tag | +| :----: | :----: | ---- | +| x86-64 | ✅ | amd64-\ | +| arm64 | ✅ | arm64v8-\ | +| armhf | ❌ | | + +## Application Setup + +The application can be accessed at: + +* http://yourhost:3000/ +* https://yourhost:3001/ + +### Options in all KasmVNC based GUI containers + +This container is based on [Docker Baseimage KasmVNC](https://github.com/linuxserver/docker-baseimage-kasmvnc) which means there are additional environment variables and run configurations to enable or disable specific functionality. + +#### Optional environment variables + +| Variable | Description | +| :----: | --- | +| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 3000. | +| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default 3001. | +| CUSTOM_USER | HTTP Basic auth username, abc is default. | +| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth | +| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE `/subfolder/` | +| TITLE | The page title displayed on the web browser, default "KasmVNC Client". | +| FM_HOME | This is the home directory (landing) for the file manager, default "/config". | +| START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup. | +| DRINODE | If mounting in /dev/dri for [DRI3 GPU Acceleration](https://www.kasmweb.com/kasmvnc/docs/master/gpu_acceleration.html) allows you to specify the device to use IE `/dev/dri/renderD128` | + +#### Optional run configurations + +| Variable | Description | +| :----: | --- | +| `--privileged` | Will start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE `-v /home/user/docker-data:/var/lib/docker`. | +| `-v /var/run/docker.sock:/var/run/docker.sock` | Mount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. | +| `--device /dev/dri:/dev/dri` | Mount a GPU into the container, this can be used in conjunction with the `DRINODE` environment variable to leverage a host video card for GPU accelerated appplications. Only **Open Source** drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau) | + +## Usage + +To help you get started creating a container from this image you can either use docker-compose or the docker cli. + +### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose)) + +```yaml +--- +version: "2.1" +services: + series-troxide: + image: lscr.io/linuxserver/series-troxide:latest + container_name: series-troxide + environment: + - PUID=1000 + - PGID=1000 + - TZ=Etc/UTC + volumes: + - /path/to/config:/config + ports: + - 3000:3000 + - 3001:3001 + shm_size: "1gb" + restart: unless-stopped +``` + +### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/)) + +```bash +docker run -d \ + --name=series-troxide \ + -e PUID=1000 \ + -e PGID=1000 \ + -e TZ=Etc/UTC \ + -p 3000:3000 \ + -p 3001:3001 \ + -v /path/to/config:/config \ + --shm-size="1gb" \ + --restart unless-stopped \ + lscr.io/linuxserver/series-troxide:latest + +``` + +## Parameters + +Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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 | +| :----: | --- | +| `3000` | Series Troxide desktop gui. | +| `3001` | HTTPS Series Troxide desktop gui. | + +### 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](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). | + +### Volume Mappings (`-v`) + +| Volume | Function | +| :----: | --- | +| `/config` | Users home directory in the container, stores local files and settings | + +#### Miscellaneous Options + +| Parameter | Function | +| :-----: | --- | +| `--shm-size=` | This is required for the application to run properly. | + +## Environment variables from files (Docker secrets) + +You can set any environment variable from a file by using a special prepend `FILE__`. + +As an example: + +```bash +-e FILE__PASSWORD=/run/secrets/mysecretpassword +``` + +Will set the environment variable `PASSWORD` based on the contents of the `/run/secrets/mysecretpassword` 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](https://en.wikipedia.org/wiki/Umask) 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 user` as below: + +```bash + $ id username + uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup) +``` + +## Docker Mods + +[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=series-troxide&query=%24.mods%5B%27series-troxide%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=series-troxide "view available mods for this container.") [![Docker Universal Mods](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)](https://mods.linuxserver.io/?mod=universal "view available universal mods.") + +We publish various [Docker Mods](https://github.com/linuxserver/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 + +* Shell access whilst the container is running: + * `docker exec -it series-troxide /bin/bash` +* To monitor the logs of the container in realtime: + * `docker logs -f series-troxide` +* Container version number + * `docker inspect -f '{{ index .Config.Labels "build_version" }}' series-troxide` +* Image version number + * `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/series-troxide:latest` + +## Versions + +* **16.09.23:** - Initial release. From 868f77c8360cc399e1ee32026dc7b7604e96a43e Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Wed, 20 Sep 2023 00:07:39 +0000 Subject: [PATCH 25/38] Automated syncing of SUMMARY --- SUMMARY.md | 1 + 1 file changed, 1 insertion(+) diff --git a/SUMMARY.md b/SUMMARY.md index 3e99042319..856673c83a 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -138,6 +138,7 @@ * [linuxserver/resilio-sync](images/docker-resilio-sync.md) * [linuxserver/rsnapshot](images/docker-rsnapshot.md) * [linuxserver/sabnzbd](images/docker-sabnzbd.md) +* [linuxserver/series-troxide](images/docker-series-troxide.md) * [linuxserver/sickchill](images/docker-sickchill.md) * [linuxserver/sickgear](images/docker-sickgear.md) * [linuxserver/smokeping](images/docker-smokeping.md) From ec5c6f138461193d90bfe47ed35f423905597907 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Thu, 21 Sep 2023 08:09:08 +0000 Subject: [PATCH 26/38] Bot Updating Documentation --- images/docker-bazarr.md | 1 + 1 file changed, 1 insertion(+) diff --git a/images/docker-bazarr.md b/images/docker-bazarr.md index 14b9e137ef..bd197ee6c3 100644 --- a/images/docker-bazarr.md +++ b/images/docker-bazarr.md @@ -169,6 +169,7 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to ## Versions +* **19.09.23:** - Install unrar from [linuxserver repo](https://github.com/linuxserver/docker-unrar). * **11.08.23:** - Rebase to Alpine 3.18. * **10.08.23:** - Bump unrar to 6.2.10. * **04.07.23:** - Deprecate armhf. As announced [here](https://www.linuxserver.io/blog/a-farewell-to-arm-hf) From 08dd489af58cce567fd5de13356a8558a0a1b988 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Thu, 21 Sep 2023 08:09:59 +0000 Subject: [PATCH 27/38] Bot Updating Documentation --- images/docker-tvheadend.md | 1 + 1 file changed, 1 insertion(+) diff --git a/images/docker-tvheadend.md b/images/docker-tvheadend.md index 74ce231913..8cf6ba53df 100644 --- a/images/docker-tvheadend.md +++ b/images/docker-tvheadend.md @@ -238,6 +238,7 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to ## Versions +* **20.09.23:** - Add perl-json-xs package. * **18.05.23:** - Install XMLTV from Alpine repos. * **18.05.23:** - Rebase to Alpine 3.18. * **17.03.23:** - Extract picons during build instead of init. From 2bea0b3f8c315071337800c4b0289547c63afeb3 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Thu, 21 Sep 2023 16:46:22 +0000 Subject: [PATCH 28/38] Bot Updating Documentation --- images/docker-mastodon.md | 1 + 1 file changed, 1 insertion(+) diff --git a/images/docker-mastodon.md b/images/docker-mastodon.md index 396a66ebc8..f329104452 100755 --- a/images/docker-mastodon.md +++ b/images/docker-mastodon.md @@ -290,6 +290,7 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to ## Versions +* **21.09.23:** - Rebase to Alpine 3.18, migrate to s6v3. * **25.05.23:** - Adjust apk flags. * **09.02.23:** - Add Glitch branch. * **09.01.23:** - Updated nginx conf to fix bring inline with Mastodon configuration (fixes Elk integration). From c05f20e89756c207a0d51e9158b46a5cbe26a449 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Fri, 22 Sep 2023 23:36:37 +0000 Subject: [PATCH 29/38] Bot Updating Documentation --- images/docker-mastodon.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/images/docker-mastodon.md b/images/docker-mastodon.md index f329104452..1ca4d9b345 100755 --- a/images/docker-mastodon.md +++ b/images/docker-mastodon.md @@ -65,7 +65,7 @@ For more information check out the [mastodon documentation](https://docs.joinmas It is currently only supported to run a single queue per container instance *or* all queues in a single container instance. -All containers must share the same `/config`` mount and be on a common docker network. +All containers must share the same `/config` mount and be on a common docker network. ### Strict reverse proxies From fd442f59e35531339695a3045e15b8fd895b37f6 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Sun, 24 Sep 2023 14:11:48 +0000 Subject: [PATCH 30/38] Bot Updating Documentation --- images/docker-gmail-order-bot.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/images/docker-gmail-order-bot.md b/images/docker-gmail-order-bot.md index 46711713b2..a08bdd4e99 100755 --- a/images/docker-gmail-order-bot.md +++ b/images/docker-gmail-order-bot.md @@ -4,6 +4,10 @@ title: gmail-order-bot +# DEPRECATION NOTICE + +This image is deprecated. We will not offer support for this image and it will not be updated. + # [lsiodev/gmail-order-bot](https://github.com/lsiodev/docker-gmail-order-bot) [![Scarf.io pulls](https://scarf.sh/installs-badge/lsiodev-ci/lsiodev%2Fgmail-order-bot?color=94398d&label-color=555555&logo-color=ffffff&style=for-the-badge&package-type=docker)](https://scarf.sh/gateway/lsiodev-ci/docker/lsiodev%2Fgmail-order-bot) @@ -30,7 +34,7 @@ The architectures supported by this image are: | :----: | :----: | ---- | | x86-64 | ✅ | amd64-\ | | arm64 | ✅ | arm64v8-\ | -| armhf| ✅ | arm32v7-\ | +| armhf | ❌ | | ## Application Setup @@ -38,7 +42,7 @@ This container is for developers only! We make pre-defined bots we use in our wo The entire basis of this is to act as middleware between your email address receiving orders from https://checkout.linuxserver.io and send them to some external service. The bot will archive any messages that do not come from orders@nanocheckout.com with valid DKIM signatures, so definetly do not use this on a personal account. -The concept behind this bot and using email as a destination for orders is to serve normal users that simply want an email for an order out of the box and provide a free messaging queue akin to something like RabbitMQ for people that want to automate order ingestion. +The concept behind this bot and using email as a destination for orders is to serve normal users that simply want an email for an order out of the box and provide a free messaging queue akin to something like RabbitMQ for people that want to automate order ingestion. By default we include bots we use that will be copied over on first container run, for example a simple discord ping when an order is received with the order details: ``` @@ -62,9 +66,9 @@ exports.orderbot = async function(order) { } ``` -This code will be passed an order object containing all the order details parsed from the email message. Here we use custom env variables to set application settings to connect up to and send a message to discord. +This code will be passed an order object containing all the order details parsed from the email message. Here we use custom env variables to set application settings to connect up to and send a message to discord. -In order to use this bot you will need to perform the following setup steps: +In order to use this bot you will need to perform the following setup steps: 1. Create a dedicated gmail account to use for https://checkout.linuxserver.io 2. Enable API access to this Gmail account by clicking on `Enable the Gmail API` here https://developers.google.com/gmail/api/quickstart/nodejs 3. Save your credentials.json file from that action to the folder you will be bind mounting as `/config` @@ -72,7 +76,7 @@ In order to use this bot you will need to perform the following setup steps: 5. Go to the URL prompted and enter the key you get from it. 6. Start the container using the run/compose example in this readme. -When the container starts if you are using a custom bot located in `/config/bots` it will install the node modules included in it's package.json, do not use system level node modules this container is Alpine based and it will cause conflicts. +When the container starts if you are using a custom bot located in `/config/bots` it will install the node modules included in it's package.json, do not use system level node modules this container is Alpine based and it will cause conflicts. From there the bot will loop in for your defined timeout and pull in emails and spit out orders to your destination. @@ -92,6 +96,7 @@ services: environment: - PUID=1000 - PGID=1000 + - TZ=Etc/UTC - BOT_NAME=discord - LOOP_TIME=60 volumes: @@ -106,11 +111,13 @@ docker run -d \ --name=gmail-order-bot \ -e PUID=1000 \ -e PGID=1000 \ + -e TZ=Etc/UTC \ -e BOT_NAME=discord \ -e LOOP_TIME=60 \ -v /path/to/data:/config \ --restart unless-stopped \ lscr.io/lsiodev/gmail-order-bot:latest + ``` ## Parameters @@ -128,6 +135,7 @@ Docker images are configured using parameters passed at runtime (such as those a | :----: | --- | | `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](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). | | `BOT_NAME=discord` | On successful order receive send the order payload to this bot (default bots are located in root/defaults/bots) | | `LOOP_TIME=60` | Time in seconds to reach into gmail and get new messages to process | @@ -191,4 +199,5 @@ We publish various [Docker Mods](https://github.com/lsiodev/docker-mods) to enab ## Versions +* **24.09.23:** - Deprecate. * **06.07.20:** - Initial Release. From 750b63e7d9978d622f69dcd382b18b1d9a4f2848 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 25 Sep 2023 02:53:27 +0000 Subject: [PATCH 31/38] Bump actions/checkout from 4.0.0 to 4.1.0 Bumps [actions/checkout](https://github.com/actions/checkout) from 4.0.0 to 4.1.0. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/v4.0.0...v4.1.0) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] --- .github/workflows/deploy.yml | 4 ++-- .github/workflows/sync.yml | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 0088fd8462..b4cbebb629 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -8,7 +8,7 @@ jobs: name: Build docs runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4.0.0 + - uses: actions/checkout@v4.1.0 - uses: actions/setup-python@v4.7.0 with: python-version: 3.x @@ -28,7 +28,7 @@ jobs: name: Deploy docs runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4.0.0 + - uses: actions/checkout@v4.1.0 with: fetch-depth: '0' - uses: actions/setup-python@v4.7.0 diff --git a/.github/workflows/sync.yml b/.github/workflows/sync.yml index 1d330a81b4..c0cee8346a 100644 --- a/.github/workflows/sync.yml +++ b/.github/workflows/sync.yml @@ -12,7 +12,7 @@ jobs: summary-syncer: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4.0.0 + - uses: actions/checkout@v4.1.0 with: fetch-depth: "0" From 2cc13a521aa29b83d6f80658e0c3c09393e7ea24 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 25 Sep 2023 02:54:06 +0000 Subject: [PATCH 32/38] Bump mkdocs-material from 9.3.1 to 9.4.1 Bumps [mkdocs-material](https://github.com/squidfunk/mkdocs-material) from 9.3.1 to 9.4.1. - [Release notes](https://github.com/squidfunk/mkdocs-material/releases) - [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG) - [Commits](https://github.com/squidfunk/mkdocs-material/compare/9.3.1...9.4.1) --- updated-dependencies: - dependency-name: mkdocs-material dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 2f6a78bc6d..794defa2cb 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,5 +1,5 @@ mkdocs-awesome-pages-plugin==2.9.2 mkdocs-git-revision-date-localized-plugin==1.2.0 -mkdocs-material==9.3.1 +mkdocs-material==9.4.1 mkdocs-minify-plugin==0.7.1 mkdocs-redirects==1.2.1 From a4751440cb44b82d3912d2df2fbc5966b510a134 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Mon, 25 Sep 2023 15:50:06 +0000 Subject: [PATCH 33/38] Bot Updating Documentation --- images/docker-unifi-network-application.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/images/docker-unifi-network-application.md b/images/docker-unifi-network-application.md index ed16b3bbbc..de3bddb1dd 100755 --- a/images/docker-unifi-network-application.md +++ b/images/docker-unifi-network-application.md @@ -34,9 +34,9 @@ The architectures supported by this image are: ## Application Setup -### This container requires an external mongodb database instance. +After setup, the web UI is available at https://ip:8443. The application can be configured, or a backup restored, using the first run wizard. -The web UI is at https://ip:8443, setup with the first run wizard. +**This container requires an external mongodb database instance.** ### Setting Up Your External Database @@ -53,14 +53,21 @@ db.getSiblingDB("MONGO_DBNAME_stat").createUser({user: "MONGO_USER", pwd: "MONGO Being sure to replace the placeholders with the same values you supplied to the Unifi container, and mount it into your *mongodb* container. +For example: + ```yaml -volumes: - - ./init-mongo.js:/docker-entrypoint-initdb.d/init-mongo.js:ro + unifi-db: + image: docker.io/mongo: + container_name: unifi-db + volumes: + - /path/to/data:/data/db + - /path/to/init-mongo.js:/docker-entrypoint-initdb.d/init-mongo.js:ro + 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.* -*If you are using the init script method do not also set `MONGO_INITDB_ROOT_USERNAME` or `MONGO_INITDB_ROOT_PASSWORD` values as they will cause conflicts.* +*If you are using the init script method do not also set `MONGO_INITDB_ROOT_USERNAME`, `MONGO_INITDB_ROOT_PASSWORD`, or any other "INITDB" values as they will cause conflicts.* You can also run the commands directly against the database using either `mongo` (< 6.0) or `mongosh` (>= 6.0). From 1aebfacd55f43c34152ce00a67ebbbe1e856b9bc Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Tue, 26 Sep 2023 14:16:04 +0000 Subject: [PATCH 34/38] Bot Updating Documentation --- images/docker-mastodon.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/images/docker-mastodon.md b/images/docker-mastodon.md index 1ca4d9b345..25395b251a 100755 --- a/images/docker-mastodon.md +++ b/images/docker-mastodon.md @@ -67,6 +67,12 @@ It is currently only supported to run a single queue per container instance *or* All containers must share the same `/config` mount and be on a common docker network. +### NO_CHOWN Option + +On larger Mastodon instances, our init process to verify that permissions are set correctly can noticeably slow down the container startup. If you are experiencing this, you can set `NO_CHOWN` to `true` to skip that step of the init. + +*Do NOT set this on first run of the container. If you enable this option you are taking full responsibility for ensuring that the permissions in your /config mount are correct. If you're even slightly unsure, don't set it.* + ### Strict reverse proxies This image automatically redirects to https with a self-signed certificate. If you are using a reverse proxy which validates certificates, you need to [disable this check for the container](https://docs.linuxserver.io/faq#strict-proxy). @@ -121,6 +127,7 @@ services: - SIDEKIQ_DEFAULT=false #optional - SIDEKIQ_THREADS=5 #optional - DB_POOL=5 #optional + - NO_CHOWN= #optional volumes: - /path/to/appdata/config:/config ports: @@ -170,6 +177,7 @@ docker run -d \ -e SIDEKIQ_DEFAULT=false `#optional` \ -e SIDEKIQ_THREADS=5 `#optional` \ -e DB_POOL=5 `#optional` \ + -e NO_CHOWN= `#optional` \ -p 80:80 \ -p 443:443 \ -v /path/to/appdata/config:/config \ @@ -229,6 +237,7 @@ Docker images are configured using parameters passed at runtime (such as those a | `SIDEKIQ_DEFAULT=false` | Set to `true` on the main container if you're running additional sidekiq instances. It will run the `default` queue. | | `SIDEKIQ_THREADS=5` | The number of threads for sidekiq to use. See [notes](https://docs.joinmastodon.org/admin/scaling/#sidekiq-threads). | | `DB_POOL=5` | The size of the DB connection pool, must be *at least* the same as `SIDEKIQ_THREADS`. See [notes](https://docs.joinmastodon.org/admin/scaling/#sidekiq-threads). | +| `NO_CHOWN=` | Set to `true` to skip chown of /config on init. *READ THE APPLICATION NOTES BEFORE SETTING THIS*. | ### Volume Mappings (`-v`) From 620216e0afbd99012b5a7827cd1c826bfa5e84c7 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Tue, 26 Sep 2023 17:00:24 +0000 Subject: [PATCH 35/38] Bot Updating Documentation --- images/docker-unifi-network-application.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/images/docker-unifi-network-application.md b/images/docker-unifi-network-application.md index de3bddb1dd..226b5b4a80 100755 --- a/images/docker-unifi-network-application.md +++ b/images/docker-unifi-network-application.md @@ -44,11 +44,10 @@ Formally only mongodb 3.6 through 4.4 are supported, however, it has been report **Make sure you pin your database image version and do not use `latest`, as mongodb does not support automatic upgrades between major versions.** -If you are using the [official mongodb container](https://hub.docker.com/_/mongo/), you can create your databases using an `init-mongo.js` file with the following contents: +If you are using the [official mongodb container](https://hub.docker.com/_/mongo/), you can create your user using an `init-mongo.js` file with the following contents: ```js -db.getSiblingDB("MONGO_DBNAME").createUser({user: "MONGO_USER", pwd: "MONGO_PASS", roles: [{role: "readWrite", db: "MONGO_DBNAME"}]}); -db.getSiblingDB("MONGO_DBNAME_stat").createUser({user: "MONGO_USER", pwd: "MONGO_PASS", roles: [{role: "readWrite", db: "MONGO_DBNAME_stat"}]}); +db.getSiblingDB("MONGO_DBNAME").createUser({user: "MONGO_USER", pwd: "MONGO_PASS", roles: [{role: "dbOwner", db: "MONGO_DBNAME"}, {role: "dbOwner", db: "MONGO_DBNAME_stat"}]}); ``` Being sure to replace the placeholders with the same values you supplied to the Unifi container, and mount it into your *mongodb* container. From 2921cab531e0bd9492f01e4df20934df907236c4 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Fri, 29 Sep 2023 00:37:30 +0000 Subject: [PATCH 36/38] Bot Updating Documentation --- images/docker-nextcloud.md | 1 + 1 file changed, 1 insertion(+) diff --git a/images/docker-nextcloud.md b/images/docker-nextcloud.md index 9a26a689ef..572a8f9bc9 100644 --- a/images/docker-nextcloud.md +++ b/images/docker-nextcloud.md @@ -197,6 +197,7 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to ## Versions +* **31.08.23:** - Re-add updatenotification app. This allows users to be notified for app updates, but also notifies for NextCloud updates. Updating NextCloud via the web UI is not supported when using this image. * **14.08.23:** - Add develop branch. * **25.06.23:** - Move Nextcloud installation inside container. Remove CLI updater. [See changes announcement](https://info.linuxserver.io/issues/2023-06-25-nextcloud/). * **21.06.23:** - Existing users should update `/config/nginx/site-confs/default.conf` - Security fix for real ip settings. From 5d4e14ed257788dfaf728677fcc24d4e3fb7ef5a Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Sun, 1 Oct 2023 16:29:17 +0000 Subject: [PATCH 37/38] Bot Updating Documentation --- images/docker-swag.md | 1 + 1 file changed, 1 insertion(+) diff --git a/images/docker-swag.md b/images/docker-swag.md index 9cffc8c3f0..24b179e80b 100755 --- a/images/docker-swag.md +++ b/images/docker-swag.md @@ -270,6 +270,7 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to ## Versions +* **01.10.23:** - Fix "unrecognized arguments" issue in DirectAdmin DNS plugin. * **28.08.23:** - Add Namecheap DNS plugin. * **12.08.23:** - Add FreeDNS plugin. Detect certbot DNS authenticators using CLI. * **07.08.23:** - Add Bunny DNS Configuration. From 0b3cf40960f4c4a12704cfda0fafdc0b63268b40 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 2 Oct 2023 02:49:41 +0000 Subject: [PATCH 38/38] Bump mkdocs-material from 9.4.1 to 9.4.2 Bumps [mkdocs-material](https://github.com/squidfunk/mkdocs-material) from 9.4.1 to 9.4.2. - [Release notes](https://github.com/squidfunk/mkdocs-material/releases) - [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG) - [Commits](https://github.com/squidfunk/mkdocs-material/compare/9.4.1...9.4.2) --- updated-dependencies: - dependency-name: mkdocs-material dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 794defa2cb..a3ff38d809 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,5 +1,5 @@ mkdocs-awesome-pages-plugin==2.9.2 mkdocs-git-revision-date-localized-plugin==1.2.0 -mkdocs-material==9.4.1 +mkdocs-material==9.4.2 mkdocs-minify-plugin==0.7.1 mkdocs-redirects==1.2.1