Compare commits
84 Commits
Author | SHA1 | Date | |
---|---|---|---|
f64ae49f18 | |||
4f645769df | |||
db7acaf647 | |||
90909d4181 | |||
bdbcf7bf4a | |||
477decd80a | |||
b845efe1ad | |||
56defa3f82 | |||
7078ab7519 | |||
fcd5b4e66b | |||
2efacf39ca | |||
a4ce13be19 | |||
fa08388175 | |||
fd9b41a5d1 | |||
83ec1c2656 | |||
0fe49f87d7 | |||
83f87b4ad2 | |||
82d9d8ae49 | |||
f1864f8f20 | |||
8431b77422 | |||
19e167ec19 | |||
8f7c21749e | |||
ec9a3e80da | |||
61eaffaf2e | |||
fef49f447e | |||
5ded00b6fb | |||
67ddeb6735 | |||
8179a4344b | |||
688d8901b7 | |||
687b8384bc | |||
1c3017323c | |||
c8bd177a93 | |||
c31ed9a79a | |||
139c158d8a | |||
e5400e345b | |||
017098a587 | |||
bb8f2fd17c | |||
d9da3fa35b | |||
0f7e72fc0d | |||
d9f72e94fa | |||
1c8cdfa6dd | |||
b6a30bf989 | |||
4eb0d6a368 | |||
849f8bef07 | |||
9eee74ba61 | |||
34c26bbd30 | |||
caa3d3324f | |||
25b022203a | |||
e61496688d | |||
29bef7450a | |||
6edc921a79 | |||
0f0ce521d6 | |||
c3f119bedc | |||
1701399b82 | |||
0b70f722f9 | |||
cecfd627e4 | |||
fb7213a1d2 | |||
1aa742342c | |||
230cd09cb5 | |||
d67ed0c2df | |||
b1d6e3caaa | |||
542538bf5c | |||
76404d01bf | |||
ab948e467c | |||
0d221e684d | |||
5332504c5a | |||
0082261007 | |||
052b17d5c1 | |||
7516e5d00d | |||
1bd16cec68 | |||
0d1637bd71 | |||
60db7e6c90 | |||
607ae32450 | |||
64bf745dce | |||
0ec4c5d795 | |||
afc10aaf26 | |||
e48a1b685b | |||
d129ade861 | |||
f394400b2b | |||
b56c45b4ee | |||
a48b86b5d4 | |||
6e74993d99 | |||
6fd2681449 | |||
a194302a41 |
@ -5,6 +5,9 @@ docker-compose*
|
||||
env
|
||||
test-configuration
|
||||
.netbox/.git*
|
||||
.netbox/.pre-commit-config.yaml
|
||||
.netbox/.readthedocs.yaml
|
||||
.netbox/.tx
|
||||
.netbox/contrib
|
||||
.netbox/scripts
|
||||
.netbox/upgrade.sh
|
||||
|
@ -9,3 +9,6 @@ indent_size = 2
|
||||
|
||||
[*.py]
|
||||
indent_size = 4
|
||||
|
||||
[VERSION]
|
||||
insert_final_newline = false
|
||||
|
@ -2,17 +2,12 @@
|
||||
"Verbose": false,
|
||||
"Debug": false,
|
||||
"IgnoreDefaults": false,
|
||||
"SpacesAftertabs": false,
|
||||
"SpacesAfterTabs": false,
|
||||
"NoColor": false,
|
||||
"Exclude": [
|
||||
"LICENSE",
|
||||
"\\.initializers",
|
||||
"\\.vscode"
|
||||
],
|
||||
"Exclude": ["LICENSE", "\\.initializers", "\\.vscode"],
|
||||
"AllowedContentTypes": [],
|
||||
"PassedFiles": [],
|
||||
"Disable": {
|
||||
// set these options to true to disable specific checks
|
||||
"EndOfLine": false,
|
||||
"Indentation": false,
|
||||
"InsertFinalNewline": false,
|
3
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
3
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
@ -48,7 +48,7 @@ body:
|
||||
id: docker-compose-version
|
||||
attributes:
|
||||
label: Docker Compose Version
|
||||
description: Please paste the output of `docker-compose version`
|
||||
description: Please paste the output of `docker-compose version` (or `docker compose version`)
|
||||
placeholder: Docker Compose version vX.Y.Z
|
||||
validations:
|
||||
required: true
|
||||
@ -139,7 +139,6 @@ body:
|
||||
description: Please paste the output of `cat docker-compose.override.yml`
|
||||
render: yaml
|
||||
placeholder: |
|
||||
version: '3.4'
|
||||
services:
|
||||
netbox:
|
||||
ports:
|
||||
|
26
.github/workflows/push.yml
vendored
26
.github/workflows/push.yml
vendored
@ -16,19 +16,20 @@ concurrency:
|
||||
|
||||
jobs:
|
||||
lint:
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: ubuntu-24.04
|
||||
name: Checks syntax of our code
|
||||
permissions:
|
||||
contents: read
|
||||
packages: read
|
||||
statuses: write
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
# Full git history is needed to get a proper
|
||||
# list of changed files within `super-linter`
|
||||
fetch-depth: 0
|
||||
- uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: "3.9"
|
||||
- name: Lint Code Base
|
||||
uses: github/super-linter@v7
|
||||
uses: super-linter/super-linter@v7
|
||||
env:
|
||||
DEFAULT_BRANCH: develop
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
@ -40,7 +41,7 @@ jobs:
|
||||
VALIDATE_GITLEAKS: false
|
||||
VALIDATE_JSCPD: false
|
||||
FILTER_REGEX_EXCLUDE: (.*/)?(LICENSE|configuration/.*)
|
||||
EDITORCONFIG_FILE_NAME: .ecrc
|
||||
EDITORCONFIG_FILE_NAME: .editorconfig-checker.json
|
||||
DOCKERFILE_HADOLINT_FILE_NAME: .hadolint.yaml
|
||||
MARKDOWN_CONFIG_FILE: .markdown-lint.yml
|
||||
PYTHON_BLACK_CONFIG_FILE: pyproject.toml
|
||||
@ -57,8 +58,8 @@ jobs:
|
||||
- ./build.sh feature
|
||||
- ./build.sh main
|
||||
os:
|
||||
- ubuntu-latest
|
||||
- self-hosted
|
||||
- ubuntu-24.04
|
||||
- ubuntu-24.04-arm
|
||||
fail-fast: false
|
||||
env:
|
||||
GH_ACTION: enable
|
||||
@ -73,9 +74,14 @@ jobs:
|
||||
- id: buildx-setup
|
||||
name: Set up Docker Buildx
|
||||
uses: docker/setup-buildx-action@v3
|
||||
- id: arm-install-skopeo
|
||||
name: Install 'skopeo' on ARM64
|
||||
if: matrix.os == 'ubuntu-24.04-arm'
|
||||
run: |
|
||||
sudo apt-get install -y skopeo
|
||||
- id: arm-buildx-platform
|
||||
name: Set BUILDX_PLATFORM to ARM64
|
||||
if: matrix.os == 'self-hosted'
|
||||
if: matrix.os == 'ubuntu-24.04-arm'
|
||||
run: |
|
||||
echo "BUILDX_PLATFORM=linux/arm64" >>"${GITHUB_ENV}"
|
||||
- id: docker-build
|
||||
@ -85,7 +91,7 @@ jobs:
|
||||
BUILDX_BUILDER_NAME: ${{ steps.buildx-setup.outputs.name }}
|
||||
- id: arm-time-limit
|
||||
name: Set Netbox container start_period higher on ARM64
|
||||
if: matrix.os == 'self-hosted'
|
||||
if: matrix.os == 'ubuntu-24.04-arm'
|
||||
run: |
|
||||
echo "NETBOX_START_PERIOD=240s" >>"${GITHUB_ENV}"
|
||||
- id: docker-test
|
||||
|
22
.github/workflows/release.yml
vendored
22
.github/workflows/release.yml
vendored
@ -13,15 +13,17 @@ jobs:
|
||||
build:
|
||||
strategy:
|
||||
matrix:
|
||||
build_cmd:
|
||||
- ./build-latest.sh
|
||||
- PRERELEASE=true ./build-latest.sh
|
||||
- ./build.sh feature
|
||||
- ./build.sh main
|
||||
build:
|
||||
- { "cmd": "./build-latest.sh", "branch": "release" }
|
||||
- { "cmd": "./build.sh main", "branch": "release" }
|
||||
# Build pre release images from our develop branch
|
||||
# This is used to test the latest changes before they are merged into the main branch
|
||||
- { "cmd": "PRERELEASE=true ./build-latest.sh", "branch": "develop" }
|
||||
- { "cmd": "./build.sh feature", "branch": "develop" }
|
||||
platform:
|
||||
- linux/amd64,linux/arm64
|
||||
fail-fast: false
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: ubuntu-24.04
|
||||
name: Builds new NetBox Docker Images
|
||||
env:
|
||||
GH_ACTION: enable
|
||||
@ -31,15 +33,17 @@ jobs:
|
||||
- id: source-checkout
|
||||
name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
ref: ${{ matrix.build.branch }}
|
||||
- id: set-netbox-docker-version
|
||||
name: Get Version of NetBox Docker
|
||||
run: echo "version=$(cat VERSION)" >>"$GITHUB_OUTPUT"
|
||||
shell: bash
|
||||
- id: check-build-needed
|
||||
name: Check if the build is needed for '${{ matrix.build_cmd }}'
|
||||
name: Check if the build is needed for '${{ matrix.build.cmd }}'
|
||||
env:
|
||||
CHECK_ONLY: "true"
|
||||
run: ${{ matrix.build_cmd }}
|
||||
run: ${{ matrix.build.cmd }}
|
||||
# docker.io
|
||||
- id: docker-io-login
|
||||
name: Login to docker.io
|
||||
@ -77,7 +81,7 @@ jobs:
|
||||
if: steps.check-build-needed.outputs.skipped != 'true'
|
||||
- id: build-and-push
|
||||
name: Push the image
|
||||
run: ${{ matrix.build_cmd }} --push
|
||||
run: ${{ matrix.build.cmd }} --push
|
||||
if: steps.check-build-needed.outputs.skipped != 'true'
|
||||
env:
|
||||
BUILDX_PLATFORM: ${{ matrix.platform }}
|
||||
|
39
Dockerfile
39
Dockerfile
@ -1,6 +1,7 @@
|
||||
ARG FROM
|
||||
FROM ${FROM} AS builder
|
||||
|
||||
COPY --from=ghcr.io/astral-sh/uv:0.7 /uv /usr/local/bin/
|
||||
RUN export DEBIAN_FRONTEND=noninteractive \
|
||||
&& apt-get update -qq \
|
||||
&& apt-get upgrade \
|
||||
@ -20,16 +21,11 @@ RUN export DEBIAN_FRONTEND=noninteractive \
|
||||
libxslt-dev \
|
||||
pkg-config \
|
||||
python3-dev \
|
||||
python3-pip \
|
||||
python3-venv \
|
||||
&& python3 -m venv /opt/netbox/venv \
|
||||
&& /opt/netbox/venv/bin/python3 -m pip install --upgrade \
|
||||
pip \
|
||||
setuptools \
|
||||
wheel
|
||||
&& /usr/local/bin/uv venv /opt/netbox/venv
|
||||
|
||||
ARG NETBOX_PATH
|
||||
COPY ${NETBOX_PATH}/requirements.txt requirements-container.txt /
|
||||
ENV VIRTUAL_ENV=/opt/netbox/venv
|
||||
RUN \
|
||||
# Gunicorn is not needed because we use Nginx Unit
|
||||
sed -i -e '/gunicorn/d' /requirements.txt && \
|
||||
@ -37,7 +33,9 @@ RUN \
|
||||
# we have potential version conflicts and the build will fail.
|
||||
# That's why we just replace it in the original requirements.txt.
|
||||
sed -i -e 's/social-auth-core/social-auth-core\[all\]/g' /requirements.txt && \
|
||||
/opt/netbox/venv/bin/pip install \
|
||||
# The same is true for 'django-storages'
|
||||
sed -i -e 's/django-storages/django-storages\[azure,boto3,dropbox,google,libcloud,sftp\]/g' /requirements.txt && \
|
||||
/usr/local/bin/uv pip install \
|
||||
-r /requirements.txt \
|
||||
-r /requirements-container.txt
|
||||
|
||||
@ -48,6 +46,8 @@ RUN \
|
||||
ARG FROM
|
||||
FROM ${FROM} AS main
|
||||
|
||||
COPY docker/unit.list /etc/apt/sources.list.d/unit.list
|
||||
ADD --chmod=444 --chown=0:0 https://unit.nginx.org/keys/nginx-keyring.gpg /usr/share/keyrings/nginx-keyring.gpg
|
||||
RUN export DEBIAN_FRONTEND=noninteractive \
|
||||
&& apt-get update -qq \
|
||||
&& apt-get upgrade \
|
||||
@ -64,23 +64,17 @@ RUN export DEBIAN_FRONTEND=noninteractive \
|
||||
openssl \
|
||||
python3 \
|
||||
tini \
|
||||
&& curl --silent --output /usr/share/keyrings/nginx-keyring.gpg \
|
||||
https://unit.nginx.org/keys/nginx-keyring.gpg \
|
||||
&& echo "deb [signed-by=/usr/share/keyrings/nginx-keyring.gpg] https://packages.nginx.org/unit/ubuntu/ noble unit" \
|
||||
> /etc/apt/sources.list.d/unit.list \
|
||||
&& apt-get update -qq \
|
||||
&& apt-get install \
|
||||
--yes -qq --no-install-recommends \
|
||||
unit=1.34.0-1~noble \
|
||||
unit-python3.12=1.34.0-1~noble \
|
||||
unit-python3.12=1.34.2-1~noble \
|
||||
unit=1.34.2-1~noble \
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
|
||||
# Copy the modified 'requirements*.txt' files, to have the files actually used during installation
|
||||
COPY --from=builder /requirements.txt /requirements-container.txt /opt/netbox/
|
||||
COPY --from=builder /usr/local/bin/uv /usr/local/bin/
|
||||
COPY --from=builder /opt/netbox/venv /opt/netbox/venv
|
||||
|
||||
ARG NETBOX_PATH
|
||||
COPY ${NETBOX_PATH} /opt/netbox
|
||||
# Copy the modified 'requirements*.txt' files, to have the files actually used during installation
|
||||
COPY --from=builder /requirements.txt /requirements-container.txt /opt/netbox/
|
||||
|
||||
COPY docker/configuration.docker.py /opt/netbox/netbox/netbox/configuration.py
|
||||
COPY docker/ldap_config.docker.py /opt/netbox/netbox/netbox/ldap_config.py
|
||||
@ -89,6 +83,7 @@ COPY docker/housekeeping.sh /opt/netbox/housekeeping.sh
|
||||
COPY docker/launch-netbox.sh /opt/netbox/launch-netbox.sh
|
||||
COPY configuration/ /etc/netbox/config/
|
||||
COPY docker/nginx-unit.json /etc/unit/
|
||||
COPY VERSION /opt/netbox/VERSION
|
||||
|
||||
WORKDIR /opt/netbox/netbox
|
||||
|
||||
@ -99,9 +94,11 @@ RUN mkdir -p static /opt/unit/state/ /opt/unit/tmp/ \
|
||||
&& chmod -R g+w /opt/unit/ media reports scripts \
|
||||
&& cd /opt/netbox/ && SECRET_KEY="dummyKeyWithMinimumLength-------------------------" /opt/netbox/venv/bin/python -m mkdocs build \
|
||||
--config-file /opt/netbox/mkdocs.yml --site-dir /opt/netbox/netbox/project-static/docs/ \
|
||||
&& SECRET_KEY="dummyKeyWithMinimumLength-------------------------" /opt/netbox/venv/bin/python /opt/netbox/netbox/manage.py collectstatic --no-input
|
||||
&& DEBUG="true" SECRET_KEY="dummyKeyWithMinimumLength-------------------------" /opt/netbox/venv/bin/python /opt/netbox/netbox/manage.py collectstatic --no-input \
|
||||
&& mkdir /opt/netbox/netbox/local \
|
||||
&& echo "build: Docker-$(cat /opt/netbox/VERSION)" > /opt/netbox/netbox/local/release.yaml
|
||||
|
||||
ENV LANG=C.utf8 PATH=/opt/netbox/venv/bin:$PATH
|
||||
ENV LANG=C.utf8 PATH=/opt/netbox/venv/bin:$PATH VIRTUAL_ENV=/opt/netbox/venv UV_NO_CACHE=1
|
||||
ENTRYPOINT [ "/usr/bin/tini", "--" ]
|
||||
|
||||
CMD [ "/opt/netbox/docker-entrypoint.sh", "/opt/netbox/launch-netbox.sh" ]
|
||||
|
19
MAINTAINERS.md
Normal file
19
MAINTAINERS.md
Normal file
@ -0,0 +1,19 @@
|
||||
# Maintainers of _NetBox Docker_
|
||||
|
||||
This file lists all currently recognized maintainers of the _NetBox Docker_ project in alphabetical order:
|
||||
|
||||
- @cimnine
|
||||
- @tobiasge
|
||||
|
||||
## Stepping Down
|
||||
|
||||
Every maintainer is a volunteer and may step down as maintainer at any time without providing any reason.
|
||||
To make this explicit, the maintainer is asked to update this file.
|
||||
|
||||
The last maintainer stepping down is asked to archive the project on GitHub to indicate that the project is no longer maintained.
|
||||
|
||||
## Signing up
|
||||
|
||||
Everyone is welcome to sign up as maintainer by creating a PR and add their own username to the list.
|
||||
The current maintainers shall discuss the application.
|
||||
They may turn down an application if they don't feel confident that the new maintainer is a positive addition.
|
71
PRINCIPALS.md
Normal file
71
PRINCIPALS.md
Normal file
@ -0,0 +1,71 @@
|
||||
# Development, Maintenance and Community Principals for _NetBox Docker_
|
||||
|
||||
These principals shall guide the development and the maintenance of _NetBox Docker_.
|
||||
|
||||
## Basic principals
|
||||
|
||||
This project is maintained on voluntary basis.
|
||||
Everyone is asked to respect that.
|
||||
|
||||
This means, that …
|
||||
|
||||
- … sometimes features are not implemented as fast as one might like -- or not at all.
|
||||
- … sometimes nobody is looking at bugs, or they are not fixed as fast as one might like -- or not at all.
|
||||
- … sometimes PRs are not reviewed for an extended period.
|
||||
|
||||
Everyone is welcome to provide improvements and bugfixes to the benefit of everyone else.
|
||||
|
||||
## Development Principals
|
||||
|
||||
The goal of the _NetBox Docker_ project is to provide a container to run the basic NetBox project.
|
||||
The container should feel like a native container -- as if it were provided by NetBox itself:
|
||||
|
||||
- Configuration via environment variables where feasible.
|
||||
- Except: Whenever a complex type such as a `dict` is required as value of a configuration setting,
|
||||
then it shall not be provided through an environment variable.
|
||||
- Configuration of secrets via secret files.
|
||||
- Log output to standard out (STDOUT/`&1`) / standard error (STDERR/`&2`).
|
||||
- Volumes for data and cache directories.
|
||||
- Otherwise, no mounts shall be necessary.
|
||||
- Runs a non-root user by default.
|
||||
- One process / role for each instance.
|
||||
|
||||
The container generally does not provide more features than the basic NetBox project itself provides.
|
||||
It may provide additional Python dependencies than the upstream project,
|
||||
so that all configurable features of NetBox can be used in the container without further modification.
|
||||
The container may provide helpers, so that it feels and behaves like a native container.
|
||||
|
||||
The container does not bundle any community plugins.
|
||||
|
||||
## Maintenance Principals
|
||||
|
||||
The main goals of maintaining _NetBox Docker_ are:
|
||||
|
||||
- Keeping the project at a high quality level.
|
||||
- Keeping the maintenance effort minimal.
|
||||
- Coordinating development efforts.
|
||||
|
||||
The following guidelines help us to achieve these goals:
|
||||
|
||||
- As many maintenance tasks as possible shall be automated or scripted.
|
||||
- All manual tasks must be documented.
|
||||
- All changes are reviewed by at least one maintainer.
|
||||
- Changes of maintainers are reviewed by at least one other maintainer.
|
||||
(Except if there's only one maintainer left.)
|
||||
- The infrastructure beyond what GitHub provides shall be kept to a minimum.
|
||||
- On request, every maintainer shall get access to infrastructure that is beyond GitHub
|
||||
(at the time of writing that's _Docker Hub_ and _Quay_ in particular).
|
||||
|
||||
## Community Principals
|
||||
|
||||
This project is developed by the NetBox community for the NetBox community.
|
||||
We welcome contributions, as long as they are in line with the principals above.
|
||||
|
||||
The maintainers of NetBox Docker are not the support team.
|
||||
The community is expected to help each other out.
|
||||
|
||||
Always remember:
|
||||
Behind every screen (or screen-reader) on the other end is a fellow human.
|
||||
Be nice and respectful, thankful for help,
|
||||
and value ideas and contributions,
|
||||
even when they don't fit the goals.
|
53
README.md
53
README.md
@ -8,11 +8,16 @@
|
||||
[][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].
|
||||
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].
|
||||
_NetBox Docker_ is a project developed and maintained by the _NetBox_ community.
|
||||
|
||||
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.
|
||||
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,
|
||||
or start a new [GitHub Discussion][github-discussions].
|
||||
|
||||
[github-stargazers]: https://github.com/netbox-community/netbox-docker/stargazers
|
||||
[github-release]: https://github.com/netbox-community/netbox-docker/releases
|
||||
@ -24,6 +29,7 @@ please join [our Slack][netbox-docker-slack] and ask for help in the [`#netbox-d
|
||||
[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
|
||||
[github-discussions]: https://github.com/netbox-community/netbox-docker/discussions
|
||||
|
||||
## Quickstart
|
||||
|
||||
@ -53,7 +59,8 @@ To create the first admin user run this command:
|
||||
docker compose exec netbox /opt/netbox/netbox/manage.py createsuperuser
|
||||
```
|
||||
|
||||
If you need to restart Netbox from an empty database often, you can also set the `SUPERUSER_*` variables in your `docker-compose.override.yml` as shown in the example.
|
||||
If you need to restart Netbox from an empty database often,
|
||||
you can also set the `SUPERUSER_*` variables in your `docker-compose.override.yml`.
|
||||
|
||||
[wiki-getting-started]: https://github.com/netbox-community/netbox-docker/wiki/Getting-Started
|
||||
|
||||
@ -63,37 +70,34 @@ 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 prerelease 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.
|
||||
These images are automatically built from the [`develop` branch of NetBox][netbox-develop].
|
||||
These images are automatically built from the [`main` branch of NetBox][netbox-main].
|
||||
|
||||
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_.
|
||||
|
||||
[netbox-releases]: https://github.com/netbox-community/netbox/releases
|
||||
[netbox-master]: https://github.com/netbox-community/netbox/tree/master
|
||||
[netbox-develop]: https://github.com/netbox-community/netbox/tree/develop
|
||||
[netbox-main]: https://github.com/netbox-community/netbox/tree/main
|
||||
|
||||
## Documentation
|
||||
|
||||
@ -109,7 +113,7 @@ Feel free to correct errors, update outdated information or provide additional g
|
||||
|
||||
Feel free to ask questions in our [GitHub Community][netbox-community]
|
||||
or [join our Slack][netbox-docker-slack] and ask [in our channel `#netbox-docker`][netbox-docker-slack-channel],
|
||||
which is free to use and where there are almost always people online that can help you in the Slack channel.
|
||||
which is free to use and where there are almost always people online that can help you.
|
||||
|
||||
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.
|
||||
@ -120,16 +124,16 @@ you may find [the `#netbox` channel][netbox-slack-channel] on the same Slack ins
|
||||
|
||||
This project relies only on _Docker_ and _docker-compose_ meeting these requirements:
|
||||
|
||||
* The _Docker version_ must be at least `20.10.10`.
|
||||
* The _containerd version_ must be at least `1.5.6`.
|
||||
* The _docker-compose version_ must be at least `1.28.0`.
|
||||
- The _Docker version_ must be at least `20.10.10`.
|
||||
- The _containerd version_ must be at least `1.5.6`.
|
||||
- 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`.
|
||||
|
||||
## Updating
|
||||
|
||||
Please read [the release notes][releases] carefully when updating to a new image version.
|
||||
Note that the version of the NetBox Docker container image must stay in sync with the code.
|
||||
Note that the version of the NetBox Docker container image must stay in sync with the version of the Git repository.
|
||||
|
||||
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].
|
||||
|
||||
@ -138,7 +142,8 @@ If you update for the first time, be sure [to follow our _How To Update NetBox D
|
||||
|
||||
## Rebuilding the Image
|
||||
|
||||
`./build.sh` can be used to rebuild the container image. See `./build.sh --help` for more information.
|
||||
`./build.sh` can be used to rebuild the container image.
|
||||
See `./build.sh --help` for more information or `./build-latest.sh` for an example.
|
||||
|
||||
For more details on custom builds [consult our wiki][netbox-docker-wiki-build].
|
||||
|
||||
@ -147,13 +152,15 @@ 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 NetBox starts:
|
||||
|
||||
```bash
|
||||
IMAGE=netboxcommunity/netbox:latest ./test.sh
|
||||
IMAGE=docker.io/netboxcommunity/netbox:latest ./test.sh
|
||||
```
|
||||
|
||||
## Support
|
||||
|
||||
This repository is currently maintained by the community.
|
||||
The community is expected to help each other.
|
||||
|
||||
Please consider sponsoring the maintainers of this project.
|
||||
|
5
actionlint.yml
Normal file
5
actionlint.yml
Normal file
@ -0,0 +1,5 @@
|
||||
---
|
||||
paths:
|
||||
.github/workflows/**/*.{yml,yaml}:
|
||||
ignore:
|
||||
- ".*ubuntu-24.04-arm.*"
|
@ -348,3 +348,5 @@ SESSION_FILE_PATH = environ.get('SESSION_FILE_PATH', environ.get('SESSIONS_ROOT'
|
||||
# Time zone (default: UTC)
|
||||
TIME_ZONE = environ.get('TIME_ZONE', 'UTC')
|
||||
|
||||
# If true disables miscellaneous functionality which depends on access to the Internet.
|
||||
ISOLATED_DEPLOYMENT = _environ_get_and_map('ISOLATED_DEPLOYMENT', 'False', _AS_BOOL)
|
||||
|
@ -49,7 +49,7 @@ services:
|
||||
retries: 5
|
||||
|
||||
redis: &redis
|
||||
image: docker.io/valkey/valkey:8.0-alpine
|
||||
image: docker.io/valkey/valkey:8.1-alpine
|
||||
command:
|
||||
- sh
|
||||
- -c # this is to evaluate the $REDIS_PASSWORD from the env
|
||||
|
@ -1,8 +1,7 @@
|
||||
services:
|
||||
netbox: &netbox
|
||||
image: docker.io/netboxcommunity/netbox:${VERSION-v4.2-3.1.0}
|
||||
image: docker.io/netboxcommunity/netbox:${VERSION-v4.3-3.3.0}
|
||||
depends_on:
|
||||
- postgres
|
||||
- redis
|
||||
- redis-cache
|
||||
env_file: env/netbox.env
|
||||
@ -44,22 +43,9 @@ services:
|
||||
timeout: 3s
|
||||
interval: 15s
|
||||
|
||||
# postgres
|
||||
postgres:
|
||||
image: docker.io/postgres:17-alpine
|
||||
healthcheck:
|
||||
test: pg_isready -q -t 2 -d $$POSTGRES_DB -U $$POSTGRES_USER
|
||||
start_period: 20s
|
||||
timeout: 30s
|
||||
interval: 10s
|
||||
retries: 5
|
||||
env_file: env/postgres.env
|
||||
volumes:
|
||||
- netbox-postgres-data:/var/lib/postgresql/data
|
||||
|
||||
# redis
|
||||
redis:
|
||||
image: docker.io/valkey/valkey:8.0-alpine
|
||||
image: docker.io/valkey/valkey:8.1-alpine
|
||||
command:
|
||||
- sh
|
||||
- -c # this is to evaluate the $REDIS_PASSWORD from the env
|
||||
@ -74,7 +60,7 @@ services:
|
||||
volumes:
|
||||
- netbox-redis-data:/data
|
||||
redis-cache:
|
||||
image: docker.io/valkey/valkey:8.0-alpine
|
||||
image: docker.io/valkey/valkey:8.1-alpine
|
||||
command:
|
||||
- sh
|
||||
- -c # this is to evaluate the $REDIS_PASSWORD from the env
|
||||
@ -87,8 +73,6 @@ services:
|
||||
volumes:
|
||||
netbox-media-files:
|
||||
driver: local
|
||||
netbox-postgres-data:
|
||||
driver: local
|
||||
netbox-redis-cache-data:
|
||||
driver: local
|
||||
netbox-redis-data:
|
||||
|
@ -1,6 +1,6 @@
|
||||
{
|
||||
"listeners": {
|
||||
"*:8080": {
|
||||
"0.0.0.0:8080": {
|
||||
"pass": "routes/main",
|
||||
"forwarded": {
|
||||
"client_ip": "X-Forwarded-For",
|
||||
@ -8,13 +8,29 @@
|
||||
"source": ["10.0.0.0/8", "172.16.0.0/12", "192.168.0.0/16"]
|
||||
}
|
||||
},
|
||||
"*:8081": {
|
||||
"0.0.0.0:8081": {
|
||||
"pass": "routes/status",
|
||||
"forwarded": {
|
||||
"client_ip": "X-Forwarded-For",
|
||||
"protocol": "X-Forwarded-Proto",
|
||||
"source": ["10.0.0.0/8", "172.16.0.0/12", "192.168.0.0/16"]
|
||||
}
|
||||
},
|
||||
"[::]:8080": {
|
||||
"pass": "routes/main",
|
||||
"forwarded": {
|
||||
"client_ip": "X-Forwarded-For",
|
||||
"protocol": "X-Forwarded-Proto",
|
||||
"source": ["fc00::/7", "fe80::/10"]
|
||||
}
|
||||
},
|
||||
"[::]:8081": {
|
||||
"pass": "routes/status",
|
||||
"forwarded": {
|
||||
"client_ip": "X-Forwarded-For",
|
||||
"protocol": "X-Forwarded-Proto",
|
||||
"source": ["fc00::/7", "fe80::/10"]
|
||||
}
|
||||
}
|
||||
},
|
||||
"routes": {
|
||||
|
1
docker/unit.list
Normal file
1
docker/unit.list
Normal file
@ -0,0 +1 @@
|
||||
deb [signed-by=/usr/share/keyrings/nginx-keyring.gpg] http://packages.nginx.org/unit/ubuntu/ noble unit
|
24
env/docker-compose.override.yml
vendored
Normal file
24
env/docker-compose.override.yml
vendored
Normal file
@ -0,0 +1,24 @@
|
||||
version: '3.4'
|
||||
services:
|
||||
netbox:
|
||||
ports:
|
||||
- 8085:8080
|
||||
volumes:
|
||||
- /media/nfs/netbox/config:/etc/netbox/config:z,ro
|
||||
- /media/nfs/netbox/media:/opt/netbox/netbox/media:z,rw
|
||||
- /media/nfs/netbox/reports:/opt/netbox/netbox/reports:z,rw
|
||||
- /media/nfs/netbox/scripts:/opt/netbox/netbox/scripts:z,rw
|
||||
healthcheck:
|
||||
retries: 15
|
||||
netbox-worker:
|
||||
volumes:
|
||||
- /media/nfs/netbox/config:/etc/netbox/config:z,ro
|
||||
- /media/nfs/netbox/media:/opt/netbox/netbox/media:z,rw
|
||||
- /media/nfs/netbox/reports:/opt/netbox/netbox/reports:z,rw
|
||||
- /media/nfs/netbox/scripts:/opt/netbox/netbox/scripts:z,rw
|
||||
netbox-housekeeping:
|
||||
volumes:
|
||||
- /media/nfs/netbox/config:/etc/netbox/config:z,ro
|
||||
- /media/nfs/netbox/media:/opt/netbox/netbox/media:z,rw
|
||||
- /media/nfs/netbox/reports:/opt/netbox/netbox/reports:z,rw
|
||||
- /media/nfs/netbox/scripts:/opt/netbox/netbox/scripts:z,rw
|
6
env/netbox.env
vendored
6
env/netbox.env
vendored
@ -1,7 +1,7 @@
|
||||
CORS_ORIGIN_ALLOW_ALL=True
|
||||
DB_HOST=postgres
|
||||
DB_HOST=192.168.0.52
|
||||
DB_NAME=netbox
|
||||
DB_PASSWORD=J5brHrAXFLQSif0K
|
||||
DB_PASSWORD=netbox
|
||||
DB_USER=netbox
|
||||
EMAIL_FROM=netbox@bar.com
|
||||
EMAIL_PASSWORD=
|
||||
@ -30,5 +30,5 @@ REDIS_PASSWORD=H733Kdjndks81
|
||||
REDIS_SSL=false
|
||||
RELEASE_CHECK_URL=https://api.github.com/repos/netbox-community/netbox/releases
|
||||
SECRET_KEY='r(m)9nLGnz$(_q3N4z1k(EFsMCjjjzx08x9VhNVcfd%6RF#r!6DE@+V5Zk2X'
|
||||
SKIP_SUPERUSER=true
|
||||
SKIP_SUPERUSER=false
|
||||
WEBHOOKS_ENABLED=true
|
||||
|
@ -1,5 +1,6 @@
|
||||
django-auth-ldap==5.1.0
|
||||
django-storages[azure,boto3,dropbox,google,libcloud,sftp]==1.14.4
|
||||
dulwich==0.22.7
|
||||
python3-saml==1.16.0 --no-binary lxml,xmlsec
|
||||
sentry-sdk[django]==2.19.2
|
||||
dulwich==0.22.8
|
||||
python3-saml==1.16.0
|
||||
--no-binary lxml
|
||||
--no-binary xmlsec
|
||||
sentry-sdk[django]==2.27.0
|
||||
|
@ -3,4 +3,10 @@ LOGGING = {
|
||||
'disable_existing_loggers': True
|
||||
}
|
||||
|
||||
PLUGINS = [
|
||||
'netbox.tests.dummy_plugin',
|
||||
]
|
||||
|
||||
ALLOW_TOKEN_RETRIEVAL = True
|
||||
|
||||
DEFAULT_PERMISSIONS = {}
|
||||
|
Reference in New Issue
Block a user