From 9996c1d1a2290b171860ee3df3f746e02eeda75a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20M=C3=A4der?= Date: Wed, 10 Feb 2021 12:34:12 +0100 Subject: [PATCH] Created Version (markdown) --- Version.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 Version.md diff --git a/Version.md b/Version.md new file mode 100644 index 0000000..b5b92d2 --- /dev/null +++ b/Version.md @@ -0,0 +1,39 @@ +# 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](https://github.com/netbox-community/netbox-docker/releases) to learn which version of NetBox Docker works with which version of NetBox. + +Then proceed to checkout the respective NetBox Docker version: + +```bash +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: + +```yml +version: '3.4' +services: + netbox: + image: netboxcommunity/netbox:1.0.1 +``` + +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][netbox-dockerhub] or [Quay.io][netbox-quayio]. + +```bash +export VERSION=v2.7.1 +docker-compose pull netbox +docker-compose up -d +``` + +[netbox-github]: https://github.com/netbox-community/netbox/releases \ No newline at end of file