NetBox Docker Development Environment

A ready-to-use NetBox development environment with Docker and VS Code Dev Containers.

Quick Start

Prerequisites

• Docker Desktop or Docker Engine
• VS Code with Dev Containers extension (optional, for development)
• Git

Setup Steps

1. Clone this repository

   git clone <repository-url>
   cd <repository-name>

2. Clone NetBox Docker

   git clone https://github.com/netbox-community/netbox-docker.git

3. Configure NetBox

   cd netbox-docker
   cp docker-compose.override.yml.example docker-compose.override.yml

4. Start NetBox

   docker compose up -d

5. Wait for services to be healthy (about 1-2 minutes)

   docker compose ps

   All services should show as "healthy"

6. Access NetBox

   • URL: http://localhost:8000
   • Note: You'll need credentials to log in

Repository Structure

.
├── .devcontainer/       # VS Code Dev Container configuration
├── README.md            # This file
└── netbox-docker/       # NetBox Docker repository (cloned in step 2)

Working with VS Code Dev Containers

If you're using VS Code:

1. Open the repository in VS Code
2. When prompted, click "Reopen in Container"
3. The development environment will be automatically configured

Managing NetBox

View logs

docker compose logs -f netbox

Stop NetBox

docker compose down

Reset NetBox (clean slate)

docker compose down -v
docker compose up -d

Access NetBox shell

docker exec -it netbox-docker-netbox-1 /opt/netbox/venv/bin/python /opt/netbox/netbox/manage.py shell_plus

Troubleshooting

Services not starting

• Check Docker is running: docker ps
• Check logs: docker compose logs
• Ensure ports 8000 (NetBox) and 5432 (PostgreSQL) are available

Cannot log in

• You'll need to create credentials to access NetBox
• Check the configuration files or create a superuser

Additional Resources

• NetBox Documentation
• NetBox Docker Documentation
• NetBox API Documentation (when running)