From 0ea826346d139a8374eecef881da1f1c59180912 Mon Sep 17 00:00:00 2001 From: Rowan Ruseler Date: Mon, 16 Oct 2017 12:33:13 +0200 Subject: [PATCH 1/2] Project requirements --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index e1ab147..daadeab 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,13 @@ This repository houses the components needed to build NetBox as a Docker container. Images built using this code are released to [Docker Hub](https://hub.docker.com/r/ninech/netbox) every night. +### Dependencies + +This project depends on: + +* [docker/docker-ce] >= 1.13.0 +* [docker/compose] >= 1.10.0 + ## Quickstart To get NetBox up and running: @@ -74,3 +81,6 @@ $ docker-compose -f docker-compose.test.yml run --rm app This repository is currently maintained and funded by [nine](https://nine.ch). [![logo of the company 'nine'](https://logo.apps.at-nine.ch/Dmqied_eSaoBMQwk3vVgn4UIgDo=/trim/500x0/logo_claim.png)](https://www.nine.ch) + +[docker/docker-ce]: https://github.com/docker/docker-ce +[docker/compose]: https://github.com/docker/compose From 6c285297364283d4e20450a9046b8551338a0c84 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20Ma=CC=88der?= Date: Mon, 16 Oct 2017 13:09:17 +0200 Subject: [PATCH 2/2] Re-phrased the dependencies section --- README.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index daadeab..0c07e71 100644 --- a/README.md +++ b/README.md @@ -5,13 +5,6 @@ This repository houses the components needed to build NetBox as a Docker container. Images built using this code are released to [Docker Hub](https://hub.docker.com/r/ninech/netbox) every night. -### Dependencies - -This project depends on: - -* [docker/docker-ce] >= 1.13.0 -* [docker/compose] >= 1.10.0 - ## Quickstart To get NetBox up and running: @@ -41,6 +34,15 @@ Default credentials: * Username: **admin** * Password: **admin** +## Dependencies + +This project relies only on Docker and docker-compose. But we + +* The *Docker version* must be at least `1.13.0`. +* The *docker-compose version* must be at least `1.10.0`. + +To ensure this, compare the output of `docker --version` and `docker-compose --version` with the requirements above. + ## Configuration You can configure the app using environment variables. These are defined in `netbox.env`. @@ -81,6 +83,3 @@ $ docker-compose -f docker-compose.test.yml run --rm app This repository is currently maintained and funded by [nine](https://nine.ch). [![logo of the company 'nine'](https://logo.apps.at-nine.ch/Dmqied_eSaoBMQwk3vVgn4UIgDo=/trim/500x0/logo_claim.png)](https://www.nine.ch) - -[docker/docker-ce]: https://github.com/docker/docker-ce -[docker/compose]: https://github.com/docker/compose