Merge pull request #1298 from netbox-community/develop

Version 3.0.0

.github/FUNDING.yml

@@ -1,8 +1,8 @@
 # These are supported funding model platforms
 
 github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
-- cimnine
+  - cimnine
-- tobiasge
+  - tobiasge
 patreon: # Replace with a single Patreon username
 open_collective: # Replace with a single Open Collective username
 ko_fi: # Replace with a single Ko-fi username

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,148 +1,148 @@
 name: Bug report
 description: Create a report about a malfunction of the Docker setup
 body:
-- type: markdown
+  - type: markdown
-  attributes:
+    attributes:
-    value: |
+      value: |
-      Please only raise an issue if you're certain that you've found a bug.
+        Please only raise an issue if you're certain that you've found a bug.
-      Else, see these other means to get help:
+        Else, see these other means to get help:
 
-      - See our troubleshooting section:
+        - See our troubleshooting section:
-        https://github.com/netbox-community/netbox-docker/wiki/Troubleshooting
+          https://github.com/netbox-community/netbox-docker/wiki/Troubleshooting
-      - Have a look at the rest of the wiki:
+        - Have a look at the rest of the wiki:
-        https://github.com/netbox-community/netbox-docker/wiki
+          https://github.com/netbox-community/netbox-docker/wiki
-      - Check the release notes:
+        - Check the release notes:
-        https://github.com/netbox-community/netbox-docker/releases
+          https://github.com/netbox-community/netbox-docker/releases
-      - Look through the issues already resolved:
+        - Look through the issues already resolved:
-        https://github.com/netbox-community/netbox-docker/issues?q=is%3Aclosed
+          https://github.com/netbox-community/netbox-docker/issues?q=is%3Aclosed
 
-      If you did not find what you're looking for,
+        If you did not find what you're looking for,
-      try the help of our community:
+        try the help of our community:
 
-      - Post to Github Discussions:
+        - Post to Github Discussions:
-        https://github.com/netbox-community/netbox-docker/discussions
+          https://github.com/netbox-community/netbox-docker/discussions
-      - Join the `#netbox-docker` channel on our Slack:
+        - Join the `#netbox-docker` channel on our Slack:
-        https://join.slack.com/t/netdev-community/shared_invite/zt-mtts8g0n-Sm6Wutn62q_M4OdsaIycrQ
+          https://join.slack.com/t/netdev-community/shared_invite/zt-mtts8g0n-Sm6Wutn62q_M4OdsaIycrQ
-      - Ask on the NetBox mailing list:
+        - Ask on the NetBox mailing list:
-        https://groups.google.com/d/forum/netbox-discuss
+          https://groups.google.com/d/forum/netbox-discuss
 
-      Please don't open an issue to open a PR.
+        Please don't open an issue to open a PR.
-      Just submit the PR, that's good enough.
+        Just submit the PR, that's good enough.
-- type: textarea
+  - type: textarea
-  id: current-behavior
+    id: current-behavior
-  attributes:
+    attributes:
-    label: Current Behavior
+      label: Current Behavior
-    description: Please describe what you did and how you think it misbehaved
+      description: Please describe what you did and how you think it misbehaved
-    placeholder: I tried to … by doing …, but it …
+      placeholder: I tried to … by doing …, but it …
-  validations:
+    validations:
-    required: true
+      required: true
-- type: textarea
+  - type: textarea
-  id: expected-behavior
+    id: expected-behavior
-  attributes:
+    attributes:
-    label: Expected Behavior
+      label: Expected Behavior
-    description: Please describe what you expected instead
+      description: Please describe what you expected instead
-    placeholder: I expected that … when I do …
+      placeholder: I expected that … when I do …
-  validations:
+    validations:
-    required: true
+      required: true
-- type: input
+  - type: input
-  id: docker-compose-version
+    id: docker-compose-version
-  attributes:
+    attributes:
-    label: Docker Compose Version
+      label: Docker Compose Version
-    description: Please paste the output of `docker-compose version`
+      description: Please paste the output of `docker-compose version`
-    placeholder: Docker Compose version vX.Y.Z
+      placeholder: Docker Compose version vX.Y.Z
-  validations:
+    validations:
-    required: true
+      required: true
-- type: textarea
+  - type: textarea
-  id: docker-version
+    id: docker-version
-  attributes:
+    attributes:
-    label: Docker Version
+      label: Docker Version
-    description: Please paste the output of `docker version`
+      description: Please paste the output of `docker version`
-    render: text
+      render: text
-    placeholder: |
+      placeholder: |
-      Client:
+        Client:
-      Cloud integration: 1.0.17
+        Cloud integration: 1.0.17
-      Version:           20.10.8
+        Version:           20.10.8
-      API version:       1.41
+        API version:       1.41
-      Go version:        go1.16.6
+        Go version:        go1.16.6
-      Git commit:        3967b7d
+        Git commit:        3967b7d
-      Built:             Fri Jul 30 19:55:20 2021
+        Built:             Fri Jul 30 19:55:20 2021
-      OS/Arch:           darwin/amd64
+        OS/Arch:           darwin/amd64
-      Context:           default
+        Context:           default
-      Experimental:      true
+        Experimental:      true
 
