netbox v4+

see: https://crazymax.dev/diun

docker-compose.yml

@@ -4,11 +4,11 @@ services:
     image: netboxcommunity/netbox:${NETBOX_VERSION}-${NETBOX_DOCKER_VERSION}
     restart: unless-stopped
     depends_on:
-      - netbox-worker
       - postgres
       - redis
       - redis-cache
     environment:
+      - API_TOKEN_PEPPER_1=${NETBOX_API_TOKEN_PEPPER_1}
       - CORS_ORIGIN_ALLOW_ALL=True
       - DB_HOST=postgres
       - DB_NAME=${PSQL_NAME}
@@ -24,14 +24,11 @@ services:
       - EMAIL_FROM=${NETBOX_EMAIL_FROM}
       - EMAIL_USERNAME=${NETBOX_EMAIL_USER}
       - EMAIL_PASSWORD=${NETBOX_EMAIL_PASS}
+      - GRANIAN_BACKPRESSURE=${NETBOX_GRANIAN_BACKPRESSURE}
+      - GRANIAN_WORKERS=${NETBOX_GRANIAN_WORKERS}
       - GRAPHQL_ENABLED=${NETBOX_GRAPHQL}
-      - HOUSEKEEPING_INTERVAL=86400
-      - MAX_PAGE_SIZE=1000
       - MEDIA_ROOT=/opt/netbox/netbox/media
       - METRICS_ENABLED=${NETBOX_METRICS}
-      - NAPALM_USERNAME=${NETBOX_NAPALM_USER}
-      - NAPALM_PASSWORD=${NETBOX_NAPALM_PASS}
-      - NAPALM_TIMEOUT=10
       - REDIS_HOST=redis
       - REDIS_DATABASE=0
       - REDIS_PASSWORD=${REDIS_PASS}
@@ -44,13 +41,13 @@ services:
       - REDIS_CACHE_INSECURE_SKIP_TLS_VERIFY=false
       - RELEASE_CHECK_URL=https://api.github.com/repos/netbox-community/netbox/releases
       - SECRET_KEY=${NETBOX_SECRET_KEY}
-      - SKIP_STARTUP_SCRIPTS=${NETBOX_SKIP_SCRIPTS}
       - SKIP_SUPERUSER=${NETBOX_SKIP_SUPERUSER}
-      - SUPERUSER_API_TOKEN=${NETBOX_SUPERUSER_TOKEN}
-      - SUPERUSER_EMAIL=${NETBOX_SUPERUSER_EMAIL}
-      - SUPERUSER_NAME=${NETBOX_SUPERUSER_NAME}
-      - SUPERUSER_PASSWORD=${NETBOX_SUPERUSER_PASS}
       - WEBHOOKS_ENABLED=${NETBOX_WEBHOOKS}
+    healthcheck:
+      test: curl -f http://localhost:8080/login/ || exit 1
+      start_period: 90s
+      timeout: 3s
+      interval: 15s
     labels:
       - traefik.enable=${TRAEFIK_ENABLED}
       - traefik.docker.network=${TRAEFIK_NETWORK}
@@ -72,14 +69,12 @@ services:
     networks:
       - internal
       - traefik
-    user: unit:root
+    user: netbox:root
     volumes:
       - ${NETBOX_DATA}/configuration:/etc/netbox/config:z,ro
-      - ${NETBOX_DATA}/initializers:/opt/netbox/initializers:z,ro
       - ${NETBOX_DATA}/media:/opt/netbox/netbox/media:z
       - ${NETBOX_DATA}/reports:/etc/netbox/reports:z,ro
       - ${NETBOX_DATA}/scripts:/etc/netbox/scripts:z,ro
-      - ${NETBOX_DATA}/startup_scripts:/opt/netbox/startup_scripts:z,ro
 
   netbox-worker:
     <<: *netbox
@@ -88,20 +83,13 @@ services:
       - /opt/netbox/netbox/manage.py
       - rqworker
     depends_on:
-      - postgres
+      netbox:
-      - redis
+        condition: service_healthy
-    labels:
+    healthcheck:
-      - traefik.enable=false
+      test: ps -aux | grep -v grep | grep -q rqworker || exit 1
-    networks:
+      start_period: 20s
-      - internal
+      timeout: 3s
-
+      interval: 15s
-  netbox-housekeeping:
-    <<: *netbox
-    command:
-      - /opt/netbox/housekeeping.sh
-    depends_on:
-      - postgres
-      - redis
     labels:
       - traefik.enable=false
     networks:
@@ -114,10 +102,16 @@ services:
       - POSTGRES_DB=${PSQL_NAME}
       - POSTGRES_USER=${PSQL_USER}
       - POSTGRES_PASSWORD=${PSQL_PASS}
+    healthcheck:
+      test: pg_isready -q -t 2 -d $$POSTGRES_DB -U $$POSTGRES_USER
+      start_period: 20s
+      timeout: 30s
+      interval: 10s
+      retries: 5
     networks:
       - internal
     volumes:
-      - ${PSQL_DATA}:/var/lib/postgresql/data
+      - ${PSQL_DATA}:/var/lib/postgresql
 
   redis:
     image: redis:${REDIS_VERSION}
@@ -128,6 +122,12 @@ services:
       - redis-server --appendonly yes --requirepass $$REDIS_PASSWORD
     environment:
       - REDIS_PASSWORD=${REDIS_PASS}
