netbox-backup

Information about how to backup and restore Netbox has been described on netbox-community/netbox-docker#262

Example backup script:

cd /path/to/netbox
BACKUP_PATH=backup
BACKUP_DATE=$(date +"%Y-%m-%d_%H.%M.%S")
mkdir -p "${BACKUP_PATH}"
echo "${BACKUP_DATE}"
docker-compose exec -T netbox tar c -zvf - -C /opt/netbox/netbox/media ./ > "${BACKUP_PATH}/${BACKUP_DATE}_media.tgz"
docker-compose exec -T postgres sh -c 'pg_dump -v -Fc -c -U $POSTGRES_USER $POSTGRES_DB' > "${BACKUP_PATH}/${BACKUP_DATE}.pgdump"

Example restore script:

# Restore SQL data
docker-compose up -d postgres
docker-compose exec -T postgres sh -c 'pg_restore -v -Fc -cU $POSTGRES_USER -d $POSTGRES_DB' < backup/sqldump.pgdump

# Restore media files
docker-compose up -d
docker-compose exec -T netbox tar x -zvf - -C /opt/netbox/netbox/media < backup/media.tar.gz

## test it out
Get this backup example up and runnig on killercoda.com Ubuntu Server 20.04
sudo apt update
sudo apt upgrade -y

Install latest version of docker-compose-v2

apt-get update -qq >/dev/null
DEBIAN_FRONTEND=noninteractive apt-get install -y -qq apt-transport-https ca-certificates curl >/dev/null
install -m 0755 -d /etc/apt/keyrings
curl -fsSL "https://download.docker.com/linux/ubuntu/gpg" | gpg --dearmor --yes -o /etc/apt/keyrings/docker.gpg
chmod a+r /etc/apt/keyrings/docker.gpg
echo "deb [arch=amd64 signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu focal stable" > /etc/apt/sources.list.d/docker.list
apt-get update -qq >/dev/null
DEBIAN_FRONTEND=noninteractive apt-get install -y -qq docker-ce docker-ce-cli containerd.io docker-compose-plugin docker-ce-rootless-extras docker-buildx-plugin

# Make docker root folder
mkdir /docker
cd /docker

# Download backup from github
git clone https://github.com/fatman00/netbox-backup.git

# Download netbox docker repo
git clone -b release https://github.com/netbox-community/netbox-docker.git
cd netbox-docker
# Rename override example file.
mv docker-compose.override.yml.example docker-compose.override.yml

# Try older version
export VERSION=v3.3.10

# Pull docker containers
docker compose pull

# Restore SQL data
docker compose up -d postgres
docker compose exec -T postgres sh -c 'pg_restore -v -Fc -cU $POSTGRES_USER -d $POSTGRES_DB' < ../netbox-backup/3.3.10/2023-01-26_13.13.04.pgdump

#Restore media files
docker compose up -d
docker compose exec -T netbox tar x -zvf - -C /opt/netbox/netbox/media < ../netbox-backup/3.3.10/2023-01-26_13.13.04_media.tgz

#Upgrade version
#When you are ready to upgrade the version to the latest, just shutdown, remove VERSION variable end up the containers again.
docker compose down
unset VERSION
docker compose up -d

#Create new super user
docker compose exec netbox python manage.py createsuperuser

docker compose exec netbox python manage.py migrate