kopia lustrzana https://github.com/linuxserver/docker-documentation
Merge branch 'master' of github.com:linuxserver/docker-documentation into mkdocs-monthly
Signed-off-by: Eric Nemchik <eric@nemchik.com>pull/140/head
Eric Nemchik
commit
efa2668288
|
|
@ -8,11 +8,11 @@ jobs:
|
|||
name: Build docs
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v3.5.3
|
||||
- uses: actions/checkout@v4.1.0
|
||||
- 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
|
||||
|
|
@ -25,13 +25,13 @@ jobs:
|
|||
name: Deploy docs
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v3.5.3
|
||||
- uses: actions/checkout@v4.1.0
|
||||
with:
|
||||
fetch-depth: '0'
|
||||
- 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
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ jobs:
|
|||
summary-syncer:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v3.5.3
|
||||
- uses: actions/checkout@v4.1.0
|
||||
with:
|
||||
fetch-depth: "0"
|
||||
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
|
|
@ -156,6 +157,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)
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
|
|
|
|||
|
|
@ -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=<yourbaseurl> \
|
||||
-e DB_HOST=<yourdbhost> \
|
||||
-e DB_PORT=<yourdbport> \
|
||||
-e DB_USER=<yourdbuser> \
|
||||
-e DB_PASS=<yourdbpass> \
|
||||
-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=<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.) |
|
||||
| `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`)
|
||||
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -4,6 +4,10 @@ title: gmail-order-bot
|
|||
<!-- DO NOT EDIT THIS FILE MANUALLY -->
|
||||
<!-- Please read the https://github.com/lsiodev/docker-gmail-order-bot/blob/master/.github/CONTRIBUTING.md -->
|
||||
|
||||
# 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)
|
||||
|
||||
[](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-\<version tag\> |
|
||||
| arm64 | ✅ | arm64v8-\<version tag\> |
|
||||
| armhf| ✅ | arm32v7-\<version tag\> |
|
||||
| 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.
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -65,7 +65,13 @@ 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.
|
||||
|
||||
### 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
|
||||
|
||||
|
|
@ -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`)
|
||||
|
||||
|
|
@ -290,6 +299,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).
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -0,0 +1,192 @@
|
|||
---
|
||||
title: series-troxide
|
||||
---
|
||||
<!-- DO NOT EDIT THIS FILE MANUALLY -->
|
||||
<!-- Please read the https://github.com/linuxserver/docker-series-troxide/blob/master/.github/CONTRIBUTING.md -->
|
||||
|
||||
# [linuxserver/series-troxide](https://github.com/linuxserver/docker-series-troxide)
|
||||
|
||||
[](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Fseries-troxide)
|
||||
[](https://github.com/linuxserver/docker-series-troxide)
|
||||
[](https://github.com/linuxserver/docker-series-troxide/releases)
|
||||
[](https://github.com/linuxserver/docker-series-troxide/packages)
|
||||
[](https://gitlab.com/linuxserver.io/docker-series-troxide/container_registry)
|
||||
[](https://quay.io/repository/linuxserver.io/series-troxide)
|
||||
[](https://hub.docker.com/r/linuxserver/series-troxide)
|
||||
[](https://hub.docker.com/r/linuxserver/series-troxide)
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-series-troxide/job/master/)
|
||||
[](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-\<version tag\> |
|
||||
| arm64 | ✅ | arm64v8-\<version tag\> |
|
||||
| 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 `<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 |
|
||||
| :----: | --- |
|
||||
| `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
|
||||
|
||||
[](https://mods.linuxserver.io/?mod=series-troxide "view available mods for this container.") [](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.
|
||||
|
|
@ -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,8 @@ 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.
|
||||
* **27.07.23:** - Added support for dreamhost validation.
|
||||
|
|
|
|||
|
|
@ -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).
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
||||
```
|
||||
|
|
@ -212,6 +216,8 @@ 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.
|
||||
* **10.03.23:** - Test writing to /run/unifi and symlink to /config/run if it fails.
|
||||
|
|
|
|||
|
|
@ -0,0 +1,267 @@
|
|||
---
|
||||
title: unifi-network-application
|
||||
---
|
||||
<!-- DO NOT EDIT THIS FILE MANUALLY -->
|
||||
<!-- Please read the https://github.com/linuxserver/docker-unifi-network-application/blob/main/.github/CONTRIBUTING.md -->
|
||||
|
||||
# [linuxserver/unifi-network-application](https://github.com/linuxserver/docker-unifi-network-application)
|
||||
|
||||
[](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Funifi-network-application)
|
||||
[](https://github.com/linuxserver/docker-unifi-network-application)
|
||||
[](https://github.com/linuxserver/docker-unifi-network-application/releases)
|
||||
[](https://github.com/linuxserver/docker-unifi-network-application/packages)
|
||||
[](https://gitlab.com/linuxserver.io/docker-unifi-network-application/container_registry)
|
||||
[](https://quay.io/repository/linuxserver.io/unifi-network-application)
|
||||
[](https://hub.docker.com/r/linuxserver/unifi-network-application)
|
||||
[](https://hub.docker.com/r/linuxserver/unifi-network-application)
|
||||
[](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-\<version tag\> |
|
||||
| arm64 | ✅ | arm64v8-\<version tag\> |
|
||||
| armhf | ❌ | |
|
||||
|
||||
## Application Setup
|
||||
|
||||
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.
|
||||
|
||||
**This container requires an external mongodb database instance.**
|
||||
|
||||
### 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.
|
||||
|
||||
**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 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: "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.
|
||||
|
||||
For example:
|
||||
|
||||
```yaml
|
||||
unifi-db:
|
||||
image: docker.io/mongo:<version tag>
|
||||
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`, `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).
|
||||
|
||||
### 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 `<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](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
|
||||
| `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. |
|
||||
| `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
|
||||
|
||||
[](https://mods.linuxserver.io/?mod=unifi-network-application "view available mods for this container.") [](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.
|
||||
|
|
@ -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)
|
||||
|
||||
|
|
|
|||
|
|
@ -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.4.2
|
||||
mkdocs-minify-plugin==0.7.1
|
||||
mkdocs-redirects==1.2.1
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue