.github/ISSUE_TEMPLATE/config.yml

@@ -6,7 +6,7 @@ contact_links:
 
   - name: Chat
     url: https://join.slack.com/t/netdev-community/shared_invite/zt-mtts8g0n-Sm6Wutn62q_M4OdsaIycrQ
-    about: "Usually the quickest way to seek help with small issues is to join our #netbox-docker Slack channel."
+    about: 'Usually the quickest way to seek help with small issues is to join our #netbox-docker Slack channel.'
 
   - name: Community Wiki
     url: https://github.com/netbox-community/netbox-docker/wiki

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -57,7 +57,7 @@ body:
 - type: textarea
   id: discussion
   attributes:
-      label: "Discussion: Benefits and Drawbacks"
+    label: 'Discussion: Benefits and Drawbacks'
     description: |
       Please make your case here:
       - Why do you think this project and the community will benefit from your suggestion?

.github/pull_request_template.md

@@ -80,6 +80,6 @@ into the release notes.
 Please put an x into the brackets (like `[x]`) if you've completed that task.
 -->
 
-- [ ] I have read the comments and followed the PR template.
+* [ ] I have read the comments and followed the PR template.
-- [ ] I have explained my PR according to the information in the comments.
+* [ ] I have explained my PR according to the information in the comments.
-- [ ] My PR targets the `develop` branch.
+* [ ] My PR targets the `develop` branch.

.github/workflows/push.yml

@@ -26,9 +26,9 @@ jobs:
           fetch-depth: 0
       - uses: actions/setup-python@v5
         with:
-          python-version: "3.9"
+          python-version: '3.9'
       - name: Lint Code Base
-        uses: github/super-linter@v7
+        uses: github/super-linter@v6
         env:
           DEFAULT_BRANCH: develop
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release.yml

@@ -6,7 +6,7 @@ on:
     types:
       - published
   schedule:
-    - cron: "45 5 * * *"
+    - cron: '45 5 * * *'
   workflow_dispatch:
 
 jobs:
@@ -35,11 +35,19 @@ jobs:
         name: Get Version of NetBox Docker
         run: echo "version=$(cat VERSION)" >>"$GITHUB_OUTPUT"
         shell: bash
-      - id: check-build-needed
+      - id: qemu-setup
-        name: Check if the build is needed for '${{ matrix.build_cmd }}'
+        name: Set up QEMU
-        env:
+        uses: docker/setup-qemu-action@v3
-          CHECK_ONLY: "true"
+      - id: buildx-setup
+        name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      - id: docker-build
+        name: Build the image with '${{ matrix.build_cmd }}'
         run: ${{ matrix.build_cmd }}
+      - id: test-image
+        name: Test the image
+        run: IMAGE="${FINAL_DOCKER_TAG}" ./test.sh
+        if: steps.docker-build.outputs.skipped != 'true'
       # docker.io
       - id: docker-io-login
         name: Login to docker.io
@@ -48,15 +56,7 @@ jobs:
           registry: docker.io
           username: ${{ secrets.dockerhub_username }}
           password: ${{ secrets.dockerhub_password }}
-        if: steps.check-build-needed.outputs.skipped != 'true'
+        if: steps.docker-build.outputs.skipped != 'true'
-      - id: buildx-setup
-        name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3
-        with:
-          version: "lab:latest"
-          driver: cloud
-          endpoint: "netboxcommunity/netbox-default"
-        if: steps.check-build-needed.outputs.skipped != 'true'
       # quay.io
       - id: quay-io-login
         name: Login to Quay.io
@@ -65,7 +65,7 @@ jobs:
           registry: quay.io
           username: ${{ secrets.quayio_username }}
           password: ${{ secrets.quayio_password }}
-        if: steps.check-build-needed.outputs.skipped != 'true'
+        if: steps.docker-build.outputs.skipped != 'true'
       # ghcr.io
       - id: ghcr-io-login
         name: Login to GitHub Container Registry
@@ -74,11 +74,11 @@ jobs:
           registry: ghcr.io
           username: ${{ github.repository_owner }}
           password: ${{ secrets.GITHUB_TOKEN }}
-        if: steps.check-build-needed.outputs.skipped != 'true'
+        if: steps.docker-build.outputs.skipped != 'true'
       - id: build-and-push
         name: Push the image
         run: ${{ matrix.build_cmd }} --push
