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 and Quay.io once a day.

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

Docker Tags

• vX.Y.Z: These are release builds, automatically built from the corresponding releases of NetBox.
• latest: These are release builds, automatically built from the master branch of NetBox.
• snapshot: These are pre-release builds, automatically built from the develop branch of NetBox.
• develop-X.Y: These are pre-release builds, automatically built from the corresponding branch of NetBox.

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

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

New images are built and published automatically every ~24h.

Quickstart

To get NetBox Docker up and running run the following commands. There is a more complete Getting Started guide on our wiki which explains every step.

git clone -b release https://github.com/netbox-community/netbox-docker.git
cd netbox-docker
tee docker-compose.override.yml <<EOF
version: '3.4'
services:
  netbox:
    ports:
      - 8000:8080
EOF
docker-compose pull
docker-compose up

The whole application will be available after a few minutes. Open the URL http://0.0.0.0:8000/ in a web-browser. You should see the NetBox homepage. In the top-right corner you can login. The default credentials are:

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

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 files for secrets, deployment to Kubernetes, monitoring and configuring NAPALM or LDAP.

Getting Help

Feel free to ask questions in our Github Community or join our Slack and ask in our channel #netbox-docker, which is free to use and where there are almost always people online that can help you in the Slack channel.

If you need help with using NetBox or developing for it or against it's API you may find the #netbox channel on the same Slack instance very helpful.

Dependencies

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

• The Docker version must be at least 19.03.
• The docker-compose version must be at least 1.28.0.

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

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.

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.