Skip to content

Commit 4ef35aa

Browse files
committed
Update the README with regards to the tags
1 parent 6e870b4 commit 4ef35aa

File tree

1 file changed

+48
-22
lines changed

1 file changed

+48
-22
lines changed

README.md

Lines changed: 48 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -25,29 +25,9 @@ please join the [our Slack][netbox-docker-slack] and ask for help in the [`#netb
2525
[netbox-docker-license]: https://github.com/netbox-community/netbox-docker/blob/release/LICENSE
2626
[netbox-quayio]: https://quay.io/repository/netboxcommunity/netbox
2727

28-
## Docker Tags
29-
30-
* `vX.Y.Z`: These are release builds, automatically built from [the corresponding releases of NetBox][netbox-releases].
31-
* `latest`: These are release builds, automatically built from [the `master` branch of NetBox][netbox-master].
32-
* `snapshot`: These are pre-release builds, automatically built from the [`develop` branch of NetBox][netbox-develop].
33-
* `develop-X.Y`: These are pre-release builds, automatically built from the corresponding [branch of NetBox][netbox-branches].
34-
35-
Then there is currently one extra tags for each of the above tags:
36-
37-
* `-ldap`: Contains additional dependencies and configurations for connecting NetBox to an LDAP directory.
38-
[Learn more about that in our wiki][netbox-docker-ldap].
39-
40-
New images are built and published automatically every ~24h.
41-
42-
[netbox-releases]: https://github.com/netbox-community/netbox/releases
43-
[netbox-master]: https://github.com/netbox-community/netbox/tree/master
44-
[netbox-develop]: https://github.com/netbox-community/netbox/tree/develop
45-
[netbox-branches]: https://github.com/netbox-community/netbox/branches
46-
[netbox-docker-ldap]: https://github.com/netbox-community/netbox-docker/wiki/LDAP
47-
4828
## Quickstart
4929

50-
To get NetBox Docker up and running run the following commands.
30+
To get _NetBox Docker_ up and running run the following commands.
5131
There is a more complete [_Getting Started_ guide on our wiki][wiki-getting-started] which explains every step.
5232

5333
```bash
@@ -77,6 +57,52 @@ The default credentials are:
7757
[wiki-getting-started]: https://github.com/netbox-community/netbox-docker/wiki/Getting-Started
7858
[docker-reception]: https://github.com/nxt-engineering/reception
7959

60+
## Container Image Tags
61+
62+
New container images are built and published automatically every ~24h.
63+
64+
> We recommend to use either the `vX.Y.Z-a.b.c` tags or the `vX.Y-a.b.c` tags in production!
65+
66+
* `vX.Y.Z-a.b.c`, `vX.Y-a.b.c`:
67+
These are release builds containing _NetBox version_ `vX.Y.Z`.
68+
They contain the support files of _NetBox Docker version_ `a.b.c`.
69+
You must _NetBox Docker version_ `a.b.c` to guarantee the compatibility.
70+
These images are automatically built from [the corresponding releases of NetBox][netbox-releases].
71+
* `latest-a.b.c`:
72+
These are release builds, containing the latest stable version of NetBox.
73+
They contain the support files of _NetBox Docker version_ `a.b.c`.
74+
You must _NetBox Docker version_ `a.b.c` to guarantee the compatibility.
75+
These images are automatically built from [the `master` branch of NetBox][netbox-master].
76+
* `snapshot-a.b.c`:
77+
These are pre-release builds.
78+
They contain the support files of _NetBox Docker version_ `a.b.c`.
79+
You must _NetBox Docker version_ `a.b.c` to guarantee the compatibility.
80+
These images are automatically built from the [`develop` branch of NetBox][netbox-develop].
81+
82+
For each of the above tags, there is an extra tag:
83+
84+
* `vX.Y.Z`, `vX.Y`:
85+
This is the same version as `vX.Y.Z-a.b.c` (or `vX.Y-a.b.c`, respectively).
86+
It always points to the latest version of _NetBox Docker_.
87+
* `latest`
88+
This is the same version as `latest-a.b.c`.
89+
It always points to the latest version of _NetBox Docker_.
90+
* `snapshot`
91+
This is the same version as `snapshot-a.b.c`.
92+
It always points to the latest version of _NetBox Docker_.
93+
94+
Then there is currently one extra tags for each of the above tags:
95+
96+
* `-ldap`:
97+
These container images contain additional dependencies and configuration files for connecting NetBox to an LDAP directory.
98+
[Learn more about that in our wiki][netbox-docker-ldap].
99+
100+
[netbox-releases]: https://github.com/netbox-community/netbox/releases
101+
[netbox-master]: https://github.com/netbox-community/netbox/tree/master
102+
[netbox-develop]: https://github.com/netbox-community/netbox/tree/develop
103+
[netbox-branches]: https://github.com/netbox-community/netbox/branches
104+
[netbox-docker-ldap]: https://github.com/netbox-community/netbox-docker/wiki/LDAP
105+
80106
## Documentation
81107

82108
Please refer [to our wiki on Github][netbox-docker-wiki] for further information on how to use this NetBox Docker image properly.
@@ -119,7 +145,7 @@ Please read [the release notes][releases] carefully when updating to a new image
119145

120146
## Rebuilding the Image
121147

122-
`./build.sh` can be used to rebuild the Docker image. See `./build.sh --help` for more information.
148+
`./build.sh` can be used to rebuild the container image. See `./build.sh --help` for more information.
123149

124150
For more details on custom builds [consult our wiki][netbox-docker-wiki-build].
125151

0 commit comments

Comments
 (0)