netbox-docker/README.md

netbox-docker

The Github repository houses the components needed to build Netbox as a Docker container. Images are built using this code and are released to Docker Hub once a day.

Do you have any questions? Before opening an issue on Github, please join the Network To Code Slack and ask for help in our #netbox-docker channel.

Docker Tags

• vX.Y.Z: Release builds, built from releases of Netbox.
• latest: Release builds, built from master branch of Netbox.
• snapshot: Pre-release builds, built from the develop branch of Netbox.
• develop-X.Y: Pre-release builds, built from the corresponding branch of Netbox.

Then there is currently one extra tags for each of the above labels:

• -ldap: Contains additional dependencies and configurations for connecting Netbox to an LDAP directroy. Learn more about that in our wiki.

Quickstart

To get Netbox up and running in Docker:

git clone -b release https://github.com/netbox-community/netbox-docker.git
cd netbox-docker
docker-compose pull
docker-compose up -d

The application will be available after a few minutes. Use docker-compose port nginx 8080 to find out where to connect to.

$ echo "http://$(docker-compose port nginx 8080)/"
http://0.0.0.0:32768/

# Open netbox in your default browser on macOS:
$ open "http://$(docker-compose port nginx 8080)/"

# Open netbox in your default browser on (most) linuxes:
$ xdg-open "http://$(docker-compose port nginx 8080)/" &>/dev/null &

Alternatively, use something like Reception to connect to docker-compose projects.

The default credentials are:

• Username: admin
• Password: admin
• API Token: 0123456789abcdef0123456789abcdef01234567

There is a more complete Getting Started guide on our Wiki.

Dependencies

This project relies only on Docker and docker-compose meeting these requirements:

• The Docker version must be at least 17.05.
• The docker-compose version must be at least 1.17.0.

To check the version installed on your system run docker --version and docker-compose --version.

Documentation

Please refer to our wiki on Github for further information on how to use this Netbox Docker image properly. It covers advanced topics such as using secret files, deployment to Kubernetes as well as NAPALM and LDAP configuration.

Netbox Version

The docker-compose.yml file is prepared to run a specific version of Netbox. To use this feature, set the environment-variable VERSION before launching docker-compose, as shown below. VERSION may be set to the name of any tag of the netboxcommunity/netbox Docker image on Docker Hub.

export VERSION=v2.7.1
docker-compose pull netbox
docker-compose up -d

You can also build a specific version of the Netbox Docker image yourself. VERSION can be any valid git ref in that case.

export VERSION=v2.7.1
./build.sh $VERSION
docker-compose up -d

Breaking Changes

From time to time it might become necessary to re-engineer the structure of this setup. Things like the docker-compose.yml file or your Kubernetes or OpenShift configurations have to be adjusted as a consequence.

Since November 2019 each image built from this repo contains a org.opencontainers.image.version label. (The images contained labels since April 2018, although in November 2019 the labels' names changed.) You can check the label of your local image by running docker inspect netboxcommunity/netbox:v2.7.1 --format "{{json .Config.Labels}}".

Please read the release notes carefully when updating to a new image version.

Rebuilding the Image

./build.sh can be used to rebuild the Docker image. See ./build.sh --help for more information.

For more details on custom builds consult our wiki.

Pre-made Docker Images

New Docker images are built and published every 24h.

Tests

We have a test script. It runs Netbox's own unit tests and ensures that all initializers work:

IMAGE=netboxcommunity/netbox:latest ./test.sh

About

This repository is currently maintained and funded by nxt.