# Backup configure & restore

# Introduction to Backup

## What is the Backup addon?

Soffid allows you to add a backup addon to the console to save a snapshot for each user to keep track of changes as they occur.

`Main Menu > Administration > Configuration > Global Settings > User backup configure & restore`

On the **User backup configure & restore** page you could manage the user snapshots and configure the backup.

- To configure the backup you need to configure some parameters
- To restore user data for a specific date, you only need to select the proper record and click the restore button.

<p class="callout info">The user's snapshot will be available on the [User page](https://bookstack.soffid.com/link/42#bkmrk-backups) as well. There you could manage the user backup data.</p>

# How to install Backup addon in Soffid

## Installation

### Download

Please download the Soffid Backup add-on.

You could download it at the following link [http://www.soffid.com/download/enterprise/](http://www.soffid.com/download/enterprise/) if you have a Soffid user with authorization, or in the following [http://download.soffid.com/download/](http://download.soffid.com/download/) by registering.

### Upload

<span style="color: #a6d100; font-weight: bold; font-size: 18px;">1.</span> Once the Backup add-on is downloaded, please log in to IAM Console.

<p class="callout info">You need to be an administrator user of the Soffid console or a user with permission to upload addons.</p>

<p class="callout info">It is recommended to upload the addons to the master, this is the way to maintain updated all, master and tenants if there are.</p>

<span style="color: #a6d100; font-weight: bold; font-size: 18px;">2.</span> In the Soffid console, please go to:

`Main Menu > Administration > Configure Soffid > Global Settings > Plugins`

<span style="color: #a6d100; font-weight: bold; font-size: 18px;">3.</span> Then, click the add button (+) and pick the file and Soffild will upload the addon file.

<p class="callout info">For more information visit the [Addons Getting started](https://bookstack.soffid.com/books/addons-getting-started/page/getting-started "Addons installation") page.</p>

<span style="color: #a6d100; font-weight: bold; font-size: 18px;">4.</span> Finally, when the addon is installed, it will be required to restart the Soffid Console.

<span style="color: #a6d100; font-weight: bold; font-size: 18px;">5.</span> Once the Soffid console is restarted, you could check the plugin was uploaded properly on the plugins page:

`Main Menu > Administration > Configure Soffid > Global Settings > Plugins`

<span style="color: #a6d100; font-weight: bold; font-size: 18px;">6.</span> Now, you can set-up the Backup.

# User backup configure & restore



# User backup restore

## Description

On the **User backup configure &amp; restore page**, you could search, check and restore the user's snapshots.

`Main Menu > Administration > Configuration > Global Settings > User backup configure & restore`

## Screen overview

[![image-1655374153334.png](https://bookstack.soffid.com/uploads/images/gallery/2022-06/scaled-1680-/image-1655374153334.png)](https://bookstack.soffid.com/uploads/images/gallery/2022-06/image-1655374153334.png)

## Custom attributes

- **User Name**: to identify the user.
- **Valid since**: date and time when the user changes were saved.
- **Valid until**:
- **Download**: XML file with the user snapshot info.

## Actions

### Backup query actions

<table border="1" id="bkmrk-add-or-remove-column" style="width: 100%;"><tbody><tr><td style="width: 18.6603%;">**Query**

</td><td style="width: 81.3397%;">Allows you to query users through different search systems, [Basic and Advanced](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/search-types "Search Types").

</td></tr><tr><td style="width: 18.6603%;">**Download CSV file**

</td><td style="width: 81.3397%;">Allows you to download a CSV file with the basic information of all backups.

</td></tr><tr><td style="width: 18.6603%;">**Configure backup**

</td><td style="width: 81.3397%;">Allows you to configure the backup parameters.

For more information visit the [User backup configure ](https://bookstack.soffid.com/books/backup-configure-restore/page/user-backup-configure)page.

</td></tr><tr><td style="width: 18.6603%;">**Download**

</td><td style="width: 81.3397%;">Allows you to download an XML file with the user. You only need to click on the download icon of one of the records and save the file on your computer.

</td></tr><tr><td style="width: 18.6603%;">**Restore**

</td><td style="width: 81.3397%;">Allows you to restore one or more users' snapshots.

First of all, you need select one or more snapshots. Second, you need to click the restore button. Then Soffid will run the restore process.

</td></tr></tbody></table>

# User backup configure

## Description

Soffid allows you to configure some backup parameters.

Go to In the "User backup configure &amp; restore" page, in the hamburger button click the option "Configure backup".

## Screen overview

[![image-1655373900307.png](https://bookstack.soffid.com/uploads/images/gallery/2022-06/scaled-1680-/image-1655373900307.png)](https://bookstack.soffid.com/uploads/images/gallery/2022-06/image-1655373900307.png)

## Custom attributes

- **Minimum delay between backups**
- **Number of backups to keep alive**
- **Enable entitlements history**

<span style="color: #222222; font-size: 2.8275em; font-weight: 400;">Actions</span>

<table border="1" id="bkmrk-add-or-remove-column"><tbody><tr><td>**Accept**

</td><td>Allows you to save the configuration.

</td></tr><tr><td>**Cancel**

</td><td>Allows you to cancel any change and close the configuration window.

</td></tr></tbody></table>