Skip to content
Austin Culter edited this page Sep 4, 2024 · 7 revisions

Using a Specific Version of NetBox

In order to use a specific version of NetBox, you need to check out the respective version of NetBox Docker. Carefully check the release notes to learn which version of NetBox Docker works with which version of NetBox.

Then proceed to checkout the respective NetBox Docker version:

git checkout 1.0.1

The docker-compose.yml file is pre-configured to run the latest image. To run a specific version, adjust your docker-compose.override.yml file to include the image: line, like so:

version: '3.4'
services:
  netbox:
    image: netboxcommunity/netbox:v3.1.3
  netbox-worker:
    image: netboxcommunity/netbox:v3.1.3
  netbox-housekeeping:
    image: netboxcommunity/netbox:v3.1.3

Note that you need to also override the netbox-worker and netbox-housekeeping service definitions to match.

Now pull the Docker image: docker compose pull netbox

Alternative via VERSION variable

To quickly iterate through specific version, you can set the VERSION environment variable.

Make sure that your docker-compose.override.yml does not override the image: line. Now set and export the environment-variable VERSION before invoking 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
Clone this wiki locally