diff --git a/README.md b/README.md index 6cfdd95..d8aedf4 100644 --- a/README.md +++ b/README.md @@ -7,47 +7,28 @@ ![Docker Pulls](https://img.shields.io/docker/pulls/netboxcommunity/netbox) [![GitHub license](https://img.shields.io/github/license/netbox-community/netbox-docker)][netbox-docker-license] -[The Github repository](netbox-docker-github) houses the components needed to build NetBox as a Docker container. -Images are built using this code and are released to [Docker Hub][netbox-dockerhub] and [Quay.io][netbox-quayio] once a day. +[The Github repository](netbox-docker-github) houses the components needed to build NetBox as a container. +Images are built regularly using the code in that repository and are pushed to [Docker Hub][netbox-dockerhub], [Quay.io][netbox-quayio] and [GitHub Container Registry][netbox-ghcr]. Do you have any questions? Before opening an issue on Github, -please join the [our Slack][netbox-docker-slack] and ask for help in the [`#netbox-docker`][netbox-docker-slack-channel] channel. +please join [our Slack][netbox-docker-slack] and ask for help in the [`#netbox-docker`][netbox-docker-slack-channel] channel. [github-stargazers]: https://github.com/netbox-community/netbox-docker/stargazers [github-release]: https://github.com/netbox-community/netbox-docker/releases [netbox-docker-microbadger]: https://microbadger.com/images/netboxcommunity/netbox [netbox-dockerhub]: https://hub.docker.com/r/netboxcommunity/netbox/ +[netbox-quayio]: https://quay.io/repository/netboxcommunity/netbox +[netbox-ghcr]: https://ghcr.io/netbox-community/netbox/ [netbox-docker-github]: https://github.com/netbox-community/netbox-docker/ [netbox-docker-slack]: https://join.slack.com/t/netdev-community/shared_invite/zt-mtts8g0n-Sm6Wutn62q_M4OdsaIycrQ [netbox-docker-slack-channel]: https://netdev-community.slack.com/archives/C01P0GEVBU7 [netbox-slack-channel]: https://netdev-community.slack.com/archives/C01P0FRSXRV [netbox-docker-license]: https://github.com/netbox-community/netbox-docker/blob/release/LICENSE -[netbox-quayio]: https://quay.io/repository/netboxcommunity/netbox - -## Docker Tags - -* `vX.Y.Z`: These are release builds, automatically built from [the corresponding releases of NetBox][netbox-releases]. -* `latest`: These are release builds, automatically built from [the `master` branch of NetBox][netbox-master]. -* `snapshot`: These are pre-release builds, automatically built from the [`develop` branch of NetBox][netbox-develop]. -* `develop-X.Y`: These are pre-release builds, automatically built from the corresponding [branch of NetBox][netbox-branches]. - -Then there is currently one extra tags for each of the above tags: - -* `-ldap`: Contains additional dependencies and configurations for connecting NetBox to an LDAP directory. - [Learn more about that in our wiki][netbox-docker-ldap]. - -New images are built and published automatically every ~24h. - -[netbox-releases]: https://github.com/netbox-community/netbox/releases -[netbox-master]: https://github.com/netbox-community/netbox/tree/master -[netbox-develop]: https://github.com/netbox-community/netbox/tree/develop -[netbox-branches]: https://github.com/netbox-community/netbox/branches -[netbox-docker-ldap]: https://github.com/netbox-community/netbox-docker/wiki/LDAP ## Quickstart -To get NetBox Docker up and running run the following commands. +To get _NetBox Docker_ up and running run the following commands. There is a more complete [_Getting Started_ guide on our wiki][wiki-getting-started] which explains every step. ```bash @@ -77,10 +58,59 @@ The default credentials are: [wiki-getting-started]: https://github.com/netbox-community/netbox-docker/wiki/Getting-Started [docker-reception]: https://github.com/nxt-engineering/reception +## Container Image Tags + +New container images are built and published automatically every ~24h. + +> We recommend to use either the `vX.Y.Z-a.b.c` tags or the `vX.Y-a.b.c` tags in production! + +* `vX.Y.Z-a.b.c`, `vX.Y-a.b.c`: + These are release builds containing _NetBox version_ `vX.Y.Z`. + They contain the support files of _NetBox Docker version_ `a.b.c`. + You must use _NetBox Docker version_ `a.b.c` to guarantee the compatibility. + These images are automatically built from [the corresponding releases of NetBox][netbox-releases]. +* `latest-a.b.c`: + These are release builds, containing the latest stable version of NetBox. + They contain the support files of _NetBox Docker version_ `a.b.c`. + You must use _NetBox Docker version_ `a.b.c` to guarantee the compatibility. + These images are automatically built from [the `master` branch of NetBox][netbox-master]. +* `snapshot-a.b.c`: + These are pre-release builds. + They contain the support files of _NetBox Docker version_ `a.b.c`. + You must use _NetBox Docker version_ `a.b.c` to guarantee the compatibility. + These images are automatically built from the [`develop` branch of NetBox][netbox-develop]. + +For each of the above tag, there is an extra tag: + +* `vX.Y.Z`, `vX.Y`: + This is the same version as `vX.Y.Z-a.b.c` (or `vX.Y-a.b.c`, respectively). + It always points to the latest version of _NetBox Docker_. +* `latest` + This is the same version as `latest-a.b.c`. + It always points to the latest version of _NetBox Docker_. +* `snapshot` + This is the same version as `snapshot-a.b.c`. + It always points to the latest version of _NetBox Docker_. + +Then there is currently one extra tags for each of the above tags: + +* `-ldap`: + These container images contain additional dependencies and configuration files for connecting NetBox to an LDAP directory. + [Learn more about that in our wiki][netbox-docker-ldap]. + +[netbox-releases]: https://github.com/netbox-community/netbox/releases +[netbox-master]: https://github.com/netbox-community/netbox/tree/master +[netbox-develop]: https://github.com/netbox-community/netbox/tree/develop +[netbox-branches]: https://github.com/netbox-community/netbox/branches +[netbox-docker-ldap]: https://github.com/netbox-community/netbox-docker/wiki/LDAP + ## Documentation -Please refer [to our wiki on Github][netbox-docker-wiki] 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. +Please refer [to our wiki on Github][netbox-docker-wiki] for further information on how to use the NetBox Docker image properly. +The wiki covers advanced topics such as using files for secrets, configuring TLS, deployment to Kubernetes, monitoring and configuring NAPALM and LDAP. + +Our wiki is a community effort. +Feel free to correct errors, update outdated information or provide additional guides and insights. [netbox-docker-wiki]: https://github.com/netbox-community/netbox-docker/wiki/ @@ -104,22 +134,19 @@ This project relies only on *Docker* and *docker-compose* meeting these requirem To check the version installed on your system run `docker --version` and `docker-compose --version`. -## 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}}"`. +## Updating Please read [the release notes][releases] carefully when updating to a new image version. +Note that the version of the NetBox Docker container image must stay in sync with the code. + +If you update for the first time, be sure [to follow our _How To Update NetBox Docker_ guide in the wiki][netbox-docker-wiki-updating]. [releases]: https://github.com/netbox-community/netbox-docker/releases +[netbox-docker-wiki-updating]: https://github.com/netbox-community/netbox-docker/wiki/Updating ## Rebuilding the Image -`./build.sh` can be used to rebuild the Docker image. See `./build.sh --help` for more information. +`./build.sh` can be used to rebuild the container image. See `./build.sh --help` for more information. For more details on custom builds [consult our wiki][netbox-docker-wiki-build].