+    healthcheck: &redis-healthcheck
+      test: '[ $$(redis-cli --pass "$${REDIS_PASSWORD}" ping) = ''PONG'' ]'
+      start_period: 5s
+      timeout: 3s
+      interval: 1s
+      retries: 5
     networks:
       - internal
     volumes:
@@ -141,6 +141,7 @@ services:
       - redis-server --requirepass $$REDIS_PASSWORD
     environment:
       - REDIS_PASSWORD=${REDIS_CACHE_PASS}
+    healthcheck: *redis-healthcheck
     networks:
       - internal
 

env.example

@@ -1,7 +1,8 @@
 # NetBox
-NETBOX_DOCKER_VERSION=2.1.0
+NETBOX_DOCKER_VERSION=4.0.2
-NETBOX_VERSION=v3.2.9
+NETBOX_VERSION=v4.5.8
 NETBOX_DATA=./data/netbox
+NETBOX_API_TOKEN_PEPPER_1="Qy+F=OTeGskWQ(wTMgjc+NPPlz6YwFXY=KHIIg=wpYXT&e(6u8"
 NETBOX_EMAIL_SERVER=localhost
 NETBOX_EMAIL_PORT=25
 NETBOX_EMAIL_SSLCER=
@@ -12,17 +13,12 @@ NETBOX_EMAIL_TLS=false
 NETBOX_EMAIL_FROM=netbox@bar.com
 NETBOX_EMAIL_USER=netbox
 NETBOX_EMAIL_PASS=
+NETBOX_GRANIAN_BACKPRESSURE=4
+NETBOX_GRANIAN_WORKERS=4
 NETBOX_GRAPHQL=true
 NETBOX_METRICS=false
-NETBOX_NAPALM_USER=
+NETBOX_SECRET_KEY="NTrLgQElN=8fIGX6PedJgUgc79R5gZEG3#Jyu2X)=2bx0KkRsl"
-NETBOX_NAPALM_PASS=
-NETBOX_SECRET_KEY=r8OwDznj!!dci#P9ghmRfdu1Ysxm0AiPeDCQhKE+N_rClfWNj
-NETBOX_SKIP_SCRIPTS=false
 NETBOX_SKIP_SUPERUSER=false
-NETBOX_SUPERUSER_TOKEN=0123456789abcdef0123456789abcdef01234567
-NETBOX_SUPERUSER_EMAIL=admin@example.com
-NETBOX_SUPERUSER_NAME=admin
-NETBOX_SUPERUSER_PASS=admin
 NETBOX_WEBHOOKS=true
 
 # Træfik
@@ -36,14 +32,14 @@ TRAEFIK_SERVICE=netbox_example_com
 TRAEFIK_SERVICE_PORT=8080
 
 # PostgreSQL
-PSQL_VERSION=14.5-alpine3.16
+PSQL_VERSION=18.3-alpine3.22
 PSQL_DATA=./data/postgres
 PSQL_NAME=netbox
 PSQL_USER=netbox
 PSQL_PASS=J5brHrAXFLQSif0K
 
 # Redis
-REDIS_VERSION=7.0.4-alpine3.16
+REDIS_VERSION=8.6.2-alpine3.23
 REDIS_DATA=./data/redis
 REDIS_PASS=H733Kdjndks81
 

post-installation.sh

@@ -0,0 +1,14 @@
+#/usr/bin/env bash
+set -e
+
+# Search or ask for .env file
+ENV_FILE=".env"
+while [ ! -f "${ENV_FILE}" ]; do
+  read -p "\"${ENV_FILE}\" file does not exist, please type your env file: " ENV_FILE
+done
+
+# Disable superuser config in environment variable, it's now in the database
+sed -i "s/NETBOX_SUPERUSER_EMAIL=.*/NETBOX_SUPERUSER_EMAIL=/" "${ENV_FILE}"
+sed -i "s/NETBOX_SUPERUSER_NAME=.*/NETBOX_SUPERUSER_NAME=/" "${ENV_FILE}"
+sed -i "s/NETBOX_SUPERUSER_PASS=.*/NETBOX_SUPERUSER_PASS=/" "${ENV_FILE}"
+sed -i "s/NETBOX_SKIP_SUPERUSER=/NETBOX_SKIP_SUPERUSER=true/" "${ENV_FILE}"

update_base.sh

@@ -1,12 +1,14 @@
 #/usr/bin/env bash
 set -e
 
+DIRS=(configuration)
+
 source .env
-rm -rf ${NETBOX_DATA}/{configuration,initializers,reports,scripts,startup_scripts}
+rm -rf "${DIRS[@]/#/${NETBOX_DATA}/}"
-mkdir -p ${NETBOX_DATA}
+mkdir -p "${NETBOX_DATA}"
 git clone https://github.com/netbox-community/netbox-docker.git
 cd netbox-docker
-git checkout ${NETBOX_DOCKER_VERSION}
+git checkout "${NETBOX_DOCKER_VERSION}"
 cd ..
-mv netbox-docker/{configuration,initializers,reports,scripts,startup_scripts} ${NETBOX_DATA}
+mv "${DIRS[@]/#/netbox-docker/}" "${NETBOX_DATA}"
 rm -rf netbox-docker