🐳 Docker Image of NetBox
Go to file
Christian Mäder ed6256172f
Merge pull request #394 from netbox-community/develop
Prepare version 1.0.0
2021-01-29 10:48:29 +01:00
.github Prevent "alpine:edge" from failling the workflow 2021-01-20 10:43:07 +01:00
build-functions Let "latest" tag follow the highest version 2020-04-09 08:17:05 +02:00
configuration Merge pull request #359 from devon-mar/login-timeout-fix 2020-11-13 15:36:16 +01:00
docker Gunicorn is replaced with nginx-unit 2021-01-15 09:22:22 +01:00
env Revert most changes 2020-10-26 15:22:56 +01:00
initializers remove site from power_feeds 2021-01-15 15:02:01 -05:00
reports Fixed devices.py.example report 2020-05-11 16:46:10 +03:00
scripts Add support for custom scripts 2019-10-14 09:50:05 +02:00
startup_scripts rebase and fix script order 2021-01-20 09:03:04 +01:00
.dockerignore inlude docs in container 2020-03-11 10:40:10 +00:00
.gitignore Ignore prometheus.yml 2020-10-26 15:40:22 +01:00
Dockerfile Gunicorn is replaced with nginx-unit 2021-01-15 09:22:22 +01:00
LICENSE add license 2018-06-22 16:27:45 +02:00
README.md Gunicorn is replaced with nginx-unit 2021-01-15 09:22:22 +01:00
VERSION Prepare for Version 1.0.0 2021-01-28 10:22:48 +01:00
build-latest.sh Fix failing GH Action 2020-01-17 18:46:30 +01:00
build-next.sh Fixed script in case no branch for next exists 2020-04-13 21:44:18 +02:00
build.sh Gunicorn is replaced with nginx-unit 2021-01-15 09:22:22 +01:00
docker-compose.test.yml Skip Startup Scripts in Unit Tests 2021-01-20 09:36:13 +01:00
docker-compose.yml Gunicorn is replaced with nginx-unit 2021-01-15 09:22:22 +01:00
renovate.json Configure Renovate 2021-01-20 08:24:47 +01:00
requirements-container.txt Update of ruamel.yaml 2021-01-20 09:50:00 +01:00
test.sh Skip Startup Scripts in Unit Tests 2021-01-20 09:36:13 +01:00

README.md

netbox-docker

GitHub release (latest by date) GitHub stars GitHub closed pull requests Github release workflow Docker Pulls MicroBadger Layers MicroBadger Size GitHub license

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 Network To Code Slack and ask for help in our #netbox-docker channel.

Docker Tags

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

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 channel #netbox-docker on the Network To Code Slack, 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 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.

Use a Specific Netbox Version

The docker-compose.yml file is prepared to run a specific version of Netbox, instead of latest. To use this feature, set and export 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 or Quay.io.

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.

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.