Skip to main content

Backups

Your chat, wiki, passwords and databases live on your server. If the server is lost, so is everything on it. A backup copies that data, encrypted, to a bucket somewhere else.

Open a server under Servers, and find Backups. A server with no backups is also flagged on the Dashboard.

Set up backups​

  1. Press Set up backups.
  2. Enter the endpoint and bucket of an S3-compatible storage outside this server. Cloudflare R2 has a free tier and no download fees; Backblaze B2 and DigitalOcean Spaces work too. Tick Create the bucket for me to let Desktop create an R2 bucket from a Cloudflare API token, which is used once and never saved.
  3. Enter the access key and secret key for the bucket. They go straight to the LaraKube CLI and are not kept in the activity log.

Save your recovery card​

Setup writes a recovery card on this computer (~/.larakube/backup-recovery.txt). It holds the passphrase that unlocks your backups. Without it, backups cannot be read, and it is not kept on the server.

Press Show the file, and keep a copy somewhere that is not this computer and not this server, such as a password manager on another device. Then tick I saved a copy somewhere else. Desktop never reads the file.

Schedule​

Press Schedule and choose every night, twice a day or every Sunday, and the timezone. Change edits it and Stop removes it. Back up now takes a backup right away.

Your backups​

Once a backup exists, the list shows when each was taken, its size and how many items it holds.

  • Check reads and decrypts every item to prove the backup can be restored. It changes nothing. Run it now and then: a backup you have never tested is only a hope.
  • Restore… replaces live data with the copy. Choose a database or a volume, give its name, and type the name again to confirm. A volume's service is stopped while it is restored.
  • Clean up old backups keeps the last 7 days, then the newest of each of the last 4 weeks and 6 months, and removes the rest and any unfinished ones. Preview first: it shows what would go and deletes nothing.
note

Backups need the AWS CLI on this computer to list what is stored. Install it from Setup if the page asks.

Every action here is a backup:* command of the LaraKube CLI, and shows in Activity.