Search…
Images
Powered By GitBook
linuxserver/netbox
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.

Supported Architectures

Our images support multiple architectures such as x86-64, arm64 and armhf. We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
Simply pulling lscr.io/linuxserver/netbox 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
Tag
x86-64
amd64-latest
arm64
arm64v8-latest
armhf
arm32v7-latest

Application Setup

Netbox requires a postgres database and a redis instance.
Access the WebUI at :8000. For more information, check out NetBox.

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.
1
---
2
version: "2.1"
3
services:
4
netbox:
5
image: lscr.io/linuxserver/netbox
6
container_name: netbox
7
environment:
8
- PUID=1000
9
- PGID=1000
10
- TZ=<TZ>
11
- SUPERUSER_EMAIL=<SUPERUSER_EMAIL>
12
- SUPERUSER_PASSWORD=<SUPERUSER_PASSWORD>
13
- ALLOWED_HOST=<ALLOWED_HOST>
14
- DB_NAME=<DB_NAME>
15
- DB_USER=<DB_USER>
16
- DB_PASSWORD=<DB_PASSWORD>
17
- DB_HOST=<DB_HOST>
18
- DB_PORT=<DB_PORT>
19
- REDIS_HOST=<REDIS_HOST>
20
- REDIS_PORT=<REDIS_PORT>
21
- REDIS_PASSWORD=<REDIS_PASSWORD>
22
- REDIS_DB_TASK=<REDIS_DB_TASK>
23
- REDIS_DB_CACHE=<REDIS_DB_CACHE>
24
- BASE_PATH=<BASE_PATH> #optional
25
- REMOTE_AUTH_ENABLED=<REMOTE_AUTH_ENABLED> #optional
26
- REMOTE_AUTH_BACKEND=<REMOTE_AUTH_BACKEND> #optional
27
- REMOTE_AUTH_HEADER=<REMOTE_AUTH_HEADER> #optional
28
- REMOTE_AUTH_AUTO_CREATE_USER=<REMOTE_AUTH_AUTO_CREATE_USER> #optional
29
- REMOTE_AUTH_DEFAULT_GROUPS=<REMOTE_AUTH_DEFAULT_GROUPS> #optional
30
- REMOTE_AUTH_DEFAULT_PERMISSIONS=<REMOTE_AUTH_DEFAULT_PERMISSIONS> #optional
31
volumes:
32
- <path to data on host>:/config
33
ports:
34
- 8000:8000
35
restart: unless-stopped
Copied!
1
docker run -d \
2
--name=netbox \
3
-e PUID=1000 \
4
-e PGID=1000 \
5
-e TZ=<TZ> \
6
-e SUPERUSER_EMAIL=<SUPERUSER_EMAIL> \
7
-e SUPERUSER_PASSWORD=<SUPERUSER_PASSWORD> \
8
-e ALLOWED_HOST=<ALLOWED_HOST> \
9
-e DB_NAME=<DB_NAME> \
10
-e DB_USER=<DB_USER> \
11
-e DB_PASSWORD=<DB_PASSWORD> \
12
-e DB_HOST=<DB_HOST> \
13
-e DB_PORT=<DB_PORT> \
14
-e REDIS_HOST=<REDIS_HOST> \
15
-e REDIS_PORT=<REDIS_PORT> \
16
-e REDIS_PASSWORD=<REDIS_PASSWORD> \
17
-e REDIS_DB_TASK=<REDIS_DB_TASK> \
18
-e REDIS_DB_CACHE=<REDIS_DB_CACHE> \
19
-e BASE_PATH=<BASE_PATH> `#optional` \
20
-e REMOTE_AUTH_ENABLED=<REMOTE_AUTH_ENABLED> `#optional` \
21
-e REMOTE_AUTH_BACKEND=<REMOTE_AUTH_BACKEND> `#optional` \
22
-e REMOTE_AUTH_HEADER=<REMOTE_AUTH_HEADER> `#optional` \
23
-e REMOTE_AUTH_AUTO_CREATE_USER=<REMOTE_AUTH_AUTO_CREATE_USER> `#optional` \
24
-e REMOTE_AUTH_DEFAULT_GROUPS=<REMOTE_AUTH_DEFAULT_GROUPS> `#optional` \
25
-e REMOTE_AUTH_DEFAULT_PERMISSIONS=<REMOTE_AUTH_DEFAULT_PERMISSIONS> `#optional` \
26
-p 8000:8000 \
27
-v <path to data on host>:/config \
28
--restart unless-stopped \
29
lscr.io/linuxserver/netbox
Copied!

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
8000
will map the container's port 8000 to port 8000 on the host

Environment Variables (-e)

Env
Function
PUID=1000
for UserID - see below for explanation
PGID=1000
for GroupID - see below for explanation
TZ=<TZ>
Timezone (i.e., America/New_York)
SUPERUSER_EMAIL=<SUPERUSER_EMAIL>
Email address for admin account
SUPERUSER_PASSWORD=<SUPERUSER_PASSWORD>
Password for admin account
ALLOWED_HOST=<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_USER=<DB_USER>
Database user
DB_PASSWORD=<DB_PASSWORD>
Database password
DB_HOST=<DB_HOST>
Database host (default: postgres)
DB_PORT=<DB_PORT>
Database port (defaul: 5432)
REDIS_HOST=<REDIS_HOST>
Redis host (default: redis)
REDIS_PORT=<REDIS_PORT>
Redis port number (default: 6379)
REDIS_PASSWORD=<REDIS_PASSWORD>
Redis password (default: none)
REDIS_DB_TASK=<REDIS_DB_TASK>
Redis database ID for tasks (default: 0)
REDIS_DB_CACHE=<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)
REMOTE_AUTH_ENABLED=<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_HEADER=<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_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_PERMISSIONS=<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
Function
/config
config directory volume mapping

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:
1
-e FILE__PASSWORD=/run/secrets/mysecretpassword
Copied!
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 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:
1
$ id username
2
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
Copied!

Docker Mods

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.

Support Info

    Shell access whilst the container is running:
      docker exec -it netbox /bin/bash
    To monitor the logs of the container in realtime:
      docker logs -f netbox
    Container version number
      docker inspect -f '{{ index .Config.Labels "build_version" }}' netbox
    Image version number
      docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/netbox

Versions

    26.04.21: - Added Redis database environment variables.
    03.02.21: - Added remote authentication environment variables.
    02.01.21: - Added BASE_PATH environment variable.
    23.08.20: - Initial Release.
Last modified 23d ago