NetBox is a powerful open-source platform that provides a single source of truth for your network. It combines:
- Network Documentation
- IP Address Management (IPAM)
- Data Center Infrastructure Management (DCIM)
This guide includes installation instructions for both Intel/AMD PCs and Raspberry Pi devices using Docker.
Introduction
NetBox helps you manage:
- IP addresses, prefixes, and VLANs
- Switches, routers, servers, and VMs
- Racks, power feeds, and cabling
- Circuits and providers
note: All of the commands below should be down un a terminal
๐ฅ๏ธ Install NetBox on Intel/AMD PC w/Linux (Ubuntu)
Step 1: Add Docker Repository
sudo apt update && sudo apt -y install ca-certificates curlsudo install -m 0755 -d /etc/apt/keyringssudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.ascsudo chmod a+r /etc/apt/keyrings/docker.ascecho \"deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu \$(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \ sudo tee /etc/apt/sources.list.d/docker.list > /dev/nullsudo apt update
Step 2: Install Docker
sudo apt -y install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
Step 3: Install Git
sudo apt -y install git
Step 4: Clone NetBox Repo
sudo git clone -b release https://github.com/netbox-community/netbox-docker.gitcd netbox-docker
Step 5: Configure Port Mapping
sudo nano -c docker-compose.override.ymlversion: '3.4'services:netbox:ports:- 8000:8080
Step 6: Pull and Start NetBox
sudo docker compose pullsudo docker compose up
Step 7: Create Admin User
sudo docker compose exec netbox /opt/netbox/netbox/manage.py createsuperuser
Step 8: Access NetBox
http://localhost:8000
๐ Install NetBox on a Raspberry Pi 4/5
I highly suggest the 4gb model of either Pi.
Please use all commands below via the terminal.
Step 1: Update System
sudo apt update && sudo apt upgrade -y
Step 2: Install Docker Dependencies
sudo apt install ca-certificates curl gnupg -ysudo install -m 0755 -d /etc/apt/keyrings
Step 3: Add Docker GPG Key
curl -fsSL https://download.docker.com/linux/debian/gpg |sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpgsudo chmod a+r /etc/apt/keyrings/docker.gpg
Step 4: Add ARM64 Docker Repo
echo \"deb [arch=arm64 signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/debian \$(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \sudo tee /etc/apt/sources.list.d/docker.list > /dev/nullsudo apt update
Step 5: Install Docker
sudo apt install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin -ysudo systemctl enable dockersudo systemctl start docker
Step 6: Clone NetBox Repo
git clone -b release https://github.com/netbox-community/netbox-docker.gitcd netbox-docker
Step 7: Create Port Mapping
sudo nano -c docker-compose.override.yml
note: copy & paste the below into the file.version: '3.4'
services:
netbox:
ports:
- 8000:8080
Step 8: Pull and Start NetBox
sudo docker compose pullsudo docker compose up-d
Step 9: Create Admin User
sudo docker compose exec netbox /opt/netbox/netbox/manage.py createsuperuser
Step 10: Access NetBox
http://<your_pi_ip>:8000
๐จ๏ธ Print-Friendly Quick Reference
| Platform | Install Summary |
|---|---|
| Intel/AMD | Docker โ Clone Repo โ Override Ports โ Pull โ Up โ Create User |
| Raspberry Pi | ARM64 Docker โ Clone Repo โ Override Ports โ Pull โ Up โ Create User |
Web Access: http://www.pihobby.org or https://www.pihobby.org

Published by pihobby.org
Your home for Raspberry Pi, Linux, and DIY tech tutorials.