-      Server: Docker Engine - Community
+        Server: Docker Engine - Community
-      Engine:
+        Engine:
-        Version:          20.10.8
+          Version:          20.10.8
-        API version:      1.41 (minimum version 1.12)
+          API version:      1.41 (minimum version 1.12)
-        Go version:       go1.16.6
+          Go version:       go1.16.6
-        Git commit:       75249d8
+          Git commit:       75249d8
-        Built:            Fri Jul 30 19:52:10 2021
+          Built:            Fri Jul 30 19:52:10 2021
-        OS/Arch:          linux/amd64
+          OS/Arch:          linux/amd64
-        Experimental:     false
+          Experimental:     false
-      containerd:
+        containerd:
-        Version:          1.4.9
+          Version:          1.4.9
-        GitCommit:        e25210fe30a0a703442421b0f60afac609f950a3
+          GitCommit:        e25210fe30a0a703442421b0f60afac609f950a3
-      runc:
+        runc:
-        Version:          1.0.1
+          Version:          1.0.1
-        GitCommit:        v1.0.1-0-g4144b63
+          GitCommit:        v1.0.1-0-g4144b63
-      docker-init:
+        docker-init:
-        Version:          0.19.0
+          Version:          0.19.0
-        GitCommit:        de40ad0
+          GitCommit:        de40ad0
-  validations:
+    validations:
-    required: true
+      required: true
-- type: input
+  - type: input
-  id: git-rev
+    id: git-rev
-  attributes:
+    attributes:
-    label: The git Revision
+      label: The git Revision
-    description: Please paste the output of `git rev-parse HEAD`
+      description: Please paste the output of `git rev-parse HEAD`
-  validations:
+    validations:
-    required: true
+      required: true
-- type: textarea
+  - type: textarea
-  id: git-status
+    id: git-status
-  attributes:
+    attributes:
-    label: The git Status
+      label: The git Status
-    description: Please paste the output of `git status`
+      description: Please paste the output of `git status`
-    render: text
+      render: text
-    placeholder: |
+      placeholder: |
-      On branch main
+        On branch main
-      nothing to commit, working tree clean
+        nothing to commit, working tree clean
-  validations:
+    validations:
-    required: true
+      required: true
-- type: input
+  - type: input
-  id: run-command
+    id: run-command
-  attributes:
+    attributes:
-    label: Startup Command
+      label: Startup Command
-    description: Please specify the command you used to start the project
+      description: Please specify the command you used to start the project
-    placeholder: docker compose up
+      placeholder: docker compose up
-  validations:
+    validations:
-    required: true
+      required: true
-- type: textarea
+  - type: textarea
-  id: netbox-logs
+    id: netbox-logs
-  attributes:
+    attributes:
-    label: NetBox Logs
+      label: NetBox Logs
-    description: Please paste the output of `docker-compose logs netbox` (or `docker compose logs netbox`)
+      description: Please paste the output of `docker-compose logs netbox` (or `docker compose logs netbox`)
-    render: text
+      render: text
-    placeholder: |
+      placeholder: |
-      netbox_1  | ⚙️ Applying database migrations
+        netbox_1  | ⚙️ Applying database migrations
-      netbox_1  | 🧬 loaded config '/etc/netbox/config/configuration.py'
+        netbox_1  | 🧬 loaded config '/etc/netbox/config/configuration.py'
-      netbox_1  | 🧬 loaded config '/etc/netbox/config/a.py'
+        netbox_1  | 🧬 loaded config '/etc/netbox/config/a.py'
-      netbox_1  | 🧬 loaded config '/etc/netbox/config/extra.py'
+        netbox_1  | 🧬 loaded config '/etc/netbox/config/extra.py'
-      netbox_1  | 🧬 loaded config '/etc/netbox/config/logging.py'
+        netbox_1  | 🧬 loaded config '/etc/netbox/config/logging.py'
-      netbox_1  | 🧬 loaded config '/etc/netbox/config/plugins.py'
+        netbox_1  | 🧬 loaded config '/etc/netbox/config/plugins.py'
-      ...
+        ...
-  validations:
+    validations:
-    required: true
+      required: true
-- type: textarea
+  - type: textarea
-  id: docker-compose-override-yml
+    id: docker-compose-override-yml
-  attributes:
+    attributes:
-    label: Content of docker-compose.override.yml
+      label: Content of docker-compose.override.yml
-    description: Please paste the output of `cat docker-compose.override.yml`
+      description: Please paste the output of `cat docker-compose.override.yml`
-    render: yaml
+      render: yaml
-    placeholder: |
+      placeholder: |
-      version: '3.4'
+        version: '3.4'
-      services:
+        services:
-        netbox:
+          netbox:
-          ports:
+            ports:
-            - '8080:8080'
+              - '8080:8080'
-  validations:
+    validations:
-    required: true
+      required: true

