Getting Started
This section walks you from zero to a working backup-and-restore workflow. Pick the path that fits your schedule.
In a Hurry?
Jump straight to the Quickstart -- you will have a backup running in under 5 minutes with Docker and local filesystem storage.
Ready to Learn?
Work through these guides in order:
| Guide | Time | What You Will Learn |
|---|---|---|
| Quickstart | 5 min | Install the binary, start RabbitMQ, run a backup, verify it |
| CLI Basics | 10 min | Every command the CLI supports, with examples |
| First Backup | 20 min | Full end-to-end tutorial: publish messages, back up, verify non-destructive behaviour, restore to a different queue, validate |
Prerequisites
Before you begin, make sure you have:
- Docker (for running RabbitMQ and MinIO locally)
- Rust toolchain (if building from source) or a pre-built binary
- A terminal with
curlorrabbitmqadminavailable (for publishing test messages)
tip
You do not need an AWS, Azure, or GCP account to get started. The quickstart uses local filesystem storage, and you can use MinIO as a drop-in S3 replacement for testing.
What Happens Next?
Once you have completed the getting-started guides, explore these areas:
- Guides -- production workflows like S3 backup, PITR restore, and monitoring
- Reference -- full CLI reference, YAML configuration spec, and storage format details
- Deployment -- run in Docker, Kubernetes, or bare metal