Skip to content

Commit e5afa2a

Browse files
LinuxServer-CILinuxServer-CI
committed
Bot Updating Documentation
1 parent 98d69cd commit e5afa2a

File tree

1 file changed

+20
-19
lines changed

1 file changed

+20
-19
lines changed

‎docs/images/docker-netbox.md‎

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ description: "[Netbox](https://github.com/netbox-community/netbox) is an IP addr
1818
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/netbox.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/netbox)
1919
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/netbox.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/netbox)
2020
[![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-netbox%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-netbox/job/master/)
21-
[![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%2Fnetbox%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/netbox/latest/index.html)
2221

2322
[Netbox](https://github.com/netbox-community/netbox) is an IP address management (IPAM) and data center infrastructure management (DCIM) tool. Initially conceived by the network engineering team at DigitalOcean, NetBox was developed specifically to address the needs of network and infrastructure engineers. It is intended to function as a domain-specific source of truth for network operations.
2423

@@ -73,10 +72,12 @@ services:
7372
- DB_PORT=
7473
- REDIS_HOST=
7574
- REDIS_PORT=
75+
- REDIS_USERNAME=
7676
- REDIS_PASSWORD=
7777
- REDIS_DB_TASK=
7878
- REDIS_DB_CACHE=
7979
- BASE_PATH= #optional
80+
- CSRF_TRUSTED_ORIGINS= #optional
8081
- REMOTE_AUTH_ENABLED= #optional
8182
- REMOTE_AUTH_BACKEND= #optional
8283
- REMOTE_AUTH_HEADER= #optional
@@ -108,10 +109,12 @@ docker run -d \
108109
-e DB_PORT= \
109110
-e REDIS_HOST= \
110111
-e REDIS_PORT= \
112+
-e REDIS_USERNAME= \
111113
-e REDIS_PASSWORD= \
112114
-e REDIS_DB_TASK= \
113115
-e REDIS_DB_CACHE= \
114116
-e BASE_PATH= `#optional` \
117+
-e CSRF_TRUSTED_ORIGINS= `#optional` \
115118
-e REMOTE_AUTH_ENABLED= `#optional` \
116119
-e REMOTE_AUTH_BACKEND= `#optional` \
117120
-e REMOTE_AUTH_HEADER= `#optional` \
@@ -143,24 +146,26 @@ Containers are configured using parameters passed at runtime (such as those abov
143146
| `TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
144147
| `SUPERUSER_EMAIL=` | Email address for `admin` account |
145148
| `SUPERUSER_PASSWORD=` | Password for `admin` account |
146-
| `ALLOWED_HOST=` | The hostname you will use to access the app (i.e., netbox.example.com) |
149+
| `ALLOWED_HOST=` | The hostname you will use to access the app (e.g., netbox.example.com) |
147150
| `DB_NAME=` | Database name (default: netbox) |
148151
| `DB_USER=` | Database user |
149152
| `DB_PASSWORD=` | Database password |
150153
| `DB_HOST=` | Database host (default: postgres) |
151154
| `DB_PORT=` | Database port (default: 5432) |
152155
| `REDIS_HOST=` | Redis host (default: redis) |
153156
| `REDIS_PORT=` | Redis port number (default: 6379) |
157+
| `REDIS_USERNAME=` | Redis username (default: none) |
154158
| `REDIS_PASSWORD=` | Redis password (default: none) |
155159
| `REDIS_DB_TASK=` | Redis database ID for tasks (default: 0) |
156160
| `REDIS_DB_CACHE=` | Redis database ID for caching (default: 1) |
157-
| `BASE_PATH=` | The path you will use to access the app (i.e., /netbox, optional, default: none) |
158-
| `REMOTE_AUTH_ENABLED=` | Enable remote authentication (optional, default: False) |
159-
| `REMOTE_AUTH_BACKEND=` | Python path to the custom Django authentication backend to use for external user authentication (optional, default: netbox.authentication.RemoteUserBackend) |
160-
| `REMOTE_AUTH_HEADER=` | Name of the HTTP header which informs NetBox of the currently authenticated user. (optional, default: HTTP_REMOTE_USER) |
161-
| `REMOTE_AUTH_AUTO_CREATE_USER=` | If true, NetBox will automatically create local accounts for users authenticated via a remote service (optional, default: False) |
162-
| `REMOTE_AUTH_DEFAULT_GROUPS=` | The list of groups to assign a new user account when created using remote authentication (optional, default: []) |
163-
| `REMOTE_AUTH_DEFAULT_PERMISSIONS=` | A mapping of permissions to assign a new user account when created using remote authentication (optional, default: {}) |
161+
| `BASE_PATH=` | The path you will use to access the app (i.e., /netbox, default: none) |
162+
| `CSRF_TRUSTED_ORIGINS=` | List of comma-separated, single quoted, trusted origins. Must include protocol, and port if applicable (default: []) |
163+
| `REMOTE_AUTH_ENABLED=` | Enable remote authentication (default: False) |
164+
| `REMOTE_AUTH_BACKEND=` | Python path to the custom Django authentication backend to use for external user authentication (default: netbox.authentication.RemoteUserBackend) |
165+
| `REMOTE_AUTH_HEADER=` | Name of the HTTP header which informs NetBox of the currently authenticated user. (default: HTTP_REMOTE_USER) |
166+
| `REMOTE_AUTH_AUTO_CREATE_USER=` | If true, NetBox will automatically create local accounts for users authenticated via a remote service (default: False) |
167+
| `REMOTE_AUTH_DEFAULT_GROUPS=` | The list of groups to assign a new user account when created using remote authentication (default: []) |
168+
| `REMOTE_AUTH_DEFAULT_PERMISSIONS=` | A mapping of permissions to assign a new user account when created using remote authentication (default: {}) |
164169

165170
### Volume Mappings (`-v`)
166171

@@ -354,40 +359,36 @@ To help with development, we generate this dependency graph.
354359
init-migrations -> init-adduser
355360
init-os-end -> init-config
356361
init-config -> init-config-end
362+
init-crontab-config -> init-config-end
357363
init-netbox-config -> init-config-end
358-
init-os-end -> init-crontab-config
364+
init-config -> init-crontab-config
359365
init-mods-end -> init-custom-files
360366
init-adduser -> init-device-perms
361367
base -> init-envfile
362368
base -> init-migrations
363-
base -> init-mods
364369
init-config-end -> init-mods
365-
init-mods -> init-mods-end
366370
init-mods-package-install -> init-mods-end
367371
init-mods -> init-mods-package-install
368372
init-config -> init-netbox-config
369-
base -> init-os-end
373+
init-mods-end -> init-netbox-prepare
370374
init-adduser -> init-os-end
371375
init-device-perms -> init-os-end
372376
init-envfile -> init-os-end
373-
init-migrations -> init-os-end
374377
init-custom-files -> init-services
375-
init-mods-end -> init-services
376378
init-services -> svc-cron
377379
svc-cron -> legacy-services
378-
svc-netbox-prepare -> svc-netbox
380+
init-netbox-prepare -> svc-netbox
379381
svc-netbox -> legacy-services
380-
init-services -> svc-netbox-prepare
381-
svc-netbox-prepare -> legacy-services
382382
}
383383
Base Images: {
384-
"baseimage-alpine:3.20"
384+
"baseimage-alpine:3.23"
385385
}
386386
"netbox:latest" <- Base Images
387387
```
388388

389389
## Versions
390390

391+
* **05.01.26:** - Rebase to Alpine 3.23. Add CSRF_TRUSTED_ORIGINS env settings. Drop support for environments with explicitly disabled IPv6.
391392
* **26.08.24:** - Restructure init to allow for plugins as mods.
392393
* **16.07.24:** - Add required packages for LDAP support.
393394
* **01.06.24:** - Rebase to Alpine 3.20.

0 commit comments

Comments
 (0)