# kamal-backup Documentation

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

Start with getting started, how backups work, and configuration; then use the restore, restore-drill, evidence, command, and security references. Source is on [GitHub](https://github.com/crmne/kamal-backup).

## Full Documentation

- [Complete documentation](https://kamal-backup.dev/llms-full.txt): All canonical pages in one Markdown document.

## Overview

- [kamal-backup Documentation](https://kamal-backup.dev/): Add scheduled, encrypted backups to Rails apps deployed with Kamal: database dumps, Active Storage files, restore drills, and review evidence.

## Guide

- [Getting Started](https://kamal-backup.dev/getting-started/): Add one Kamal accessory that runs scheduled backups for your database and file-backed Active Storage files.
- [How Backups Work](https://kamal-backup.dev/how-backups-work/): Why restic is the backend, what scheduled backup runs do, and how restore drills and evidence fit together.
- [Configuration](https://kamal-backup.dev/configuration/): YAML-first setup, generated config, deploy mount, secrets, local overrides, and optional settings.
- [Restore](https://kamal-backup.dev/restore/): Restore database and Active Storage backups onto your local machine or back into production.
- [Restore Drills](https://kamal-backup.dev/restore-drills/): Practice Rails restores on your laptop or production infrastructure, run checks, and keep evidence for security reviews like CASA.
- [Migrating to a new host](https://kamal-backup.dev/migrating-hosts/): Move a running app to a new server by restoring from your backup repository, using the migration as a real restore drill.
- [Evidence for Security Reviews](https://kamal-backup.dev/evidence/): Use scheduled backups, restore drills, kamal-backup checks, and evidence output to prepare for security reviews like CASA.
- [Upgrading](https://kamal-backup.dev/upgrading/): Version-by-version upgrade notes for breaking changes and config migrations.

## Reference

- [Commands](https://kamal-backup.dev/commands/): Command reference for scheduled backups, restores, drills, checks, evidence, and Kamal-style destination selection.
- [Security and Restore Safety](https://kamal-backup.dev/security/): How kamal-backup handles secrets, subprocesses, database exports, Active Storage snapshots, and deliberate restores.
- [Docs Deployment](https://kamal-backup.dev/deployment/): How the documentation site is built and deployed.

## Pages

- [About kamal-backup](https://kamal-backup.dev/about/): kamal-backup is an open source Ruby gem and Kamal accessory for scheduled Rails backups, restore drills, and security review evidence.