docker-netbox/README.md

The LinuxServer.io team brings you another container release featuring:

• regular and timely application updates
• easy user mappings (PGID, PUID)
• custom base image with s6 overlay
• weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
• regular security updates

Find us at:

• Blog - all the things you can do with our containers including How-To guides, opinions and much more!
• Discord - realtime support / chat with the community and the team.
• Discourse - post on our community forum.
• Fleet - an online web interface which displays all of our maintained images.
• GitHub - view the source for all of our repositories.
• Open Collective - please consider helping us by either donating or contributing to our budget

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

Here are some example snippets to help you get started creating a container.

docker-compose (recommended, click here for more info)

---
version: "2.1"
services:
  netbox:
    image: lscr.io/linuxserver/netbox
    container_name: netbox
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=<TZ>
      - SUPERUSER_EMAIL=<SUPERUSER_EMAIL>
      - SUPERUSER_PASSWORD=<SUPERUSER_PASSWORD>
      - ALLOWED_HOST=<ALLOWED_HOST>
      - DB_NAME=<DB_NAME>
      - DB_USER=<DB_USER>
      - DB_PASSWORD=<DB_PASSWORD>
      - DB_HOST=<DB_HOST>
      - DB_PORT=<DB_PORT>
      - REDIS_HOST=<REDIS_HOST>
      - REDIS_PORT=<REDIS_PORT>
      - REDIS_PASSWORD=<REDIS_PASSWORD>
      - REDIS_DB_TASK=<REDIS_DB_TASK>
      - REDIS_DB_CACHE=<REDIS_DB_CACHE>
      - BASE_PATH=<BASE_PATH> #optional
      - REMOTE_AUTH_ENABLED=<REMOTE_AUTH_ENABLED> #optional
      - REMOTE_AUTH_BACKEND=<REMOTE_AUTH_BACKEND> #optional
      - REMOTE_AUTH_HEADER=<REMOTE_AUTH_HEADER> #optional
      - REMOTE_AUTH_AUTO_CREATE_USER=<REMOTE_AUTH_AUTO_CREATE_USER> #optional
      - REMOTE_AUTH_DEFAULT_GROUPS=<REMOTE_AUTH_DEFAULT_GROUPS> #optional
      - REMOTE_AUTH_DEFAULT_PERMISSIONS=<REMOTE_AUTH_DEFAULT_PERMISSIONS> #optional
    volumes:
      - <path to data on host>:/config
    ports:
      - 8000:8000
    restart: unless-stopped

docker cli (click here for more info)

docker run -d \
  --name=netbox \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=<TZ> \
  -e SUPERUSER_EMAIL=<SUPERUSER_EMAIL> \
  -e SUPERUSER_PASSWORD=<SUPERUSER_PASSWORD> \
  -e ALLOWED_HOST=<ALLOWED_HOST> \
  -e DB_NAME=<DB_NAME> \
  -e DB_USER=<DB_USER> \
  -e DB_PASSWORD=<DB_PASSWORD> \
  -e DB_HOST=<DB_HOST> \
  -e DB_PORT=<DB_PORT> \
  -e REDIS_HOST=<REDIS_HOST> \
  -e REDIS_PORT=<REDIS_PORT> \
  -e REDIS_PASSWORD=<REDIS_PASSWORD> \
  -e REDIS_DB_TASK=<REDIS_DB_TASK> \
  -e REDIS_DB_CACHE=<REDIS_DB_CACHE> \
  -e BASE_PATH=<BASE_PATH> `#optional` \
  -e REMOTE_AUTH_ENABLED=<REMOTE_AUTH_ENABLED> `#optional` \
  -e REMOTE_AUTH_BACKEND=<REMOTE_AUTH_BACKEND> `#optional` \
  -e REMOTE_AUTH_HEADER=<REMOTE_AUTH_HEADER> `#optional` \
  -e REMOTE_AUTH_AUTO_CREATE_USER=<REMOTE_AUTH_AUTO_CREATE_USER> `#optional` \
  -e REMOTE_AUTH_DEFAULT_GROUPS=<REMOTE_AUTH_DEFAULT_GROUPS> `#optional` \
  -e REMOTE_AUTH_DEFAULT_PERMISSIONS=<REMOTE_AUTH_DEFAULT_PERMISSIONS> `#optional` \
  -p 8000:8000 \
  -v <path to data on host>:/config \
  --restart unless-stopped \
  lscr.io/linuxserver/netbox

