NetBox should always be referred to as NetBox
Fix all instances of "Netbox". ```Shell git ls-files -z . | xargs --null -I '{}' find './{}' -type f -print0 | xargs --null sed --in-place --regexp-extended 's#Netbox#NetBox#g;' ``` Ref: https://netbox.readthedocs.io/en/stable/development/style-guide/#branding
This commit is contained in:
parent
04e0b3d3ca
commit
ee40e339c8
|
@ -16,14 +16,14 @@ Before raising an issue here, answer the following questions for yourself, pleas
|
|||
* Have you updated to the latest version and tried again? (i.e. `git pull` and `docker-compose pull`)
|
||||
* Have you reset the project and tried again? (i.e. `docker-compose down -v`)
|
||||
* Are you confident that your problem is related to the Docker image or Docker Compose file this project provides?
|
||||
(Otherwise ask on the Netbox mailing list, please: https://groups.google.com/d/forum/netbox-discuss)
|
||||
(Otherwise ask on the NetBox mailing list, please: https://groups.google.com/d/forum/netbox-discuss)
|
||||
* Have you looked through the issues already resolved?
|
||||
|
||||
Please try this means to get help before opening an issue here:
|
||||
|
||||
* On the networktocode Slack in the #netbox-docker channel: http://slack.networktocode.com/
|
||||
* On the networktocode Slack in the #netbox channel: http://slack.networktocode.com/
|
||||
* On the Netbox mailing list: https://groups.google.com/d/forum/netbox-discuss
|
||||
* On the NetBox mailing list: https://groups.google.com/d/forum/netbox-discuss
|
||||
|
||||
Please don't open an issue when you have a PR ready. Just submit the PR, that's good enough.
|
||||
|
||||
|
|
|
@ -2,7 +2,7 @@ blank_issues_enabled: false
|
|||
contact_links:
|
||||
- name: Question
|
||||
url: https://github.com/netbox-community/netbox-docker/discussions
|
||||
about: The Github Discussions are the right place to ask questions about how to use or do certain things with Netbox Docker.
|
||||
about: The Github Discussions are the right place to ask questions about how to use or do certain things with NetBox Docker.
|
||||
|
||||
- name: Chat
|
||||
url: http://slack.networktocode.com/
|
||||
|
@ -11,5 +11,5 @@ contact_links:
|
|||
- name: Community Wiki
|
||||
url: https://github.com/netbox-community/netbox-docker/wiki
|
||||
about: |
|
||||
Our wiki contains information for common problems and tips for operating Netbox Docker in production.
|
||||
Our wiki contains information for common problems and tips for operating NetBox Docker in production.
|
||||
It's maintained by our excellent community.
|
||||
|
|
|
@ -15,14 +15,14 @@ Before raising an issue here, answer the following questions for yourself, pleas
|
|||
* Have you had a look at the rest of the wiki? (https://github.com/netbox-community/netbox-docker/wiki)
|
||||
* Have you read the release notes recently (https://github.com/netbox-community/netbox-docker/releases)
|
||||
* Are you confident that your feature/change request is related to the Docker image or Docker Compose file this project provides?
|
||||
(Otherwise ask on the Netbox mailing list, please: https://groups.google.com/d/forum/netbox-discuss)
|
||||
(Otherwise ask on the NetBox mailing list, please: https://groups.google.com/d/forum/netbox-discuss)
|
||||
* Have you looked through the issues already resolved?
|
||||
|
||||
Please try this means to get help before opening an issue here:
|
||||
|
||||
* On the networktocode Slack in the #netbox-docker channel: http://slack.networktocode.com/
|
||||
* On the networktocode Slack in the #netbox channel: http://slack.networktocode.com/
|
||||
* On the Netbox mailing list: https://groups.google.com/d/forum/netbox-discuss
|
||||
* On the NetBox mailing list: https://groups.google.com/d/forum/netbox-discuss
|
||||
|
||||
Please don't open an issue when you have a PR ready. Just submit the PR, that's good enough.
|
||||
|
||||
|
|
|
@ -23,7 +23,7 @@ jobs:
|
|||
- alpine:edge
|
||||
fail-fast: false
|
||||
runs-on: ubuntu-latest
|
||||
name: Builds new Netbox Docker Images
|
||||
name: Builds new NetBox Docker Images
|
||||
steps:
|
||||
- id: git-checkout
|
||||
name: Checkout
|
||||
|
|
|
@ -18,7 +18,7 @@ jobs:
|
|||
- ./build.sh develop
|
||||
fail-fast: false
|
||||
runs-on: ubuntu-latest
|
||||
name: Builds new Netbox Docker Images
|
||||
name: Builds new NetBox Docker Images
|
||||
steps:
|
||||
- id: git-checkout
|
||||
name: Checkout
|
||||
|
|
|
@ -81,8 +81,8 @@ LABEL ORIGINAL_TAG="" \
|
|||
# Also https://microbadger.com/labels
|
||||
org.label-schema.schema-version="1.0" \
|
||||
org.label-schema.build-date="" \
|
||||
org.label-schema.name="Netbox Docker" \
|
||||
org.label-schema.description="A container based distribution of Netbox, the free and open IPAM and DCIM solution." \
|
||||
org.label-schema.name="NetBox Docker" \
|
||||
org.label-schema.description="A container based distribution of NetBox, the free and open IPAM and DCIM solution." \
|
||||
org.label-schema.vendor="The netbox-docker contributors." \
|
||||
org.label-schema.url="https://github.com/netbox-community/netbox-docker" \
|
||||
org.label-schema.usage="https://github.com/netbox-community/netbox-docker/wiki" \
|
||||
|
@ -91,8 +91,8 @@ LABEL ORIGINAL_TAG="" \
|
|||
org.label-schema.version="snapshot" \
|
||||
# See https://github.com/opencontainers/image-spec/blob/master/annotations.md#pre-defined-annotation-keys
|
||||
org.opencontainers.image.created="" \
|
||||
org.opencontainers.image.title="Netbox Docker" \
|
||||
org.opencontainers.image.description="A container based distribution of Netbox, the free and open IPAM and DCIM solution." \
|
||||
org.opencontainers.image.title="NetBox Docker" \
|
||||
org.opencontainers.image.description="A container based distribution of NetBox, the free and open IPAM and DCIM solution." \
|
||||
org.opencontainers.image.licenses="Apache-2.0" \
|
||||
org.opencontainers.image.authors="The netbox-docker contributors." \
|
||||
org.opencontainers.image.vendor="The netbox-docker contributors." \
|
||||
|
|
28
README.md
28
README.md
|
@ -9,7 +9,7 @@
|
|||
[![MicroBadger Size](https://img.shields.io/microbadger/image-size/netboxcommunity/netbox)][netbox-docker-microbadger]
|
||||
[![GitHub license](https://img.shields.io/github/license/netbox-community/netbox-docker)][netbox-docker-license]
|
||||
|
||||
[The Github repository](netbox-docker-github) houses the components needed to build Netbox as a Docker container.
|
||||
[The Github repository](netbox-docker-github) houses the components needed to build NetBox as a Docker container.
|
||||
Images are built using this code and are released to [Docker Hub][netbox-dockerhub] and [Quay.io][netbox-quayio] once a day.
|
||||
|
||||
Do you have any questions?
|
||||
|
@ -27,14 +27,14 @@ Before opening an issue on Github, please join the [Network To Code][ntc-slack]
|
|||
|
||||
## Docker Tags
|
||||
|
||||
* `vX.Y.Z`: These are release builds, automatically built from [the corresponding releases of Netbox][netbox-releases].
|
||||
* `latest`: These are release builds, automatically built from [the `master` branch of Netbox][netbox-master].
|
||||
* `snapshot`: These are pre-release builds, automatically built from the [`develop` branch of Netbox][netbox-develop].
|
||||
* `develop-X.Y`: These are pre-release builds, automatically built from the corresponding [branch of Netbox][netbox-branches].
|
||||
* `vX.Y.Z`: These are release builds, automatically built from [the corresponding releases of NetBox][netbox-releases].
|
||||
* `latest`: These are release builds, automatically built from [the `master` branch of NetBox][netbox-master].
|
||||
* `snapshot`: These are pre-release builds, automatically built from the [`develop` branch of NetBox][netbox-develop].
|
||||
* `develop-X.Y`: These are pre-release builds, automatically built from the corresponding [branch of NetBox][netbox-branches].
|
||||
|
||||
Then there is currently one extra tags for each of the above tags:
|
||||
|
||||
* `-ldap`: Contains additional dependencies and configurations for connecting Netbox to an LDAP directory.
|
||||
* `-ldap`: Contains additional dependencies and configurations for connecting NetBox to an LDAP directory.
|
||||
[Learn more about that in our wiki][netbox-docker-ldap].
|
||||
|
||||
New images are built and published automatically every ~24h.
|
||||
|
@ -47,7 +47,7 @@ New images are built and published automatically every ~24h.
|
|||
|
||||
## Quickstart
|
||||
|
||||
To get Netbox Docker up and running run the following commands.
|
||||
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
|
||||
|
@ -66,7 +66,7 @@ docker-compose up
|
|||
|
||||
The whole application will be available after a few minutes.
|
||||
Open the URL `http://0.0.0.0:8000/` in a web-browser.
|
||||
You should see the Netbox homepage.
|
||||
You should see the NetBox homepage.
|
||||
In the top-right corner you can login.
|
||||
The default credentials are:
|
||||
|
||||
|
@ -79,7 +79,7 @@ The default credentials are:
|
|||
|
||||
## Documentation
|
||||
|
||||
Please refer [to our wiki on Github][netbox-docker-wiki] for further information on how to use this Netbox Docker image properly.
|
||||
Please refer [to our wiki on Github][netbox-docker-wiki] for further information on how to use this NetBox Docker image properly.
|
||||
It covers advanced topics such as using files for secrets, deployment to Kubernetes, monitoring and configuring NAPALM or LDAP.
|
||||
|
||||
[netbox-docker-wiki]: https://github.com/netbox-community/netbox-docker/wiki/
|
||||
|
@ -89,7 +89,7 @@ It covers advanced topics such as using files for secrets, deployment to Kuberne
|
|||
Feel free to ask questions in our [Github Community][netbox-community] or join [our Slack channel `#netbox-docker`][netbox-docker-slack] on the [Network To Code Slack][ntc-slack],
|
||||
which is free to use and where there are almost always people online that can help you in the Slack channel.
|
||||
|
||||
If you need help with using Netbox or developing for it or against it's API you may find the `#netbox` channel on the same Slack instance very helpful.
|
||||
If you need help with using NetBox or developing for it or against it's API you may find the `#netbox` channel on the same Slack instance very helpful.
|
||||
|
||||
[netbox-community]: https://github.com/netbox-community/netbox-docker/discussions
|
||||
|
||||
|
@ -102,9 +102,9 @@ This project relies only on *Docker* and *docker-compose* meeting these requirem
|
|||
|
||||
To check the version installed on your system run `docker --version` and `docker-compose --version`.
|
||||
|
||||
## Use a Specific Netbox Version
|
||||
## Use a Specific NetBox Version
|
||||
|
||||
The `docker-compose.yml` file is prepared to run a specific version of Netbox, instead of `latest`.
|
||||
The `docker-compose.yml` file is prepared to run a specific version of NetBox, instead of `latest`.
|
||||
To use this feature, set and export the environment-variable `VERSION` before launching `docker-compose`, as shown below.
|
||||
`VERSION` may be set to the name of
|
||||
[any tag of the `netboxcommunity/netbox` Docker image on Docker Hub][netbox-dockerhub] or [Quay.io][netbox-quayio].
|
||||
|
@ -115,7 +115,7 @@ docker-compose pull netbox
|
|||
docker-compose up -d
|
||||
```
|
||||
|
||||
You can also build a specific version of the Netbox Docker image yourself.
|
||||
You can also build a specific version of the NetBox Docker image yourself.
|
||||
`VERSION` can be any valid [git ref][git-ref] in that case.
|
||||
|
||||
```bash
|
||||
|
@ -151,7 +151,7 @@ For more details on custom builds [consult our wiki][netbox-docker-wiki-build].
|
|||
## Tests
|
||||
|
||||
We have a test script.
|
||||
It runs Netbox's own unit tests and ensures that all initializers work:
|
||||
It runs NetBox's own unit tests and ensures that all initializers work:
|
||||
|
||||
```bash
|
||||
IMAGE=netboxcommunity/netbox:latest ./test.sh
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
#!/bin/bash
|
||||
# Builds develop, develop-* and master branches of Netbox
|
||||
# Builds develop, develop-* and master branches of NetBox
|
||||
|
||||
echo "▶️ $0 $*"
|
||||
|
||||
|
|
10
build.sh
10
build.sh
|
@ -1,5 +1,5 @@
|
|||
#!/bin/bash
|
||||
# Clones the Netbox repository with git from Github and builds the Dockerfile
|
||||
# Clones the NetBox repository with git from Github and builds the Dockerfile
|
||||
|
||||
echo "▶️ $0 $*"
|
||||
|
||||
|
@ -106,7 +106,7 @@ else
|
|||
fi
|
||||
|
||||
###
|
||||
# Variables for fetching the Netbox source
|
||||
# Variables for fetching the NetBox source
|
||||
###
|
||||
SRC_ORG="${SRC_ORG-netbox-community}"
|
||||
SRC_REPO="${SRC_REPO-netbox}"
|
||||
|
@ -115,10 +115,10 @@ URL="${URL-https://github.com/${SRC_ORG}/${SRC_REPO}.git}"
|
|||
NETBOX_PATH="${NETBOX_PATH-.netbox}"
|
||||
|
||||
###
|
||||
# Fetching the Netbox source
|
||||
# Fetching the NetBox source
|
||||
###
|
||||
if [ "${2}" != "--push-only" ] && [ -z "${SKIP_GIT}" ] ; then
|
||||
echo "🌐 Checking out '${NETBOX_BRANCH}' of Netbox from the url '${URL}' into '${NETBOX_PATH}'"
|
||||
echo "🌐 Checking out '${NETBOX_BRANCH}' of NetBox from the url '${URL}' into '${NETBOX_PATH}'"
|
||||
if [ ! -d "${NETBOX_PATH}" ]; then
|
||||
$DRY git clone -q --depth 10 -b "${NETBOX_BRANCH}" "${URL}" "${NETBOX_PATH}"
|
||||
fi
|
||||
|
@ -135,7 +135,7 @@ if [ "${2}" != "--push-only" ] && [ -z "${SKIP_GIT}" ] ; then
|
|||
$DRY git checkout -qf FETCH_HEAD
|
||||
$DRY git prune
|
||||
)
|
||||
echo "✅ Checked out Netbox"
|
||||
echo "✅ Checked out NetBox"
|
||||
fi
|
||||
|
||||
###
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
#!/bin/bash
|
||||
# Runs on every start of the Netbox Docker container
|
||||
# Runs on every start of the NetBox Docker container
|
||||
|
||||
# Stop when an error occures
|
||||
set -e
|
||||
|
||||
# Allows Netbox to be run as non-root users
|
||||
# Allows NetBox to be run as non-root users
|
||||
umask 002
|
||||
|
||||
# Load correct Python3 env
|
||||
|
|
4
test.sh
4
test.sh
|
@ -1,5 +1,5 @@
|
|||
#!/bin/bash
|
||||
# Runs the original Netbox unit tests and tests whether all initializers work.
|
||||
# Runs the original NetBox unit tests and tests whether all initializers work.
|
||||
# Usage:
|
||||
# ./test.sh latest
|
||||
# ./test.sh v2.9.7
|
||||
|
@ -55,7 +55,7 @@ test_setup() {
|
|||
}
|
||||
|
||||
test_netbox_unit_tests() {
|
||||
echo "⏱ Running Netbox Unit Tests"
|
||||
echo "⏱ Running NetBox Unit Tests"
|
||||
SKIP_STARTUP_SCRIPTS=true $doco run --rm netbox ./manage.py test
|
||||
}
|
||||
|
||||
|
|
Loading…
Reference in New Issue