doppler dockerfile added + workflow
This commit is contained in:
MXPicture
parent
58a1579832
commit
c1b6b91404
13 changed files with 251 additions and 524 deletions
68
README.md
68
README.md
|
|
@ -1,11 +1,11 @@
|
|||
# netbox-docker
|
||||
# netbox-docker + doppler installed
|
||||
|
||||
[][github-release]
|
||||
[][github-stargazers]
|
||||
|
||||
|
||||
[][github-release]
|
||||
[][github-stargazers]
|
||||
|
||||
|
||||
|
||||
[][netbox-docker-license]
|
||||
[][netbox-docker-license]
|
||||
|
||||
[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].
|
||||
|
|
@ -14,17 +14,17 @@ Do you have any questions?
|
|||
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
|
||||
[github-release]: https://github.com/netbox-community/netbox-docker/releases
|
||||
[github-stargazers]: https://github.com/MXPicture/docker-netbox/stargazers
|
||||
[github-release]: https://github.com/MXPicture/docker-netbox/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-github]: https://github.com/MXPicture/docker-netbox/
|
||||
[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-docker-license]: https://github.com/MXPicture/docker-netbox/blob/release/LICENSE
|
||||
|
||||
## Quickstart
|
||||
|
||||
|
|
@ -32,7 +32,7 @@ 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
|
||||
git clone -b release https://github.com/netbox-community/netbox-docker.git
|
||||
git clone -b release https://github.com/MXPicture/docker-netbox.git
|
||||
cd netbox-docker
|
||||
tee docker-compose.override.yml <<EOF
|
||||
version: '3.4'
|
||||
|
|
@ -42,6 +42,12 @@ services:
|
|||
- 8000:8080
|
||||
EOF
|
||||
docker-compose pull
|
||||
|
||||
# Prevent command with Service Token being recorded in bash history
|
||||
export HISTIGNORE='export DOPPLER_TOKEN*'
|
||||
|
||||
export DOPPLER_TOKEN='dp.st.prd.xxxx'
|
||||
|
||||
docker-compose up
|
||||
```
|
||||
|
||||
|
|
@ -51,11 +57,11 @@ You should see the NetBox homepage.
|
|||
In the top-right corner you can login.
|
||||
The default credentials are:
|
||||
|
||||
* Username: **admin**
|
||||
* Password: **admin**
|
||||
* API Token: **0123456789abcdef0123456789abcdef01234567**
|
||||
- Username: **admin**
|
||||
- Password: **admin**
|
||||
- API Token: **0123456789abcdef0123456789abcdef01234567**
|
||||
|
||||
[wiki-getting-started]: https://github.com/netbox-community/netbox-docker/wiki/Getting-Started
|
||||
[wiki-getting-started]: https://github.com/MXPicture/docker-netbox/wiki/Getting-Started
|
||||
[docker-reception]: https://github.com/nxt-engineering/reception
|
||||
|
||||
## Container Image Tags
|
||||
|
|
@ -64,17 +70,17 @@ 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.
|
||||
These images are automatically built from [the `master` branch of NetBox][netbox-master].
|
||||
* `snapshot-a.b.c`:
|
||||
- `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.
|
||||
|
|
@ -82,19 +88,19 @@ 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).
|
||||
It always points to the latest version of _NetBox Docker_.
|
||||
* `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_.
|
||||
|
||||
Then there is currently one extra tags for each of the above tags:
|
||||
|
||||
* `-ldap`:
|
||||
- `-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].
|
||||
|
||||
|
|
@ -102,7 +108,7 @@ Then there is currently one extra tags for each of the above tags:
|
|||
[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
|
||||
[netbox-docker-ldap]: https://github.com/MXPicture/docker-netbox/wiki/LDAP
|
||||
|
||||
## Documentation
|
||||
|
||||
|
|
@ -112,7 +118,7 @@ The wiki covers advanced topics such as using files for secrets, configuring TLS
|
|||
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/
|
||||
[netbox-docker-wiki]: https://github.com/MXPicture/docker-netbox/wiki/
|
||||
|
||||
## Getting Help
|
||||
|
||||
|
|
@ -123,14 +129,14 @@ which is free to use and where there are almost always people online that can he
|
|||
If you need help with using NetBox or developing for it or against it's API
|
||||
you may find [the `#netbox` channel][netbox-slack-channel] on the same Slack instance very helpful.
|
||||
|
||||
[netbox-community]: https://github.com/netbox-community/netbox-docker/discussions
|
||||
[netbox-community]: https://github.com/MXPicture/docker-netbox/discussions
|
||||
|
||||
## Dependencies
|
||||
|
||||
This project relies only on *Docker* and *docker-compose* meeting these requirements:
|
||||
This project relies only on _Docker_ and _docker-compose_ meeting these requirements:
|
||||
|
||||
* The *Docker version* must be at least `19.03`.
|
||||
* The *docker-compose version* must be at least `1.28.0`.
|
||||
- The _Docker version_ must be at least `19.03`.
|
||||
- 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`.
|
||||
|
||||
|
|
@ -141,8 +147,8 @@ Note that the version of the NetBox Docker container image must stay in sync wit
|
|||
|
||||
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
|
||||
[releases]: https://github.com/MXPicture/docker-netbox/releases
|
||||
[netbox-docker-wiki-updating]: https://github.com/MXPicture/docker-netbox/wiki/Updating
|
||||
|
||||
## Rebuilding the Image
|
||||
|
||||
|
|
@ -150,7 +156,7 @@ If you update for the first time, be sure [to follow our _How To Update NetBox D
|
|||
|
||||
For more details on custom builds [consult our wiki][netbox-docker-wiki-build].
|
||||
|
||||
[netbox-docker-wiki-build]: https://github.com/netbox-community/netbox-docker/wiki/Build
|
||||
[netbox-docker-wiki-build]: https://github.com/MXPicture/docker-netbox/wiki/Build
|
||||
|
||||
## Tests
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue