Containers 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.
-p)¶| Parameter | Function |
|---|---|
8000 | will map the container's port 8000 to port 8000 on the host |
-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. |
SUPERUSER_EMAIL= | Email address for admin account |
SUPERUSER_PASSWORD= | Password for admin account |
ALLOWED_HOST= | The hostname you will use to access the app (i.e., netbox.example.com) |
DB_NAME= | Database name (default: netbox) |
DB_USER= | Database user |
DB_PASSWORD= | Database password |
DB_HOST= | Database host (default: postgres) |
DB_PORT= | Database port (defaul: 5432) |
REDIS_HOST= | Redis host (default: redis) |
REDIS_PORT= | Redis port number (default: 6379) |
REDIS_PASSWORD= | Redis password (default: none) |
REDIS_DB_TASK= | Redis database ID for tasks (default: 0) |
REDIS_DB_CACHE= | Redis database ID for caching (default: 1) |
BASE_PATH= | The path you will use to access the app (i.e., /netbox, optional, default: none) |
REMOTE_AUTH_ENABLED= | Enable remote authentication (optional, default: False) |
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= | Name of the HTTP header which informs NetBox of the currently authenticated user. (optional, default: HTTP_REMOTE_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_DEFAULT_GROUPS= | The list of groups 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: {}) |
-v)¶| Volume | Function |
|---|---|
/config | Persistent config files |
| Parameter | Function |
|---|---|
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
Containers 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.
-p)¶| Parameter | Function |
|---|---|
8000 | will map the container's port 8000 to port 8000 on the host |
-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. |
SUPERUSER_EMAIL= | Email address for admin account |
SUPERUSER_PASSWORD= | Password for admin account |
ALLOWED_HOST= | The hostname you will use to access the app (i.e., netbox.example.com) |
DB_NAME= | Database name (default: netbox) |
DB_USER= | Database user |
DB_PASSWORD= | Database password |
DB_HOST= | Database host (default: postgres) |
DB_PORT= | Database port (default: 5432) |
REDIS_HOST= | Redis host (default: redis) |
REDIS_PORT= | Redis port number (default: 6379) |
REDIS_PASSWORD= | Redis password (default: none) |
REDIS_DB_TASK= | Redis database ID for tasks (default: 0) |
REDIS_DB_CACHE= | Redis database ID for caching (default: 1) |
BASE_PATH= | The path you will use to access the app (i.e., /netbox, optional, default: none) |
REMOTE_AUTH_ENABLED= | Enable remote authentication (optional, default: False) |
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= | Name of the HTTP header which informs NetBox of the currently authenticated user. (optional, default: HTTP_REMOTE_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_DEFAULT_GROUPS= | The list of groups 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: {}) |
-v)¶| Volume | Function |
|---|---|
/config | Persistent config files |
| Parameter | Function |
|---|---|
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable file.
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 before asking for support.
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 your_user as below:
Example output:
We publish various 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.
Shell access whilst the container is running:
The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static
Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.