Dashboard Backup

Take a snapshot of your current environment

Please be aware that this functionality is only available in Stage and Dev environments only, and it's under testing.

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.

  • Workspaces, with all the applications including all the configs.

  • Profiles, with all the assigned workspaces.

  • Config key store, with all the values.

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

How to export a backup

  • open the user menu in the top-right corner.

  • click on "Backup" at the bottom of the menu

  • click on "Continue" button

  • type your custom backup password to encrypt the image

  • click on "Export"

  • 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.

IMPORTANT

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.

  2. click on "Backup" at the bottom of the menu

  3. click on "Continue" button

  4. click on "Import" tab

  5. click on "Browse" button

  6. upload your backup

  7. type your backup password

  8. click on "Validate" button

  9. click on "Import" button

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

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

Last updated