Sovrain
  1. Documentation
  2. Your organization

How-to guide

Back up your organization

Download an encrypted copy of your whole organization and keep it outside Sovrain.

The video plays in the corner.

This guide downloads a backup file of your whole organization, so that you can restore it after a disaster. Make one after setting up the organization, again after big changes, and on a regular schedule. Any admin can make a backup.

The backup holds the private signing keys, the SCIM tokens and the password hashes of your organization. Anyone who holds an unencrypted copy can pretend to be your identity provider, so always encrypt it. It holds no second steps: after a restore, everyone sets up two-step sign-in again. Export format lists everything a backup contains and leaves out.

Before you start

Sovrain encrypts backups with age to a public key that starts with age1. Create a key pair once with age-keygen and keep the private key safe, apart from the backups: without it, nobody can read them, you included.

To move the organization to another Sovrain, encrypt the backup to that organization’s import key instead; see Restore or move your organization.

Download the backup

  1. On your home page, under Administration, select Open admin, then select Backup in the admin menu.
  2. Under Export, keep Encrypt to an age public key selected and paste your public key into age public key.
  3. Type Your password.
  4. Select Export.

Your browser downloads a file named like org-acme-20261117-0930.json.age. Store it outside Sovrain.

If you cannot use encryption

The video plays in the corner.

Choose No encryption and tick I understand this file contains the private signing keys and SCIM tokens of this organization. The file then ends in .json. Store it like a password: anyone who has it can impersonate your identity provider.

Check when the last backup was made

The video plays in the corner.
  • Under Administration, your home page shows how long ago the last backup was made, in days, next to since last backup: for example 3 d, today or never. It turns into a warning when there is no backup or the last one is more than 7 days old.
  • The Recent table at the bottom of the Backup page lists the last 10 exports and imports, who made them, and whether each export was encrypted.

If something goes wrong

  • An export was made less than a minute ago; wait a moment and try again. Sovrain allows one export per minute.
  • Your password is not correct. After 5 wrong passwords within 15 minutes, Sovrain shows Too many wrong passwords. Wait 15 minutes and try again.