Checkmate
DocumentationCheckmate Connect

Cloud backups

Encrypted backups of your Checkmate database through Checkmate Connect, with scheduled runs and restore.

Overview

Cloud backups copy your installation's database to Checkmate Connect. Each backup is encrypted on your server before upload, so Connect only stores ciphertext. Backups and restores are run from Settings → Checkmate Connect and need an enrolled server.

Recovery key

Backups are encrypted with a recovery key that stays on your server. Without it, nobody can restore your backups, including the Connect team.

  1. Under Recovery key, click Generate recovery key
  2. Click Copy key, store the key somewhere away from this server, then click I have saved it. The key is shown only once.
  3. Paste the key from where you stored it to confirm the copy works. Tick the acknowledgement, then click I have stored the key.

The key is stored on your server, encrypted with ENCRYPTION_KEY.

Lost key. Click I lost my key to start again with a new key. Backups made with the old key can't be restored with the new one. They're kept for 30 days after your first backup with the new key, so you can switch back if you find the original.

Running a backup

  • Back up now: backs up the whole database
  • Back up configuration only: backs up everything except check history

A backup covers the data you created: monitors and their check history, incidents, status pages, notifications, maintenance windows, users, teams and settings. Queue and worker state is never included. A configuration backup also leaves out check history (checks, monitorstats, geochecks and dockerlogs).

Backups run on the job queue, so the process that runs jobs picks them up. If you run with QUEUE_PRIMARY_PROCESSES=false and no worker is running, the backup waits until a worker starts.

Scheduled backups

Under Scheduled backups, turn on automatic backups and choose:

  • Back up every: 1, 3 or 7 days
  • Backup type: full database or configuration only

The first scheduled backup starts as soon as you turn the schedule on. A scheduled backup that comes due while another backup, restore or key check is running is skipped until the next interval. Restarting Checkmate doesn't trigger an extra backup. Scheduled backups count towards your plan's backup versions like manual ones.

Restoring a backup

  1. Under Restore a backup, pick a backup and click Restore
  2. Confirm the restore

Checkmate downloads the backup, checks its size and checksum, decrypts it with the recovery key and replaces the current database. This can't be undone.

  • User accounts are replaced too, so log in with an account from the backup afterwards.
  • After the restore, the job queue is rebuilt from the restored monitors.
  • If the backup was made by an older Checkmate version, restart Checkmate afterwards so newer migrations run on the restored data.

Moving to a new server

  1. Install Checkmate on the new server and enroll it with the same Connect account
  2. Under Recovery key, choose I already have a recovery key
  3. Paste the 64-character key from the original server and click Use this key

Checkmate decrypts one of your cloud backups to check the key before saving it. Your backups then appear under Restore a backup.

Required tools

Backups use mongodump and mongorestore from the MongoDB Database Tools on the processes that run jobs.

  • Docker image: included
  • Source install: install the MongoDB Database Tools. On macOS, run brew install mongodb/brew/mongodb-database-tools. If the tools aren't on PATH, set CONNECT_MONGODUMP_BIN and CONNECT_MONGORESTORE_BIN.

The settings page shows these install steps until a job-processing process finds the tools.

On this page