canasta backup restore

Restore a backup

Synopsis

Restore a Canasta instance from a backup snapshot. By default, a safety snapshot is taken before restoring. The restore replaces configuration files, extensions, images, skins, public_assets, the sidecars/ build contexts, .env, docker-compose.override.yml, my.cnf, and all wiki databases — including any extra databases declared in config/wikis.yaml — with the contents of the specified snapshot.

Use -w/--wiki to restore only a single wiki's database, per-wiki settings, images, and public assets from the backup, leaving shared files untouched.

A snapshot tagged INCOMPLETE is missing databases that failed to dump when it was taken. Restore refuses it, naming the missing databases, unless --allow-incomplete is given; with the flag it restores everything the snapshot has and leaves the missing databases as they are. -s latest skips INCOMPLETE snapshots unless --allow-incomplete is given.

canasta backup restore [flags]

Examples

canasta backup restore -s abc123
canasta backup restore -s abc123 --allow-incomplete

Flags

Flag	Shorthand	Description	Default	Required	Orchestrator
`--snapshot`	`-s`	Snapshot ID		✓	Both
`--allow-incomplete`		Restore a snapshot tagged INCOMPLETE, which is missing databases			Both
`--id`	`-i`	Canasta instance ID	*		Both
`--skip-safety-backup`		Skip taking a safety snapshot before restore			Both
`--wiki`	`-w`	Restore only this wiki's database and per-wiki files			Both

* Defaults to the Canasta instance matching the current directory, if any.

Global flags

Flag	Shorthand	Description	Default	Required	Orchestrator
`--help`	`-h`	Show help message and exit			Both
`--verbose`	`-v`	Enable verbose output			Both