From 8aed79363a88083da0e5775be69508501bbf6c3c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20M=C3=A4der?= Date: Wed, 10 Feb 2021 12:35:06 +0100 Subject: [PATCH] Move Documentation about Version to Wiki See https://github.com/netbox-community/netbox-docker/wiki/Version. --- README.md | 29 ++--------------------------- 1 file changed, 2 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 16c0698..848fece 100644 --- a/README.md +++ b/README.md @@ -97,36 +97,11 @@ If you need help with using NetBox or developing for it or against it's API you 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`. +* 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`. -## 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][netbox-dockerhub] or [Quay.io][netbox-quayio]. - -```bash -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][git-ref] in that case. - -```bash -export VERSION=v2.7.1 -./build.sh $VERSION -docker-compose up -d -``` - -[git-ref]: https://git-scm.com/book/en/v2/Git-Internals-Git-References -[netbox-github]: https://github.com/netbox-community/netbox/releases - ## Breaking Changes From time to time it might become necessary to re-engineer the structure of this setup.