Backup/Restore plan
For backing up a full system there are two aspects of what must be backed up.
- The configuration files for all components.
- The data stores (collection and spaces), system store, and file vault.
There are two approaches for backing up the data stores:
- File based backup.
- Using the Checkpoint functionality.
Note
The below documentation describes backing up the core components of a ShareAspace installation. Extensions such as the full text indexer, 3D viewer, product package extensions, and custom extension components must also be considered.
Checkpoint based
To performed a complete backup it is recommended to follow the steps below:
| Task | Role | Server | Comment | |
|---|---|---|---|---|
| 1. | Stop ShareAspace Web IIS | System admin | sasweb.machine.net | |
| 2. | Stop Reverse Proxy IIS | System admin | gateway.machine.net | |
| 3. | Backup ShareAspace Web files | System admin | sasweb.machine.net | |
| 4. | Backup Reverse Proxy files | System admin | gateway.machine.net | |
| 5. | Create a checkpoint | System admin | host.machine.net | |
| 6. | Backup checkpoint file | System admin | host.machine.net | |
| 7. | Backup FileVault folder | System admin | filevault.machine.net | |
| 8. | Start Reverse Proxy IIS | System admin | gateway.machine.net | |
| 9. | Start ShareAspace Web IIS | System admin | sasweb.machine.net |
Note
That stopping the Web and reverse proxy in IIS is to prevent users and integration components from accessing the system while the checkpoint is running. These steps are optional but recommended.
To performed a complete restored, it is recommended to follow the steps below
| Task | Role | Server | Comment | |
|---|---|---|---|---|
| 1. | Stop ShareAspace Web IIS | System admin | sasweb.machine.net | |
| 2. | Stop Reverse Proxy IIS | System admin | gateway.machine.net | |
| 4. | Restore ShareAspace Web files | System admin | sasweb.machine.net | |
| 5. | Restore Reverse Proxy files | System admin | gateway.machine.net | |
| 6. | Restore Checkpoint | System admin | host.machine.net | |
| 7. | Stop ShareAspace Host Node | System admin | host.machine.net | |
| 8. | Restore FileVault folder | System admin | filevault.machine.net | |
| 9. | Start ShareAspace Host Node | System admin | host.machine.net | |
| 10. | Start Reverse Proxy IIS | System admin | gateway.machine.net | |
| 11. | Start ShareAspace Web IIS | System admin | sasweb.machine.net |
File based
To performed a complete backup it is recommended to follow the steps below:
| Task | Role | Server | Comment | |
|---|---|---|---|---|
| 1. | Stop ShareAspace Web IIS | System admin | sasweb.machine.net | |
| 2. | Stop Reverse Proxy IIS | System admin | gateway.machine.net | |
| 3. | Stop ShareAspace Host Node | System admin | host.machine.net | |
| 4. | Backup ShareAspace Web files | System admin | sasweb.machine.net | |
| 5. | Backup Reverse Proxy files | System admin | gateway.machine.net | |
| 6. | Backup Host Node files and folders | System admin | host.machine.net | |
| 7. | Backup FileVault folder | System admin | filevault.machine.net | |
| 8. | Start ShareAspace Host Node | System admin | host.machine.net | |
| 9. | Start Reverse Proxy IIS | System admin | gateway.machine.net | |
| 10. | Start ShareAspace Web IIS | System admin | sasweb.machine.net |
To performed a complete restore, it is recommended to follow the steps below
| Task | Role | Server | Comment | |
|---|---|---|---|---|
| 1. | Stop ShareAspace Web IIS | System admin | sasweb.machine.net | |
| 2. | Stop Reverse Proxy IIS | System admin | gateway.machine.net | |
| 3. | Stop ShareAspace Host Node | System admin | host.machine.net | |
| 4. | Restore ShareAspace Web files | System admin | sasweb.machine.net | |
| 5. | Restore Reverse Proxy files | System admin | gateway.machine.net | |
| 6. | Restore Host Node files and folders | System admin | host.machine.net | |
| 7. | Restore FileVault folder | System admin | filevault.machine.net | |
| 8. | Start ShareAspace Host Node | System admin | host.machine.net | |
| 9. | Start Reverse Proxy IIS | System admin | gateway.machine.net | |
| 10. | Start ShareAspace Web IIS | System admin | sasweb.machine.net |
Component backups
ShareAspace Web
On the ShareAspace Web installation, the only thing that needs to be backed up is the configuration file:
| Server | File | |
|---|---|---|
| 1. | sasweb.machine.net | [apps_root]\Eurostep\ShareAspace\Web\config.json |
| 2. | sasweb.machine.net | [apps_root]\Eurostep\ShareAspace\Web\Web.config |
Where [apps_root] is the folder path where the ShareAspace Web installation has been done.
Reverse proxy (gateway)
On the Reverse Proxy Server installation, beside the configuration files, there is a file representing the cluster topology the Reverse Proxy is accessing to that needs to be backed up:
| Server | File | |
|---|---|---|
| 1. | gateway.machine.net | [apps_root]\Eurostep\ShareAspace\ReverseProxy\appsettings.json |
Where [apps_root] is the folder path where the ShareAspace Reverse Proxy Server installation has been done.
Host node
On a Host Node, the following folders need to be backed up:
| Server | Folder | comment | |
|---|---|---|---|
| 1. | host.machine.net | [storage_root] |
the folder containing the ShareAspace data bases for collection and spaces. Depends on the configuration of the installation see Host node installation documentation. |
| 2. | host.machine.net | [filevault_root] |
the folder containing the ShareAspace file vault see Host node installation documentation. |
| 3. | host.machine.net | [system_root] |
the folder containing the ShareAspace system storage see Host node installation documentation. |
Warning
Since the file vault folder can be very large it might not be optimal to use the standard Windows file copy as the backup function to backup the file vault. The standard file copy will also require that the ShareAspace host service is stopped before a backup can be made. Other backup approaches/tools (e.g. shadow copy) could be preferred.
and the following files:
| Server | File | comment | |
|---|---|---|---|
| 1. | host.machine.net | [apps_root]\Eurostep\ShareAspace\Host\bootstrap_host.json |
|
| 2. | host.machine.net | [apps_root]\Eurostep\ShareAspace\Host\bootstrap_collection.json |
(Optional) For a production environment it is not recommended to leave this file here after the bootstrap is done. |
| 3. | host.machine.net | [apps_root]\Eurostep\ShareAspace\Host\appsettings.json |
|
| 4. | host.machine.net | [apps_root]\Eurostep\ShareAspace\Host\Eurostep.SAS.ServiceHost.dll.config |
configuration file for changing system storage path. |
Where [apps_root] is the folder path where the Host Node installation has been done.
Licence
If the licence provided by Eurostep is lost or was not saved, use the Collection Administration API to extract the licence to a file.