Bot Updating Documentation

pull/95/head
LinuxServer-CI 2023-03-10 19:23:20 +01:00
rodzic 2d23e74df8
commit dc40dd0395
1 zmienionych plików z 63 dodań i 62 usunięć

Wyświetl plik

@ -56,28 +56,28 @@ services:
- PUID=1000 - PUID=1000
- PGID=1000 - PGID=1000
- TZ=Etc/UTC - TZ=Etc/UTC
- SUPERUSER_EMAIL=<SUPERUSER_EMAIL> - SUPERUSER_EMAIL=
- SUPERUSER_PASSWORD=<SUPERUSER_PASSWORD> - SUPERUSER_PASSWORD=
- ALLOWED_HOST=<ALLOWED_HOST> - ALLOWED_HOST=
- DB_NAME=<DB_NAME> - DB_NAME=
- DB_USER=<DB_USER> - DB_USER=
- DB_PASSWORD=<DB_PASSWORD> - DB_PASSWORD=
- DB_HOST=<DB_HOST> - DB_HOST=
- DB_PORT=<DB_PORT> - DB_PORT=
- REDIS_HOST=<REDIS_HOST> - REDIS_HOST=
- REDIS_PORT=<REDIS_PORT> - REDIS_PORT=
- REDIS_PASSWORD=<REDIS_PASSWORD> - REDIS_PASSWORD=
- REDIS_DB_TASK=<REDIS_DB_TASK> - REDIS_DB_TASK=
- REDIS_DB_CACHE=<REDIS_DB_CACHE> - REDIS_DB_CACHE=
- BASE_PATH=<BASE_PATH> #optional - BASE_PATH= #optional
- REMOTE_AUTH_ENABLED=<REMOTE_AUTH_ENABLED> #optional - REMOTE_AUTH_ENABLED= #optional
- REMOTE_AUTH_BACKEND=<REMOTE_AUTH_BACKEND> #optional - REMOTE_AUTH_BACKEND= #optional
- REMOTE_AUTH_HEADER=<REMOTE_AUTH_HEADER> #optional - REMOTE_AUTH_HEADER= #optional
- REMOTE_AUTH_AUTO_CREATE_USER=<REMOTE_AUTH_AUTO_CREATE_USER> #optional - REMOTE_AUTH_AUTO_CREATE_USER= #optional
- REMOTE_AUTH_DEFAULT_GROUPS=<REMOTE_AUTH_DEFAULT_GROUPS> #optional - REMOTE_AUTH_DEFAULT_GROUPS= #optional
- REMOTE_AUTH_DEFAULT_PERMISSIONS=<REMOTE_AUTH_DEFAULT_PERMISSIONS> #optional - REMOTE_AUTH_DEFAULT_PERMISSIONS= #optional
volumes: volumes:
- <path to data on host>:/config - /path/to/data:/config
ports: ports:
- 8000:8000 - 8000:8000
restart: unless-stopped restart: unless-stopped
@ -91,28 +91,28 @@ docker run -d \
-e PUID=1000 \ -e PUID=1000 \
-e PGID=1000 \ -e PGID=1000 \
-e TZ=Etc/UTC \ -e TZ=Etc/UTC \
-e SUPERUSER_EMAIL=<SUPERUSER_EMAIL> \ -e SUPERUSER_EMAIL= \
-e SUPERUSER_PASSWORD=<SUPERUSER_PASSWORD> \ -e SUPERUSER_PASSWORD= \
-e ALLOWED_HOST=<ALLOWED_HOST> \ -e ALLOWED_HOST= \
-e DB_NAME=<DB_NAME> \ -e DB_NAME= \
-e DB_USER=<DB_USER> \ -e DB_USER= \
-e DB_PASSWORD=<DB_PASSWORD> \ -e DB_PASSWORD= \
-e DB_HOST=<DB_HOST> \ -e DB_HOST= \
-e DB_PORT=<DB_PORT> \ -e DB_PORT= \
-e REDIS_HOST=<REDIS_HOST> \ -e REDIS_HOST= \
-e REDIS_PORT=<REDIS_PORT> \ -e REDIS_PORT= \
-e REDIS_PASSWORD=<REDIS_PASSWORD> \ -e REDIS_PASSWORD= \
-e REDIS_DB_TASK=<REDIS_DB_TASK> \ -e REDIS_DB_TASK= \
-e REDIS_DB_CACHE=<REDIS_DB_CACHE> \ -e REDIS_DB_CACHE= \
-e BASE_PATH=<BASE_PATH> `#optional` \ -e BASE_PATH= `#optional` \
-e REMOTE_AUTH_ENABLED=<REMOTE_AUTH_ENABLED> `#optional` \ -e REMOTE_AUTH_ENABLED= `#optional` \
-e REMOTE_AUTH_BACKEND=<REMOTE_AUTH_BACKEND> `#optional` \ -e REMOTE_AUTH_BACKEND= `#optional` \
-e REMOTE_AUTH_HEADER=<REMOTE_AUTH_HEADER> `#optional` \ -e REMOTE_AUTH_HEADER= `#optional` \
-e REMOTE_AUTH_AUTO_CREATE_USER=<REMOTE_AUTH_AUTO_CREATE_USER> `#optional` \ -e REMOTE_AUTH_AUTO_CREATE_USER= `#optional` \
-e REMOTE_AUTH_DEFAULT_GROUPS=<REMOTE_AUTH_DEFAULT_GROUPS> `#optional` \ -e REMOTE_AUTH_DEFAULT_GROUPS= `#optional` \
-e REMOTE_AUTH_DEFAULT_PERMISSIONS=<REMOTE_AUTH_DEFAULT_PERMISSIONS> `#optional` \ -e REMOTE_AUTH_DEFAULT_PERMISSIONS= `#optional` \
-p 8000:8000 \ -p 8000:8000 \
-v <path to data on host>:/config \ -v /path/to/data:/config \
--restart unless-stopped \ --restart unless-stopped \
lscr.io/linuxserver/netbox:latest lscr.io/linuxserver/netbox:latest
@ -135,26 +135,26 @@ Docker images are configured using parameters passed at runtime (such as those a
| `PUID=1000` | for UserID - see below for explanation | | `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - 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). | | `TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
| `SUPERUSER_EMAIL=<SUPERUSER_EMAIL>` | Email address for `admin` account | | `SUPERUSER_EMAIL=` | Email address for `admin` account |
| `SUPERUSER_PASSWORD=<SUPERUSER_PASSWORD>` | Password for `admin` account | | `SUPERUSER_PASSWORD=` | Password for `admin` account |
| `ALLOWED_HOST=<ALLOWED_HOST>` | The hostname you will use to access the app (i.e., netbox.example.com) | | `ALLOWED_HOST=` | The hostname you will use to access the app (i.e., netbox.example.com) |
| `DB_NAME=<DB_NAME>` | Database name (default: netbox) | | `DB_NAME=` | Database name (default: netbox) |
| `DB_USER=<DB_USER>` | Database user | | `DB_USER=` | Database user |
| `DB_PASSWORD=<DB_PASSWORD>` | Database password | | `DB_PASSWORD=` | Database password |
| `DB_HOST=<DB_HOST>` | Database host (default: postgres) | | `DB_HOST=` | Database host (default: postgres) |
| `DB_PORT=<DB_PORT>` | Database port (defaul: 5432) | | `DB_PORT=` | Database port (defaul: 5432) |
| `REDIS_HOST=<REDIS_HOST>` | Redis host (default: redis) | | `REDIS_HOST=` | Redis host (default: redis) |
| `REDIS_PORT=<REDIS_PORT>` | Redis port number (default: 6379) | | `REDIS_PORT=` | Redis port number (default: 6379) |
| `REDIS_PASSWORD=<REDIS_PASSWORD>` | Redis password (default: none) | | `REDIS_PASSWORD=` | Redis password (default: none) |
| `REDIS_DB_TASK=<REDIS_DB_TASK>` | Redis database ID for tasks (default: 0) | | `REDIS_DB_TASK=` | Redis database ID for tasks (default: 0) |
| `REDIS_DB_CACHE=<REDIS_DB_CACHE>` | Redis database ID for caching (default: 1) | | `REDIS_DB_CACHE=` | Redis database ID for caching (default: 1) |
| `BASE_PATH=<BASE_PATH>` | The path you will use to access the app (i.e., /netbox, optional, default: none) | | `BASE_PATH=` | The path you will use to access the app (i.e., /netbox, optional, default: none) |
| `REMOTE_AUTH_ENABLED=<REMOTE_AUTH_ENABLED>` | Enable remote authentication (optional, default: False) | | `REMOTE_AUTH_ENABLED=` | Enable remote authentication (optional, default: False) |
| `REMOTE_AUTH_BACKEND=<REMOTE_AUTH_BACKEND>` | Python path to the custom Django authentication backend to use for external user authentication (optional, default: netbox.authentication.RemoteUserBackend) | | `REMOTE_AUTH_BACKEND=` | Python path to the custom Django authentication backend to use for external user authentication (optional, default: netbox.authentication.RemoteUserBackend) |
| `REMOTE_AUTH_HEADER=<REMOTE_AUTH_HEADER>` | Name of the HTTP header which informs NetBox of the currently authenticated user. (optional, default: HTTP_REMOTE_USER) | | `REMOTE_AUTH_HEADER=` | Name of the HTTP header which informs NetBox of the currently authenticated user. (optional, default: HTTP_REMOTE_USER) |
| `REMOTE_AUTH_AUTO_CREATE_USER=<REMOTE_AUTH_AUTO_CREATE_USER>` | If true, NetBox will automatically create local accounts for users authenticated via a remote service (optional, default: False) | | `REMOTE_AUTH_AUTO_CREATE_USER=` | If true, NetBox will automatically create local accounts for users authenticated via a remote service (optional, default: False) |
| `REMOTE_AUTH_DEFAULT_GROUPS=<REMOTE_AUTH_DEFAULT_GROUPS>` | The list of groups to assign a new user account when created using remote authentication (optional, default: []) | | `REMOTE_AUTH_DEFAULT_GROUPS=` | The list of groups to assign a new user account when created using remote authentication (optional, default: []) |
| `REMOTE_AUTH_DEFAULT_PERMISSIONS=<REMOTE_AUTH_DEFAULT_PERMISSIONS>` | A mapping of permissions to assign a new user account when created using remote authentication (optional, default: {}) | | `REMOTE_AUTH_DEFAULT_PERMISSIONS=` | A mapping of permissions to assign a new user account when created using remote authentication (optional, default: {}) |
### Volume Mappings (`-v`) ### Volume Mappings (`-v`)
@ -216,6 +216,7 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
## Versions ## Versions
* **05.03.23:** - Rebase to Alpine 3.17.
* **02.11.22:** - Rebase to Alpine 3.16, migrate to s6v3. * **02.11.22:** - Rebase to Alpine 3.16, migrate to s6v3.
* **01.08.22:** - Remove py3-pillow, add tiff to fix deps. * **01.08.22:** - Remove py3-pillow, add tiff to fix deps.
* **26.07.22:** - Add py3-pillow package back on arm to fix build issue. * **26.07.22:** - Add py3-pillow package back on arm to fix build issue.