Skip to content

Commit 7e86ba0

Browse files
committed
More overhaul of the README
1 parent 6f12cb3 commit 7e86ba0

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -106,8 +106,11 @@ Then there is currently one extra tags for each of the above tags:
106106

107107
## Documentation
108108

109-
Please refer [to our wiki on Github][netbox-docker-wiki] for further information on how to use this NetBox Docker image properly.
110-
It covers advanced topics such as using files for secrets, deployment to Kubernetes, monitoring and configuring NAPALM or LDAP.
109+
Please refer [to our wiki on Github][netbox-docker-wiki] for further information on how to use the NetBox Docker image properly.
110+
The wiki covers advanced topics such as using files for secrets, configuring TLS, deployment to Kubernetes, monitoring and configuring NAPALM or LDAP.
111+
112+
Our wiki is a community effort.
113+
Feel free to correct errors, update outdated information or provide additional guides and insights.
111114

112115
[netbox-docker-wiki]: https://github.com/netbox-community/netbox-docker/wiki/
113116

@@ -131,18 +134,15 @@ This project relies only on *Docker* and *docker-compose* meeting these requirem
131134

132135
To check the version installed on your system run `docker --version` and `docker-compose --version`.
133136

134-
## Breaking Changes
135-
136-
From time to time it might become necessary to re-engineer the structure of this setup.
137-
Things like the `docker-compose.yml` file or your Kubernetes or OpenShift configurations have to be adjusted as a consequence.
138-
139-
Since November 2019 each image built from this repo contains a `org.opencontainers.image.version` label.
140-
(The images contained labels since April 2018, although in November 2019 the labels' names changed.)
141-
You can check the label of your local image by running `docker inspect netboxcommunity/netbox:v2.7.1 --format "{{json .Config.Labels}}"`.
137+
## Updating
142138

143139
Please read [the release notes][releases] carefully when updating to a new image version.
140+
Note that the version of the NetBox Docker container image must stay in sync with the code.
141+
142+
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].
144143

145144
[releases]: https://github.com/netbox-community/netbox-docker/releases
145+
[netbox-docker-wiki-updating]: https://github.com/netbox-community/netbox-docker/wiki/Updating
146146

147147
## Rebuilding the Image
148148

0 commit comments

Comments
 (0)