Quick start
Register a database and an S3 destination, then run and inspect your first backup.
This guide walks through the initial Acrynite setup end to end.
1. Register a PostgreSQL database
$acrynite database register production \$ --host db.example.com \$ --port 5432 \$ --username acrynite_backup \$ --database app_db \$ --ssl-mode require
Replace the example values with your real connection details.
2. Register an S3 destination
$acrynite storage register s3-prod-backups \$ --provider s3 \$ --bucket company-backups \$ --prefix acrynite/production \$ --region eu-west-1
Acrynite uses the normal AWS credential chain, which can include environment credentials, shared profiles or instance roles.
3. Test the connection
$acrynite database test-connection production
4. Run a logical backup
$acrynite backup run \$ --database production \$ --type logical \$ --storage s3-prod-backups
5. Inspect backup history
$acrynite backup list --database production$acrynite backup show <backup-id>
Keep secrets out of shell history
A --password option exists, but avoid putting secrets in commands that your shell retains in history. Prefer the AWS credential chain and PostgreSQL authentication files.
First-backup checklist
- Confirm the database profile points to the intended PostgreSQL instance.
- Test the database connection.
- Confirm the bucket and prefix.
- Confirm the AWS credentials can write to the destination.
- Execute a backup and confirm it completed.
- Inspect its backup record and manifest.
- Perform a test restore and verify the recovered data.
