Skip to content

Commit ada2bd6

Browse files
authored
Merge pull request #825 from tobiasge/readme-update
Improved README.md
2 parents dc45dfc + 8707cef commit ada2bd6

File tree

1 file changed

+5
-14
lines changed

1 file changed

+5
-14
lines changed

README.md

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
![Docker Pulls](https://img.shields.io/docker/pulls/netboxcommunity/netbox)
88
[![GitHub license](https://img.shields.io/github/license/netbox-community/netbox-docker)][netbox-docker-license]
99

10-
[The GitHub repository](netbox-docker-github) houses the components needed to build NetBox as a container.
10+
[The GitHub repository][netbox-docker-github] houses the components needed to build NetBox as a container.
1111
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].
1212

1313
Do you have any questions?
@@ -16,7 +16,6 @@ please join [our Slack][netbox-docker-slack] and ask for help in the [`#netbox-d
1616

1717
[github-stargazers]: https://github.com/netbox-community/netbox-docker/stargazers
1818
[github-release]: https://github.com/netbox-community/netbox-docker/releases
19-
[netbox-docker-microbadger]: https://microbadger.com/images/netboxcommunity/netbox
2019
[netbox-dockerhub]: https://hub.docker.com/r/netboxcommunity/netbox/
2120
[netbox-quayio]: https://quay.io/repository/netboxcommunity/netbox
2221
[netbox-ghcr]: https://github.com/netbox-community/netbox-docker/pkgs/container/netbox
@@ -56,7 +55,6 @@ The default credentials are:
5655
* API Token: **0123456789abcdef0123456789abcdef01234567**
5756

5857
[wiki-getting-started]: https://github.com/netbox-community/netbox-docker/wiki/Getting-Started
59-
[docker-reception]: https://github.com/nxt-engineering/reception
6058

6159
## Container Image Tags
6260

@@ -92,17 +90,9 @@ For each of the above tag, there is an extra tag:
9290
This is the same version as `snapshot-a.b.c`.
9391
It always points to the latest version of _NetBox Docker_.
9492

95-
Then there is currently one extra tags for each of the above tags:
96-
97-
* `-ldap`:
98-
These container images contain additional dependencies and configuration files for connecting NetBox to an LDAP directory.
99-
[Learn more about that in our wiki][netbox-docker-ldap].
100-
10193
[netbox-releases]: https://github.com/netbox-community/netbox/releases
10294
[netbox-master]: https://github.com/netbox-community/netbox/tree/master
10395
[netbox-develop]: https://github.com/netbox-community/netbox/tree/develop
104-
[netbox-branches]: https://github.com/netbox-community/netbox/branches
105-
[netbox-docker-ldap]: https://github.com/netbox-community/netbox-docker/wiki/LDAP
10696

10797
## Documentation
10898

@@ -127,10 +117,11 @@ you may find [the `#netbox` channel][netbox-slack-channel] on the same Slack ins
127117

128118
## Dependencies
129119

130-
This project relies only on *Docker* and *docker-compose* meeting these requirements:
120+
This project relies only on _Docker_ and _docker-compose_ meeting these requirements:
131121

132-
* The *Docker version* must be at least `19.03`.
133-
* The *docker-compose version* must be at least `1.28.0`.
122+
* The _Docker version_ must be at least `20.10.10`.
123+
* The _containerd version_ must be at least `1.5.6`.
124+
* The _docker-compose version_ must be at least `1.28.0`.
134125

135126
To check the version installed on your system run `docker --version` and `docker-compose --version`.
136127

0 commit comments

Comments
 (0)