DocumentationBackup and restore
Docs/Operate

Backup and restore

Create verified backups, protect the recovery key, and understand the destructive restore path before an incident.

Check and back up

Create and verify a backup
openneko backup status
openneko backup now
openneko backup verify

Verification should be part of routine operations, not an incident-time discovery. Monitor backup age, verification result, storage capacity, and failed runs.

Protect the recovery key

Export the recovery key
openneko backup key export --to <secure-path>

Store the exported key outside the deployment host in access-controlled storage. A backup without its required key is not a usable recovery plan.

Adopt an existing recovery key
openneko backup key adopt --from <secure-path>

Restore

Restore to a point in time
openneko restore --to <RFC3339> --confirm RESTORE

OpenNeko requires a fresh verified backup before restore, stops consumers, restores metadata, records, and configuration, then reconciles the deployment before reopening the web service.

Practice recovery

  • Test recovery on a separate host or isolated deployment.
  • Record the recovery-time and recovery-point results.
  • Verify sign-in, source connections, records, plugins, and a representative workflow.
  • Update the runbook when storage, keys, ownership, or the deployment layout changes.