.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

@@ -1,68 +1,68 @@
 name: Feature or Change Request
 description: Request a new feature or a change of the current behavior
 body:
-- type: markdown
+  - type: markdown
-  attributes:
+    attributes:
-    value: |
+      value: |
-      This issue type is to propose new features for the Docker setup.
+        This issue type is to propose new features for the Docker setup.
-      To just spin an idea, see the Github Discussions section, please.
+        To just spin an idea, see the Github Discussions section, please.
 
-      Before asking for help, see these links first:
+        Before asking for help, see these links first:
 
-      - See our troubleshooting section:
+        - See our troubleshooting section:
-        https://github.com/netbox-community/netbox-docker/wiki/Troubleshooting
+          https://github.com/netbox-community/netbox-docker/wiki/Troubleshooting
-      - Have a look at the rest of the wiki:
+        - Have a look at the rest of the wiki:
-        https://github.com/netbox-community/netbox-docker/wiki
+          https://github.com/netbox-community/netbox-docker/wiki
-      - Check the release notes:
+        - Check the release notes:
-        https://github.com/netbox-community/netbox-docker/releases
+          https://github.com/netbox-community/netbox-docker/releases
-      - Look through the issues already resolved:
+        - Look through the issues already resolved:
-        https://github.com/netbox-community/netbox-docker/issues?q=is%3Aclosed
+          https://github.com/netbox-community/netbox-docker/issues?q=is%3Aclosed
 
-      If you did not find what you're looking for,
+        If you did not find what you're looking for,
-      try the help of our community:
+        try the help of our community:
 
-      - Post to Github Discussions:
+        - Post to Github Discussions:
-        https://github.com/netbox-community/netbox-docker/discussions
+          https://github.com/netbox-community/netbox-docker/discussions
-      - Join the `#netbox-docker` channel on our Slack:
+        - Join the `#netbox-docker` channel on our Slack:
-        https://join.slack.com/t/netdev-community/shared_invite/zt-mtts8g0n-Sm6Wutn62q_M4OdsaIycrQ
+          https://join.slack.com/t/netdev-community/shared_invite/zt-mtts8g0n-Sm6Wutn62q_M4OdsaIycrQ
-      - Ask on the NetBox mailing list:
+        - Ask on the NetBox mailing list:
-        https://groups.google.com/d/forum/netbox-discuss
+          https://groups.google.com/d/forum/netbox-discuss
 