Parameters

Container 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.

Parameter	Function
-p 8000	will map the container's port 8000 to port 8000 on the host
-e PUID=1000	for UserID - see below for explanation
-e PGID=1000	for GroupID - see below for explanation
-e TZ=<TZ>	Timezone (i.e., America/New_York)
-e SUPERUSER_EMAIL=<SUPERUSER_EMAIL>	Email address for admin account
-e SUPERUSER_PASSWORD=<SUPERUSER_PASSWORD>	Password for admin account
-e ALLOWED_HOST=<ALLOWED_HOST>	The hostname you will use to access the app (i.e., netbox.example.com)
-e DB_NAME=<DB_NAME>	Database name (default: netbox)
-e DB_USER=<DB_USER>	Database user
-e DB_PASSWORD=<DB_PASSWORD>	Database password
-e DB_HOST=<DB_HOST>	Database host (default: postgres)
-e DB_PORT=<DB_PORT>	Database port (defaul: 5432)
-e REDIS_HOST=<REDIS_HOST>	Redis host (default: redis)
-e REDIS_PORT=<REDIS_PORT>	Redis port number (default: 6379)
-e REDIS_PASSWORD=<REDIS_PASSWORD>	Redis password (default: none)
-e REDIS_DB_TASK=<REDIS_DB_TASK>	Redis database ID for tasks (default: 0)
-e REDIS_DB_CACHE=<REDIS_DB_CACHE>	Redis database ID for caching (default: 1)
-e BASE_PATH=<BASE_PATH>	The path you will use to access the app (i.e., /netbox, optional, default: none)
-e REMOTE_AUTH_ENABLED=<REMOTE_AUTH_ENABLED>	Enable remote authentication (optional, default: False)
-e 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)
-e REMOTE_AUTH_HEADER=<REMOTE_AUTH_HEADER>	Name of the HTTP header which informs NetBox of the currently authenticated user. (optional, default: HTTP_REMOTE_USER)
-e 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)
-e 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: [])
-e 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: {})
-v /config	config directory volume mapping

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-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 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:

  $ id username
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

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

Updating Info

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.

Below are the instructions for updating containers:

Via Docker Compose

• Update all images: docker-compose pull
  • or update a single image: docker-compose pull netbox
• Let compose update all containers as necessary: docker-compose up -d
  • or update a single container: docker-compose up -d netbox
• You can also remove the old dangling images: docker image prune

Via Docker Run

• Update the image: docker pull lscr.io/linuxserver/netbox
• Stop the running container: docker stop netbox
• Delete the container: docker rm netbox
• Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)
• You can also remove the old dangling images: docker image prune

Via Watchtower auto-updater (only use if you don't remember the original parameters)

• Pull the latest image at its tag and replace it with the same env variables in one run:

  docker run --rm \
  -v /var/run/docker.sock:/var/run/docker.sock \
  containrrr/watchtower \
  --run-once netbox
  

• You can also remove the old dangling images: docker image prune

Note: We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, we highly recommend using Docker Compose.

Image Update Notifications - Diun (Docker Image Update Notifier)

• We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.

Building locally

If you want to make local modifications to these images for development purposes or just to customize the logic:

git clone https://github.com/linuxserver/docker-netbox.git
cd docker-netbox
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/netbox:latest .

The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static

docker run --rm --privileged multiarch/qemu-user-static:register --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

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.