How netbox-community/netbox-docker works
Project type and purpose
• This is not a traditional full-stack application you write from scratch, but a containerization/packaging project for an existing Django app (NetBox).
• Its primary purpose is to build, configure, and publish Docker images for NetBox, and to orchestrate those images (plus backing services) via Docker Compose.
File structure
• Top-level build artifacts and configuration:
• Dockerfile + docker/ directory (entrypoint & housekeeping scripts, nginx-unit config)
• build.sh, build-latest.sh, build-functions/ (shell functions for image building)
• configuration/ (Python modules that generate NetBox’s settings inside the container)
• Orchestration manifests:
• docker-compose.yml + override examples for production, test, and development (.override.yml, .test.yml)
• env/ directory with environment files for NetBox, Postgres, Redis
• CI/CD and metadata:
• .github/workflows/ for build & release pipelines
• release.sh, test.sh, pyproject.toml, requirements-container.txt
• Tests:
• test-configuration/ runs quick unit tests against the configuration Python code
README for additional insights
• Images are rebuilt daily and pushed to three container registries
• The runtime stack consists of NetBox, PostgreSQL, Redis (cache + task queue), optional LDAP, all wired via Docker Compose
• Build pipeline lives in GitHub Actions, invoking local shell scripts (build.sh, build-latest.sh)
Every essential element
• Review against docker-compose.yml and Dockerfile to verify you included all services and scripts