-      Please don't open an issue to open a PR.
+        Please don't open an issue to open a PR.
-      Just submit the PR, that's good enough.
+        Just submit the PR, that's good enough.
-- type: textarea
+  - type: textarea
-  id: desired-behavior
+    id: desired-behavior
-  attributes:
+    attributes:
-    label: Desired Behavior
+      label: Desired Behavior
-    description: Please describe the desired behavior
+      description: Please describe the desired behavior
-    placeholder: To me, it would be useful, if … because …
+      placeholder: To me, it would be useful, if … because …
-  validations:
+    validations:
-    required: true
+      required: true
-- type: textarea
+  - type: textarea
-  id: contrast-to-current
+    id: contrast-to-current
-  attributes:
+    attributes:
-    label: Contrast to Current Behavior
+      label: Contrast to Current Behavior
-    description: Please describe how the desired behavior is different from the current behavior
+      description: Please describe how the desired behavior is different from the current behavior
-    placeholder: The current behavior is …, but this lacks …
+      placeholder: The current behavior is …, but this lacks …
-  validations:
+    validations:
-    required: true
+      required: true
-- type: textarea
+  - type: textarea
-  id: required-changes
+    id: required-changes
-  attributes:
+    attributes:
-    label: Required Changes
+      label: Required Changes
-    description: If you can, please elaborate what changes will be required to implement the desired behavior
+      description: If you can, please elaborate what changes will be required to implement the desired behavior
-    placeholder: I suggest to change the file …
+      placeholder: I suggest to change the file …
-  validations:
+    validations:
-    required: false
+      required: false
-- type: textarea
+  - type: textarea
-  id: discussion
+    id: discussion
-  attributes:
+    attributes:
-    label: 'Discussion: Benefits and Drawbacks'
+      label: "Discussion: Benefits and Drawbacks"
-    description: |
+      description: |
-      Please make your case here:
+        Please make your case here:
-      - Why do you think this project and the community will benefit from your suggestion?
+        - Why do you think this project and the community will benefit from your suggestion?
-      - What are the drawbacks of this change? Is it backwards-compatible?
+        - What are the drawbacks of this change? Is it backwards-compatible?
-      - Anything else that you think is relevant to the discussion of this feature/change request.
+        - Anything else that you think is relevant to the discussion of this feature/change request.
-    placeholder: I suggest to change the file …
+      placeholder: I suggest to change the file …
-  validations:
+    validations:
-    required: false
+      required: false

.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@v6
+        uses: github/super-linter@v7
         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:

.yamllint.yaml

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

Dockerfile

@@ -63,17 +63,16 @@ RUN export DEBIAN_FRONTEND=noninteractive \
       openssh-client \
       openssl \
       python3 \
-      python3-distutils \
       tini \
