Documentation

Your first encrypted backup.

Install the client, connect a source, keep your encryption key and run your first backup.

All guides
A technical field guide with an amber bookmark and file tiles

Ask AI about CalmBackup

See what it does, who it’s for, and whether it fits your needs.

Opens with product context and a link to this page.

View or copy the prompt

Quick start

Three commands. That's it.

1. Install

curl -sSL https://raw.githubusercontent.com/calmbackup/cb-cli/master/install.sh | bash

Downloads a single static binary, creates a config template, and sets up a daily cron job. No sudo required.

2. Configure

calmbackup init

The setup wizard asks for your API key and database credentials, generates an encryption key, and writes the config.

3. Back up

calmbackup run

Run your first backup. After this, backups run daily at 02:00 automatically via cron.

Before you start

Create a source in your account and keep its API key available. Install the database client tools for the driver you will use. Confirm that the scheduled user can read the directories you want to include.

Keep the encryption key outside the server

The setup command generates a key locally. Keep a secure recovery copy. Resetting an account password or API key does not recover a lost encryption key.

Complete one recovery exercise

A successful backup is the beginning. Restore a selected snapshot into a separate environment and check that the application can use it.

Plan your first restore →