Operations

Restoration

Restore a full backup to a bind mount or a named volume.

Restoration replaces active data. Stop NasDash, preserve the current store with a verified backup, identify the archive format and use the same application version first. Keep the existing secret configuration and runtime UID:GID. The interface does not restore backups.

NasDash snapshot or interface archive

An interface .tar.gz contains nasdash-backup.json plus data/. Extract it into a new private folder first; a CLI snapshot already has this layout. From a product checkout with Node.js 22, run the restore tool against the actual host bind-mount directory. --force authorizes replacement; the existing target is renamed to a sibling .pre-restore-* directory for recovery. Keep it until validation passes. --target is required when your active data differs from the checkout’s default.

# Interface archive only: extract into a NEW directory
umask 077
mkdir ./backups/nasdash-snapshot
tar -xzf ./backups/nasdash-interface-backup.tar.gz -C ./backups/nasdash-snapshot
docker compose stop nasdash
npm run data:restore -- --from ./backups/nasdash-snapshot --target ./data --force
# Grant the actual runtime UID:GID access to restored files before starting
docker compose start nasdash

Raw bind-mount archive

A raw archive made with tar -C data . contains the files directly. It cannot be passed to the snapshot tool. Stop NasDash, rename the current host data folder, create a fresh target, and extract the archive there. Do not overlay an existing directory: stale files or keys could remain. Restore owner/ACL access for the actual runtime identity, then start NasDash.

Named volume

Prefer a new, empty named volume for restoration, keeping the old volume as rollback. This example assumes nasdash-data-restore is a newly created empty volume and the raw archive was verified. For an interface archive, copy only the extracted data/ contents instead. Change the Compose mount to the restored volume only after preparing access permissions. Never remove the original volume before checking the restored instance.

docker compose -f docker-compose.named-volume.yml stop nasdash
docker run --rm \
  --volume nasdash-data-restore:/target \
  --volume "$PWD/backups:/backup:ro" \
  alpine sh -c 'tar -xzf /backup/nasdash-data-backup.tar.gz -C /target'

Check /api/health, administrator login and any configured reader accounts, pages, services, topology, logos and every integration. In public mode, verify anonymous access against the stored viewer permissions. Preserve the previous store and backup until the restored instance works. Restored backup settings may restart scheduled backups; review them too.