-    && curl --silent --output /usr/share/keyrings/nginx-keyring.gpg \
+    && curl --silent --output /etc/apt/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/ mantic unit" \
+    && echo "deb [signed-by=/etc/apt/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.32.0-1~mantic \
+      unit=1.32.1-1~mantic \
-      unit-python3.11=1.32.0-1~mantic \
+      unit-python3.12=1.32.1-1~mantic \
     && rm -rf /var/lib/apt/lists/*
 
 COPY --from=builder /opt/netbox/venv /opt/netbox/venv

VERSION

@@ -1 +1 @@
-2.9.1
+3.0.0

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:23.10'
+            ${_GREEN}Default:${_CLEAR} 'ubuntu:24.04'
 
 BUILDX_PLATFORMS
             Specifies the platform(s) to build the image for.
@@ -219,7 +219,7 @@ fi
 # Determining the value for DOCKER_FROM
 ###
 if [ -z "$DOCKER_FROM" ]; then
-  DOCKER_FROM="docker.io/ubuntu:23.10"
+  DOCKER_FROM="docker.io/ubuntu:24.04"
 fi
 
 ###

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': 'http://10.10.1.10:3128',
+    'http': environ.get('HTTP_PROXY', None),
-#     'https': 'http://10.10.1.10:1080',
+    'https': environ.get('HTTPS_PROXY', None),
-# }
+}
 
 # IP addresses recognized as internal to the system. The debugging toolbar will be available only to clients accessing
 # NetBox from an internal IP.

docker-compose.test.yml

@@ -49,7 +49,7 @@ services:
       retries: 5
 
   redis: &redis
-    image: docker.io/valkey/valkey:7.2-alpine
+    image: docker.io/valkey/valkey:8.0-alpine
     command:
     - sh
     - -c # this is to evaluate the $REDIS_PASSWORD from the env

docker-compose.yml

@@ -1,31 +1,31 @@
 services:
   netbox: &netbox
-    image: docker.io/netboxcommunity/netbox:${VERSION-v4.0-2.9.1}
+    image: docker.io/netboxcommunity/netbox:${VERSION-v4.1-3.0.0}
     depends_on:
-    - postgres
+      - postgres
-    - redis
+      - redis
-    - redis-cache
+      - 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: 90s
       timeout: 3s
       interval: 15s
     volumes:
-    - ./configuration:/etc/netbox/config:z,ro
+      - ./configuration:/etc/netbox/config:z,ro
-    - netbox-media-files:/opt/netbox/netbox/media:rw
+      - netbox-media-files:/opt/netbox/netbox/media:rw
-    - netbox-reports-files:/opt/netbox/netbox/reports:rw
+      - netbox-reports-files:/opt/netbox/netbox/reports:rw
-    - netbox-scripts-files:/opt/netbox/netbox/scripts:rw
+      - netbox-scripts-files:/opt/netbox/netbox/scripts:rw
   netbox-worker:
     <<: *netbox
     depends_on:
       netbox:
         condition: service_healthy
     command:
-    - /opt/netbox/venv/bin/python
+      - /opt/netbox/venv/bin/python
-    - /opt/netbox/netbox/manage.py
+      - /opt/netbox/netbox/manage.py
-    - rqworker
+      - rqworker
     healthcheck:
       test: ps -aux | grep -v grep | grep -q rqworker || exit 1
       start_period: 20s
@@ -37,7 +37,7 @@ services:
       netbox:
         condition: service_healthy
     command:
-    - /opt/netbox/housekeeping.sh
+      - /opt/netbox/housekeeping.sh
     healthcheck:
       test: ps -aux | grep -v grep | grep -q housekeeping || exit 1
       start_period: 20s
@@ -55,34 +55,34 @@ services:
       retries: 5
     env_file: env/postgres.env
     volumes:
-    - netbox-postgres-data:/var/lib/postgresql/data
+      - netbox-postgres-data:/var/lib/postgresql/data
 
   # redis
   redis:
-    image: docker.io/valkey/valkey:7.2-alpine
+    image: docker.io/valkey/valkey:8.0-alpine
     command:
-    - sh
+      - sh
-    - -c # this is to evaluate the $REDIS_PASSWORD from the env
+      - -c # this is to evaluate the $REDIS_PASSWORD from the env
-    - valkey-server --appendonly yes --requirepass $$REDIS_PASSWORD ## $$ because of docker-compose
+      - valkey-server --appendonly yes --requirepass $$REDIS_PASSWORD ## $$ because of docker-compose
     healthcheck: &redis-healthcheck
-      test: "[ $$(valkey-cli --pass \"$${REDIS_PASSWORD}\" ping) = 'PONG' ]"
+      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
+      - netbox-redis-data:/data
   redis-cache:
-    image: docker.io/valkey/valkey:7.2-alpine
+    image: docker.io/valkey/valkey:8.0-alpine
     command:
-    - sh
+      - sh
-    - -c # this is to evaluate the $REDIS_PASSWORD from the env
+      - -c # this is to evaluate the $REDIS_PASSWORD from the env
-    - valkey-server --requirepass $$REDIS_PASSWORD ## $$ because of docker-compose
+      - valkey-server --requirepass $$REDIS_PASSWORD ## $$ because of docker-compose
     healthcheck: *redis-healthcheck
     env_file: env/redis-cache.env
     volumes:
-    - netbox-redis-cache-data:/data
+      - netbox-redis-cache-data:/data
 
 volumes:
   netbox-media-files:

requirements-container.txt

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