-
Notifications
You must be signed in to change notification settings - Fork 0
Operations
Operations are the habits that make backups useful when something goes wrong. A backup system is not complete until backup, verification, restore, and evidence review have all been exercised.
Web UI:
http://localhost:8976
API health:
curl http://localhost:8976/api/v1/healthCLI health:
convex-autobackup health --json
convex-autobackup doctor --jsonThe web console guides the main setup path. Complete these items before trusting the system:
- Create an owner account.
- Create a project.
- Store or reference a Convex deploy key.
- Create a Convex Cloud target.
- Create a local or S3-compatible destination.
- Create a backup job.
- Create a schedule.
- Run a manual backup.
- Verify the backup.
- Run a restore drill against a non-production deployment.
CONVEX_AUTOBACKUP_MASTER_KEY=<master> convex-autobackup backup run \
--job-id <job-id> \
--jsonList runs:
convex-autobackup runs --jsonVerify:
convex-autobackup verify --run-id <run-id> --jsonRestore requires explicit target confirmation:
CONVEX_AUTOBACKUP_MASTER_KEY=<master> convex-autobackup restore \
--run-id <run-id> \
--target-id <target-id> \
--confirm-deployment <deployment-name> \
--jsonDo not test restore against production unless you are intentionally performing a real incident recovery.
Generate a DR report:
convex-autobackup dr-report --jsonReview audit events:
convex-autobackup audit --jsonEvidence to keep:
- Backup schedule and retention settings.
- Recent successful backup runs.
- Recent verification results.
- Restore drill date and result.
- Storage destination and manifest references.
- Operator notes for any failed run.
Docker:
docker logs convex-autobackupsystemd:
journalctl -u convex-autobackup -fNative foreground:
convex-autobackup superviseLocal retention currently supports keep_last behavior after a successful backup. Keep enough backups to cover operator mistakes, application bugs, and delayed discovery of data corruption.
Recommended starting point:
- Critical production: keep at least 14 to 30 successful backups.
- Client/project work: keep at least 7 successful backups.
- Development-only: keep enough for your own rollback window.
Watch releases:
https://github.com/KodyDennon/ConvexAutoBackup/releases
Before upgrading:
- Back up the ConvexAutoBackup data directory.
- Export current configuration notes.
- Confirm the master key is recoverable.
- Read release notes.
- Upgrade.
- Run
doctor. - Run and verify a backup.
ConvexAutoBackup docs: Repository · Releases · Docker Hub · crates.io