# Dashboard Backup

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

{% hint style="warning" %}
Only admin users are allowed to use Backup functionality in Dashboard.
{% endhint %}

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

{% hint style="info" %}
Exporting backup will includes all the users workspaces, profiles that belong to your unit.
{% endhint %}

#### 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

![](https://38886238-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LyYD3O_ZPKPSQ4A9j7i%2F-M1z0vgoVM2AHJLRcL0F%2F-M1zKuUwOi1XJcrQ-p2m%2FScreenshot%202020-03-09%20at%2013.48.37.png?alt=media\&token=5ad82ba9-89fc-49a7-8d6d-901fb502b010)

![](https://38886238-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LyYD3O_ZPKPSQ4A9j7i%2F-M1z0vgoVM2AHJLRcL0F%2F-M1zLsqPtfOgHiDReec1%2FScreenshot%202020-03-09%20at%2013.53.08.png?alt=media\&token=6a3c33a6-676d-4fe3-b47a-12bd81fb4a3c)

![](https://38886238-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LyYD3O_ZPKPSQ4A9j7i%2F-M1z0vgoVM2AHJLRcL0F%2F-M1zMUuznxdcCpSwk9IT%2FScreenshot%202020-03-09%20at%2013.55.49.png?alt=media\&token=69197326-17b3-461c-9c73-f16f9ad18cc1)

![](https://38886238-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LyYD3O_ZPKPSQ4A9j7i%2F-M1z0vgoVM2AHJLRcL0F%2F-M1zN7Qx6b4ZlhrN1ggN%2FScreenshot%202020-03-09%20at%2013.58.43.png?alt=media\&token=f0482bc4-16b7-4633-8d4b-30d35872509e)

{% hint style="success" %}
A backup can't be exported without a password of at least 4 character, so Dashboard can encrypt the backup for you.
{% endhint %}

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

{% hint style="danger" %}
**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.
{% endhint %}

### 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

![](https://38886238-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LyYD3O_ZPKPSQ4A9j7i%2F-M1z0vgoVM2AHJLRcL0F%2F-M1zO5f0aDQvq427Zckn%2FScreenshot%202020-03-09%20at%2014.02.58.png?alt=media\&token=fa66bc3d-97d6-494b-b9d5-7793f82801b7)

![](https://38886238-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LyYD3O_ZPKPSQ4A9j7i%2F-M1z0vgoVM2AHJLRcL0F%2F-M1zQs9vHPF-OfEGhiP8%2FScreenshot_2020-03-09_at_14_14_00.png?alt=media\&token=9517fa1e-bf35-4b04-bb95-c37899b913cc)

![](https://38886238-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LyYD3O_ZPKPSQ4A9j7i%2F-M1z0vgoVM2AHJLRcL0F%2F-M1zRkoeDLTLIZomi2QS%2FScreenshot%202020-03-09%20at%2014.18.57.png?alt=media\&token=af623071-2475-4ee0-83d7-7f58c26a4a1d)

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

![](https://38886238-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LyYD3O_ZPKPSQ4A9j7i%2F-M1z0vgoVM2AHJLRcL0F%2F-M1zUW8amkoMK0HOS1Z4%2FScreenshot%202020-03-09%20at%2014.30.43.png?alt=media\&token=22a83349-4783-4024-b050-5f8480395386)

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