Dashboard Backup

Take a snapshot of your current environment

What is Dashboard Backup?

Dashboard Backup creates a backup of the Dashboard with all the configuration and settings in order to be used when a revert to earlier working state is needed.

How can it help me?

It allows the users to revert their Dashboard state (including workspaces, installed plugins, profiles, and config key store with all the config) to that of a previous point when the backup has been taken, which can be used to recover your Dashboard in case of malfunctions or other problems.

Only admin users are allowed to use Backup functionality in Dashboard.

How does it work?

You can either Export or Import a backup of your Dashboard with the Backup page

Export backup

By exporting a backup, Dashboard will collect all your Unit state including:

  • Plugins, with all the configurations, permissions, and mappings.

  • Profiles, with all the assigned workspaces.

  • Config key store, with all the values.

Exporting backup will includes all the users profiles that belong to your unit.

How to export a backup

Open the Dashboard menu in the top-right corner.

Click on "Admin settings" at the bottom of the menu.

Under "Export backup" type your custom backup password to encrypt the image and click on "Download backup".

Dashboard will download your backup automatically.

A backup can't be exported without a password of at least 4 character, so Dashboard can encrypt the backup for you.

After following these steps, you will get an encrypted backup that can be imported back anytime you want to your Dashboard.


Don't use the same backup for all your units, try to export a backup for each unit so you have your data separated.

Import backup

By importing a backup, Dashboard will validate your backup and check if the payload is valid to import.

Then Dashboard will WIPE all your current unit data, from plugins ending up with config key store.

The Dashboard will then start importing all the backup data.

How to import a backup

  1. Open the user menu in the top-right corner and click on "Admin settings" at the bottom of the menu.

  2. Go to the headline " Import backup".

  3. Click on "Upload your backup file".

  4. Choose your backup file.

  5. Type your backup password

  6. Click on "Validate" button

7. After validating, Dashboard will show you the content of the backup including the amount of plugins, profiles and configs in key store.

8. Click on "Import" button.

When the backup import is done. Dashboard will automatically reload your browser in order to finish the process.

Last updated