-        if: steps.check-build-needed.outputs.skipped != 'true'
+        if: steps.docker-build.outputs.skipped != 'true'
         env:
           BUILDX_PLATFORM: ${{ matrix.platform }}
           BUILDX_BUILDER_NAME: ${{ steps.buildx-setup.outputs.name }}

.gitignore

@@ -1,6 +1,7 @@
 *.sql.gz
 .netbox
 .python-version
+docker-compose.override.yml
 *.pem
 configuration/*
 !configuration/configuration.py

.yamllint.yaml

@@ -1,4 +1,5 @@
 ---
+
 rules:
   line-length:
-    max: 160
+    max: 120

Dockerfile

@@ -1,5 +1,5 @@
 ARG FROM
-FROM ${FROM} AS builder
+FROM ${FROM} as builder
 
 RUN export DEBIAN_FRONTEND=noninteractive \
     && apt-get update -qq \
@@ -46,7 +46,7 @@ RUN \
 ###
 
 ARG FROM
-FROM ${FROM} AS main
+FROM ${FROM} as main
 
 RUN export DEBIAN_FRONTEND=noninteractive \
     && apt-get update -qq \
@@ -63,16 +63,17 @@ RUN export DEBIAN_FRONTEND=noninteractive \
       openssh-client \
       openssl \
       python3 \
+      python3-distutils \
       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" \
+    && echo "deb [signed-by=/usr/share/keyrings/nginx-keyring.gpg] https://packages.nginx.org/unit/ubuntu/ mantic unit" \
       > /etc/apt/sources.list.d/unit.list \
     && apt-get update -qq \
     && apt-get install \
       --yes -qq --no-install-recommends \
-      unit=1.33.0-1~noble \
+      unit=1.32.0-1~mantic \
-      unit-python3.12=1.33.0-1~noble \
+      unit-python3.11=1.32.0-1~mantic \
     && rm -rf /var/lib/apt/lists/*
 
 COPY --from=builder /opt/netbox/venv /opt/netbox/venv

VERSION

@@ -1 +1 @@
-3.0.2
+2.9.1

build.sh

@@ -61,7 +61,7 @@ DOCKERFILE  The name of Dockerfile to use.
             ${_GREEN}Default:${_CLEAR} Dockerfile
 
 DOCKER_FROM The base image to use.
-            ${_GREEN}Default:${_CLEAR} 'ubuntu:24.04'
+            ${_GREEN}Default:${_CLEAR} 'ubuntu:23.10'
 
 BUILDX_PLATFORMS
             Specifies the platform(s) to build the image for.
@@ -103,8 +103,6 @@ GH_ACTION   If defined, special 'echo' statements are enabled that set the
             - FINAL_DOCKER_TAG: The final value of the DOCKER_TAG env variable
             ${_GREEN}Default:${_CLEAR} undefined
 
-CHECK_ONLY  Only checks if the build is needed and sets the GH Action output.
-
 ${_BOLD}Examples:${_CLEAR}
 
 ${0} master
@@ -221,7 +219,7 @@ fi
 # Determining the value for DOCKER_FROM
 ###
 if [ -z "$DOCKER_FROM" ]; then
-  DOCKER_FROM="docker.io/ubuntu:24.04"
+  DOCKER_FROM="docker.io/ubuntu:23.10"
 fi
 
 ###
@@ -357,11 +355,6 @@ else
 fi
 gh_echo "::endgroup::"
 
-if [ "${CHECK_ONLY}" = "true" ]; then
-  echo "Only check if build needed was requested. Exiting"
-  exit 0
-fi
-
 ###
 # Build the image
 ###

configuration/configuration.py

@@ -200,10 +200,10 @@ if 'CENSUS_REPORTING_ENABLED' in environ:
 EXEMPT_VIEW_PERMISSIONS = _environ_get_and_map('EXEMPT_VIEW_PERMISSIONS', '', _AS_LIST)
 
 # HTTP proxies NetBox should use when sending outbound HTTP requests (e.g. for webhooks).
-HTTP_PROXIES = {
+# HTTP_PROXIES = {
-    'http': environ.get('HTTP_PROXY', None),
+#     'http': 'http://10.10.1.10:3128',
-    'https': environ.get('HTTPS_PROXY', None),
+#     'https': 'http://10.10.1.10:1080',
-}
+# }
 
 # IP addresses recognized as internal to the system. The debugging toolbar will be available only to clients accessing
 # NetBox from an internal IP.
@@ -221,9 +221,9 @@ if 'GRAPHQL_ENABLED' in environ:
 # authenticated to NetBox indefinitely.
 LOGIN_PERSISTENCE = _environ_get_and_map('LOGIN_PERSISTENCE', 'False', _AS_BOOL)
 
-# When enabled, only authenticated users are permitted to access any part of NetBox.
+# Setting this to True will permit only authenticated users to access any part of NetBox. By default, anonymous users
-# Disabling this will allow unauthenticated users to access most areas of NetBox (but not make any changes).
+# are permitted to access most data in NetBox (excluding secrets) but not make any changes.
-LOGIN_REQUIRED = _environ_get_and_map('LOGIN_REQUIRED', 'True', _AS_BOOL)
+LOGIN_REQUIRED = _environ_get_and_map('LOGIN_REQUIRED', 'False', _AS_BOOL)
 
 # The length of time (in seconds) for which a user will remain logged into the web UI before being prompted to
 # re-authenticate. (Default: 1209600 [14 days])
@@ -286,23 +286,12 @@ if 'RACK_ELEVATION_DEFAULT_UNIT_WIDTH' in environ:
     RACK_ELEVATION_DEFAULT_UNIT_WIDTH = _environ_get_and_map('RACK_ELEVATION_DEFAULT_UNIT_WIDTH', None, _AS_INT)
 
 # Remote authentication support
-REMOTE_AUTH_AUTO_CREATE_GROUPS = _environ_get_and_map('REMOTE_AUTH_AUTO_CREATE_GROUPS', 'False', _AS_BOOL)
-REMOTE_AUTH_AUTO_CREATE_USER = _environ_get_and_map('REMOTE_AUTH_AUTO_CREATE_USER', 'False', _AS_BOOL)
-REMOTE_AUTH_BACKEND = _environ_get_and_map('REMOTE_AUTH_BACKEND', 'netbox.authentication.RemoteUserBackend', _AS_LIST)
-REMOTE_AUTH_DEFAULT_GROUPS = _environ_get_and_map('REMOTE_AUTH_DEFAULT_GROUPS', '', _AS_LIST)
-# REMOTE_AUTH_DEFAULT_PERMISSIONS = {} # dicts can't be configured via environment variables. See extra.py instead.
 REMOTE_AUTH_ENABLED = _environ_get_and_map('REMOTE_AUTH_ENABLED', 'False', _AS_BOOL)
-REMOTE_AUTH_GROUP_HEADER = _environ_get_and_map('REMOTE_AUTH_GROUP_HEADER', 'HTTP_REMOTE_USER_GROUP')
+REMOTE_AUTH_BACKEND = _environ_get_and_map('REMOTE_AUTH_BACKEND', 'netbox.authentication.RemoteUserBackend', _AS_LIST)
-REMOTE_AUTH_GROUP_SEPARATOR = _environ_get_and_map('REMOTE_AUTH_GROUP_SEPARATOR', '|')
-REMOTE_AUTH_GROUP_SYNC_ENABLED = _environ_get_and_map('REMOTE_AUTH_GROUP_SYNC_ENABLED', 'False', _AS_BOOL)
 REMOTE_AUTH_HEADER = environ.get('REMOTE_AUTH_HEADER', 'HTTP_REMOTE_USER')
-REMOTE_AUTH_USER_EMAIL = environ.get('REMOTE_AUTH_USER_EMAIL', 'HTTP_REMOTE_USER_EMAIL')
+REMOTE_AUTH_AUTO_CREATE_USER = _environ_get_and_map('REMOTE_AUTH_AUTO_CREATE_USER', 'False', _AS_BOOL)
-REMOTE_AUTH_USER_FIRST_NAME = environ.get('REMOTE_AUTH_USER_FIRST_NAME', 'HTTP_REMOTE_USER_FIRST_NAME')
+REMOTE_AUTH_DEFAULT_GROUPS = _environ_get_and_map('REMOTE_AUTH_DEFAULT_GROUPS', '', _AS_LIST)
-REMOTE_AUTH_USER_LAST_NAME = environ.get('REMOTE_AUTH_USER_LAST_NAME', 'HTTP_REMOTE_USER_LAST_NAME')
+# REMOTE_AUTH_DEFAULT_PERMISSIONS = {}
-REMOTE_AUTH_SUPERUSER_GROUPS = _environ_get_and_map('REMOTE_AUTH_SUPERUSER_GROUPS', '', _AS_LIST)
-REMOTE_AUTH_SUPERUSERS = _environ_get_and_map('REMOTE_AUTH_SUPERUSERS', '', _AS_LIST)
-REMOTE_AUTH_STAFF_GROUPS = _environ_get_and_map('REMOTE_AUTH_STAFF_GROUPS', '', _AS_LIST)
-REMOTE_AUTH_STAFF_USERS = _environ_get_and_map('REMOTE_AUTH_STAFF_USERS', '', _AS_LIST)
 
 # This repository is used to check whether there is a new release of NetBox available. Set to None to disable the
 # version check or use the URL below to check for release in the official NetBox repository.

docker-compose.override.yml

@@ -1,21 +0,0 @@
-services:
-  netbox:
-    ports:
-      - "8000:8080"
-    # If you want the Nginx unit status page visible from the
-    # outside of the container add the following port mapping:
-    # - "8001:8081"
-    # healthcheck:
-      # Time for which the health check can fail after the container is started.
-      # This depends mostly on the performance of your database. On the first start,
-      # when all tables need to be created the start_period should be higher than on
-      # subsequent starts. For the first start after major version upgrades of NetBox
-      # the start_period might also need to be set higher.
-      # Default value in our docker-compose.yml is 60s
-      # start_period: 90s
-    # environment:
-      # SKIP_SUPERUSER: "false"
-      # SUPERUSER_API_TOKEN: ""
-      # SUPERUSER_EMAIL: ""
-      # SUPERUSER_NAME: ""
-      # SUPERUSER_PASSWORD: ""

docker-compose.test.yml

@@ -1,6 +1,6 @@
 services:
   netbox: &netbox
-    image: ${IMAGE-docker.io/netboxcommunity/netbox:latest}
+    image: ${IMAGE-netboxcommunity/netbox:latest}
     depends_on:
       postgres:
         condition: service_healthy
@@ -13,10 +13,10 @@ services:
     volumes:
     - ./test-configuration/test_config.py:/etc/netbox/config/test_config.py:z,ro
     healthcheck:
-      test: curl -f http://localhost:8080/login/ || exit 1
       start_period: ${NETBOX_START_PERIOD-120s}
       timeout: 3s
       interval: 15s
+      test: "curl -f http://localhost:8080/api/ || exit 1"
   netbox-worker:
     <<: *netbox
     command:
@@ -24,47 +24,42 @@ services:
     - /opt/netbox/netbox/manage.py
     - rqworker
     healthcheck:
-      test: ps -aux | grep -v grep | grep -q rqworker || exit 1
       start_period: 40s
       timeout: 3s
       interval: 15s
+      test: "ps -aux | grep -v grep | grep -q rqworker || exit 1"
   netbox-housekeeping:
     <<: *netbox
     command:
     - /opt/netbox/housekeeping.sh
     healthcheck:
-      test: ps -aux | grep -v grep | grep -q housekeeping || exit 1
       start_period: 40s
       timeout: 3s
       interval: 15s
-
+      test: "ps -aux | grep -v grep | grep -q housekeeping || exit 1"
   postgres:
-    image: docker.io/postgres:16-alpine
+    image: postgres:16-alpine
     env_file: env/postgres.env
     healthcheck:
-      test: pg_isready -q -t 2 -d $$POSTGRES_DB -U $$POSTGRES_USER ## $$ because of docker-compose
+      test: "pg_isready -t 2 -d $$POSTGRES_DB -U $$POSTGRES_USER" ## $$ because of docker-compose
-      start_period: 20s
+      interval: 10s
-      interval: 1s
       timeout: 5s
       retries: 5
-
   redis: &redis
-    image: docker.io/valkey/valkey:8.0-alpine
+    image: redis:7-alpine
     command:
     - sh
     - -c # this is to evaluate the $REDIS_PASSWORD from the env
-    - valkey-server --save "" --appendonly no --requirepass $$REDIS_PASSWORD ## $$ because of docker-compose
+    - redis-server --appendonly yes --requirepass $$REDIS_PASSWORD ## $$ because of docker-compose
     env_file: env/redis.env
     healthcheck:
-      test: "[ $$(valkey-cli --pass \"$${REDIS_PASSWORD}\" ping) = 'PONG' ]"
+      start_period: 20s
-      start_period: 5s
       timeout: 3s
-      interval: 1s
+      interval: 15s
-      retries: 5
+      test: "timeout 2 redis-cli ping"
   redis-cache:
     <<: *redis
     env_file: env/redis-cache.env
-
 volumes:
   netbox-media-files:
     driver: local

docker-compose.yml

@@ -1,17 +1,17 @@
 services:
   netbox: &netbox
-    image: docker.io/netboxcommunity/netbox:${VERSION-v4.1-3.0.2}
+    image: docker.io/netboxcommunity/netbox:${VERSION-v4.0-2.9.1}
     depends_on:
     - postgres
     - redis
     - redis-cache
     env_file: env/netbox.env
-    user: "unit:root"
+    user: 'unit:root'
     healthcheck:
-      test: curl -f http://localhost:8080/login/ || exit 1
+      start_period: 60s
-      start_period: 90s
       timeout: 3s
       interval: 15s
+      test: "curl -f http://localhost:8080/login/ || exit 1"
     volumes:
     - ./configuration:/etc/netbox/config:z,ro
     - netbox-media-files:/opt/netbox/netbox/media:rw
@@ -27,10 +27,10 @@ services:
     - /opt/netbox/netbox/manage.py
     - rqworker
     healthcheck:
-      test: ps -aux | grep -v grep | grep -q rqworker || exit 1
       start_period: 20s
       timeout: 3s
       interval: 15s
+      test: "ps -aux | grep -v grep | grep -q rqworker || exit 1"
   netbox-housekeeping:
     <<: *netbox
     depends_on:
@@ -39,47 +39,34 @@ services:
     command:
     - /opt/netbox/housekeeping.sh
     healthcheck:
-      test: ps -aux | grep -v grep | grep -q housekeeping || exit 1
       start_period: 20s
       timeout: 3s
       interval: 15s
+      test: "ps -aux | grep -v grep | grep -q housekeeping || exit 1"
 
   # postgres
   postgres:
     image: docker.io/postgres:16-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/redis:7-alpine
     command:
     - sh
     - -c # this is to evaluate the $REDIS_PASSWORD from the env
-      - valkey-server --appendonly yes --requirepass $$REDIS_PASSWORD ## $$ because of docker-compose
+    - redis-server --appendonly yes --requirepass $$REDIS_PASSWORD ## $$ because of docker-compose
-    healthcheck: &redis-healthcheck
-      test: '[ $$(valkey-cli --pass "$${REDIS_PASSWORD}" ping) = ''PONG'' ]'
-      start_period: 5s
-      timeout: 3s
-      interval: 1s
-      retries: 5
     env_file: env/redis.env
     volumes:
     - netbox-redis-data:/data
   redis-cache:
-    image: docker.io/valkey/valkey:8.0-alpine
+    image: docker.io/redis:7-alpine
     command:
     - sh
     - -c # this is to evaluate the $REDIS_PASSWORD from the env
-      - valkey-server --requirepass $$REDIS_PASSWORD ## $$ because of docker-compose
+    - redis-server --requirepass $$REDIS_PASSWORD ## $$ because of docker-compose
-    healthcheck: *redis-healthcheck
     env_file: env/redis-cache.env
     volumes:
     - netbox-redis-cache-data:/data

requirements-container.txt

@@ -1,5 +1,5 @@
 django-auth-ldap==4.8.0
-django-storages[azure,boto3,dropbox,google,libcloud,sftp]==1.14.4
+django-storages[azure,boto3,dropbox,google,libcloud,sftp]==1.14.3
 dulwich==0.22.1
-python3-saml==1.16.0 --no-binary lxml,xmlsec
+python3-saml==1.16.0 --no-binary lxml
-sentry-sdk[django]==2.14.0
+sentry-sdk[django]==2.1.1

test-configuration/test_config.py

@@ -4,4 +4,3 @@ LOGGING = {
 }
 
 DEFAULT_PERMISSIONS = {}
-LOGIN_REQUIRED = False

test.sh

@@ -84,7 +84,7 @@ test_netbox_web() {
       --retry 5 \
       --retry-delay 0 \
       --retry-max-time 40 \
-      http://127.0.0.1:8000/login/
+      http://127.0.0.1:8000/
   )
   if [ "$RESP_CODE" == "200" ]; then
     echo "Webservice running"