Docs / Documentation

Documentation

You install SafeGrd on a host that can reach your database. It encrypts each backup on that host, writes it to a locked bucket, and restores it on a schedule to test it. Your data never passes through SafeGrd's server. If you set a surface to drill on SafeGrd, it is restored on a machine started for that drill and destroyed when it ends.

Quickstart

You can try it without an account. Once it is installed, safegrd try postgres://… backs up one database and restores it as a check. Run safegrd signup to keep the backup (Try it before you sign up).

Three commands get you a tested backup. The first prints a sign-in link you can open on any device, so it works over SSH too.

# 1. install, log in, and enroll this host (generates your keypair)
curl -fsSL https://safegrd.dev/install.sh | sh
# listed under its hostname; add SAFEGRD_NODE_NAME=web-01 before sh to choose the name
# 2. take an encrypted backup
safegrd backup --database-url "$DATABASE_URL" --retention-days 14
# 3. check that it restores
safegrd verify --snapshot snap-1b094c0af8
safegrd init and a first backup, recorded in a terminal.
Where each piece goes. Your host dumps the database and encrypts it to your key. The backup goes to storage, encrypted and locked. SafeGrd's server receives a record of it: sizes, digests and dates. A Fire Drill restores the backup from storage, counts every table and sends SafeGrd the signed result. Your host dumps the database, encrypts it to your key the backup a record Storage encrypted and locked SafeGrd's server sizes, digests, dates restore Fire Drill restores the backup and counts every table signed result
The backup goes from your host to storage, and from storage into a drill. SafeGrd’s server gets a record of each backup and each drill’s signed result. The backup itself never passes through it, whichever storage you use.

With a customer-managed key, keep a copy of ~/.safegrd/keys/daemon.key.

It is the key that opens your backups. With a SafeGrd-managed key, SafeGrd keeps it sealed for you.

If you have no account, or the host cannot reach SafeGrd, run safegrd init instead. It sets up a host that backs up, restores and verifies on its own.

What the console shows

The Surfaces tab: two surfaces on host prod-app-01, each with its state, a strip of its last 30 days, its verified recovery point, restore time and schedule. The Surfaces tab: two surfaces on host prod-app-01, each with its state, a strip of its last 30 days, its verified recovery point, restore time and schedule.
The Surfaces tab lists each database, directory and mailbox with one mark per day. A solid mark means a drill restored that day's backup. Amber means there was no backup, and red means something failed.
The Overview tab: a grid of every surface by day for the last 30 days. The Overview tab: a grid of every surface by day for the last 30 days.
The Overview tab shows every surface's last 30 days in one grid.

The other tabs are covered under Fire Drills and Account.

Where to go next