Back up & restore NASitron

Stop before backing up

The offline backup utility makes a consistent SQLite copy and encrypts the archive using a password of at least 12 characters. It includes the data directory and NASitron environment/secret key. Keep the password separately.

docker compose stop nasitron
mkdir -m 700 backups
docker compose run --rm --no-deps --user root \
  -v "$PWD/backups:/backup" nasitron \
  python -m app.backup create /backup/nasitron.nsb
docker compose start nasitron

Preserve deployment files too

Back up .env, Compose configuration and Caddy’s separate data volume through your deployment backup process. The internal CA and managed certificates may live in that Caddy volume, outside the utility archive.

Restore into a new directory

The utility refuses to overwrite an existing restore directory and validates SQLite integrity. Use the upstream recovery instructions to restore, review environment path overrides, reapply the exact saved secret key, correct ownership and reconnect the service. Keep recovery files private. Do not run original and restored dashboards against the same NAS while testing.

The utility supports at most 512 MiB of unencrypted contents. For larger installations use a tested external encrypted backup of the stopped service data, configuration and key.