# kamal-backup Documentation

> Documentation for kamal-backup, an open source Ruby gem and Kamal accessory that schedules encrypted Rails database and file-backed Active Storage backups, restores data locally or into production targets, runs restore drills, and emits redacted evidence for security reviews.

## About

kamal-backup is an open source Ruby gem and Kamal accessory for scheduled Rails database backups, file-backed Active Storage backups, restore drills, and security review evidence.


## Key Topics

- Ruby on Rails backups
- Kamal deployment
- restic repositories
- Active Storage
- PostgreSQL backups
- MySQL backups
- SQLite backups
- restore drills
- backup evidence
- security review evidence
- CASA security reviews

## Primary use case

Use kamal-backup when a Rails application is deployed with Kamal and needs scheduled database backups, file-backed Active Storage backups, restore drills, kamal-backup checks, and security review evidence from one accessory.

## Best starting points

Start with /getting-started/ for installation, /how-backups-work/ for architecture, /configuration/ for YAML and Kamal accessory settings, /restore-drills/ for verification workflows, /evidence/ for security review output, and /commands/ for the complete command reference.

## Documentation map

- [Getting Started](https://kamal-backup.dev/getting-started/): install the gem, generate config, add the Kamal accessory, and run the first backup.
- [How Backups Work](https://kamal-backup.dev/how-backups-work/): understand restic snapshots, backup paths, checks, restore drills, and evidence.
- [Configuration](https://kamal-backup.dev/configuration/): configure YAML, secrets, local restore overrides, retention, and restic options.
- [Restore](https://kamal-backup.dev/restore/): restore database and Active Storage backups locally or into production.
- [Restore Drills](https://kamal-backup.dev/restore-drills/): practice and record restore verification workflows.
- [Evidence for Security Reviews](https://kamal-backup.dev/evidence/): produce redacted JSON for CASA-style security reviews.
- [Commands](https://kamal-backup.dev/commands/): reference every kamal-backup command and option shape.
- [Security and Restore Safety](https://kamal-backup.dev/security/): review secret redaction, subprocess handling, backup formats, and deliberate restore behavior.

## Links

- About: https://kamal-backup.dev/about/
- GitHub: https://github.com/crmne/kamal-backup
- Rubygems: https://rubygems.org/gems/kamal-backup
- GitHub: https://github.com/crmne/kamal-backup/pkgs/container/kamal-backup