Page Comparison

# Backup and Restore

- [Introduction](#introduction)
- [SQL Server](#sql-server)
- [Backup Procedure](#backup-procedure)
- [Restore Procedure](#restore-procedure)

## Introduction

To ensure that server failures or data corruption do not result in a permanent loss of the ability to do searches, it is recommended to do backups every now and then. Backups are done by first stopping Saga, then copying the 3 items listed below to another server, before finally starting Saga again (the description assumes that the recommended install directory is being used):
 - All directories under `D:\Program Files\ayfie\saga\data` with the exception of Solr and Zookeeper directories
 - The Docker configuration file `D:\Program Files\ayfie\saga\docker\custom.env`
 - The directory `D:\Program Files\ayfie\saga\volumes`

The items above hold data of various types that is retrieved or produced by Saga during normal operation. This includes various databases of which the most important one is the one holding source data retrieved by the connectors. As the index (Solr and Zookeeper) can become very large and one can relatively quickly reconstruct it from the stored source data, these instructions do not include backing up the index but rather later rebuilding it from the restored data.

## SQL Server

If Saga is configured with an external SQL Server database, then database backups are the responsibility of the administrators of that database.

## Backup Procedure

To back up Saga, run the `D:\Program Files\ayfie\saga\scripts\backup-data.ps1` script (assumes recommended installation path). The script will stop Saga, back up all required files to `D:\Program Files\ayfie\saga\backup\data\<yyyyMMddHHmmss>` and then start Saga again. The backup directory should be moved to another server.

## Restore Procedure

This is how to restore Saga using the backed up data:

 - Stop Saga.
 - Remove everything under `D:\Program Files\ayfie\saga` (assumes recommended install directory path)
 - Install Saga from scratch by following the [Ayfie Locator Installation Guide](https://ayfie-dev.atlassian.net/wiki/spaces/SAGA/pages/2400714758/Ayfie+Locator+Installation+Guide).
 - During the installation, answer _Y_ to the EULA question and directly click _== Exit ==_ when the menu comes up.
 - Once Saga is fully up and running, stop it again.
 - Manually replace the 3 items described in the introduction with the backed up data.
 - Start Saga.
 - Once Saga is fully up and running, reindex all data with this command:
`docker exec ayfie-locator PowerShell C:\Locator\Tools\Via.Repository.exe REINDEX /all`
 - Open the Management Console to see the list of all connectors that were in use:
 `.\start-management-console.ps1`
 - Install all the listed connectors as described in section _Installing Connectors_ of the [Ayfie Locator Installation Guide](https://ayfie-dev.atlassian.net/wiki/spaces/SAGA/pages/2400714758/Ayfie+Locator+Installation+Guide)