diff --git a/README.md b/README.md index 0992a67..588c6ec 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ 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, +Before opening an issue on GitHub, 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 @@ -63,16 +63,16 @@ 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`: +- `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`: +- `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. -* `snapshot-a.b.c`: +- `snapshot-a.b.c`: These are prerelease 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. @@ -80,12 +80,12 @@ New container images are built and published automatically every ~24h. For each of the above tag, there is an extra tag: -* `vX.Y.Z`, `vX.Y`: +- `vX.Y.Z`, `vX.Y`: This is the same version as `vX.Y.Z-a.b.c` (or `vX.Y-a.b.c`, respectively). -* `latest` +- `latest` This is the same version as `latest-a.b.c`. It always points to the latest version of _NetBox Docker_. -* `snapshot` +- `snapshot` This is the same version as `snapshot-a.b.c`. It always points to the latest version of _NetBox Docker_. @@ -117,9 +117,9 @@ you may find [the `#netbox` channel][netbox-slack-channel] on the same Slack ins This project relies only on _Docker_ and _docker-compose_ meeting these requirements: -* The _Docker version_ must be at least `20.10.10`. -* The _containerd version_ must be at least `1.5.6`. -* The _docker-compose version_ must be at least `1.28.0`. +- The _Docker version_ must be at least `20.10.10`. +- The _containerd version_ must be at least `1.5.6`. +- 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`.