Using the Control Panel backup/restore feature

Introduction

The Backup/Restore features provided by the Control Panel allow you to backup your portal data and restore it in the ONLYOFFICE Workspace. To access Control Panel, sign in to your portal and click the 'Control Panel' icon on the Start Page. Alternatively, you can go to the portal 'Settings' and select the 'Control Panel' link on the left-side panel.

Data backup

To create your portal data backup manually, switch to the Backup page in the COMMON SETTINGS section on the left sidebar and use the Data Backup section.

select the necessary type and location of the Storage for your backup files:
- select the Temporary tab if you wish to download the backup to your local drive when the backup process is over. You'll be able to do that using the link that appears below.
- select the Documents module tab and click the Plus button next to the field that appears below. The Select folder window will open. Set a folder in the Common Documents section where you wish to store your backup and click the OK button.
- select the Third-Party Storage tab, choose one of the available third-party storages, and enter the necessary data to access it:
  1. The necessary service (Amazon AWS S3, Google Cloud Storage, Rackspace Cloud Storage, Selectel Cloud Storage, DropBox, Box.com, OneDrive, Google Drive) must be previously connected in the Integration section of the portal settings. Otherwise, the corresponding storages will be disabled and grayed out.
  2. The third-party account (DropBox, Box.com, OneDrive, Google Drive, Yandex Disk, and storages connected via the WebDAV protocol, such as Nextcloud or ownCloud) must be previously connected to the Documents module as well as made shared and put into the Common Documents section. Otherwise, the corresponding storages will be disabled and grayed out.
  When the necessary storage is selected, specify the data to access it in the fields that appear below:
  - For the Amazon AWS S3 service, the following fields are available:
    - Bucket - unique Amazon bucket name, e.g., my-new-test-bucket-12345.
    - Region - an AWS region where your Amazon bucket resides, e.g., us-east-2.
    - Service Url - this is an optional property; change it only if you want to try a different service endpoint. Leave this field empty to use the default value.
    - Force Path Style - when true, requests will always use path style addressing. Leave this field empty, as the Service Url property is not specified.
    - Use Http - if this property is set to true, the client attempts to use the HTTP protocol if the target endpoint supports it. By default, this property is set to false. Set it to true or leave this field empty to use the default value.
    - Server Side Encryption Method - the server-side encryption algorithm used when storing this object in S3. The possible values are:
      - None
      - Server-Side Encryption - SSE-S3 (your assets will be encrypted with strong AES-256 GCM keys, one separate key for each object. The keys themselves are encrypted with a rotating root key for additional protection) or SSE-KMS (your assets will be encrypted with a versatile encryption mechanism. Like SSE-S3, it relies on a strong AES-256 encryption method, but provides a more complex and flexible model, offering separate permissions for a KMS key, an audit trail feature, and the ability to create unique custom keys). For SSE-KMS, you can choose Managed CMK - Default AWS managed CMK or Customer managed CMK. When the Customer managed CMK option is selected, you need to specify the KMS Key Id.
      - Client-Side Encryption - when this option is selected, you need to specify the KMS Key Id.
  - For the Google Cloud Storage service, the following field is available: Bucket (unique Google Cloud bucket name, e.g., test_bucket111419).
  - For the Rackspace Cloud Storage service, the following fields are available: Public container (Rackspace public container URL address), Private container (Rackspace private container URL address), and Region (a region where your Rackspace containers are located).
  - For the Selectel Cloud Storage service, the following fields are available: Private container (Selectel private container name, e.g., test_container) and Public container (Selectel public container name, e.g., test_container_public).
  - For the DropBox, Box.com, OneDrive, Google Drive, Yandex Disk services or storages connected via the WebDAV protocol, click the Plus button next to the field that appears below. The Select folder window will open. Set a third-party resource directory located in the Common Documents section where you wish to store your backup and click the OK button.
- select the Computer file tab if you wish to save the backup on your local drive. In the Choose the storage location field that appears below, specify the path to the folder where you wish to store your backup.
If you select the Documents module or one of the third-party services connected to it (DropBox, Box.com, OneDrive, Google Drive, Yandex Disk, and storages connected via the WebDAV protocol), the backup file size affects the overall disk space used on your portal.
check the Include Mail in backup box if you want to backup the Mail data as well. This increases the backup process time and backup file size, but if this option is unchecked, the Mail data will be lost after restoring, and you'll need to connect accounts again. Please refer to the Backup Mail data section to find additional instructions for Mail.
The license data will not be included in the backup. After restoring the backup, you will need to upload your license file again.
click the MAKE BACKUP button.

Once the backup process is completed, you'll find the backup .tar.gz file (portal-name_date_time.tar.gz) in the specified folder. If you've selected the Temporary storage, the link to download the created backup will be available for 24 hours.

When encryption is enabled, a newly created backup copy of the data archive will contain decrypted files. When such a copy is restored, the files will be encrypted on the disk again.

Backup Mail data

Perform additional actions to backup the Mail data.

This instruction does not work for Windows version.

Enter the Community Server container:

docker exec -it onlyoffice-community-server bash

Go to the services folder:

cd /var/www/onlyoffice/Services/TeamLabSvc

Open the configuration file:
```
nano TeamLabSvc.exe.config
```
Add settings for access to the host machine:
```
<backup>
  <mailServer pathToMailFilesOnHost="/app/onlyoffice/MailServer/data" hostAddress="127.0.0.1" hostUsername="root" hostKey="/tmp/key.pem" />
</backup>
```
- pathToMailFilesOnHost - the full path to the Mail Server files. For Linux, you can specify the following path: /app/onlyoffice/MailServer/data.<
- hostAddress - the address of the machine where the Mail Server container is located.
- hostUsername - the username for connecting to the machine where the Mail Server container is located.
- hostPassword - the password for connecting to the machine where the Mail Server container is located.
- hostKey - the path to the file with the user's SSH certificate for connecting to the machine where the Mail Server container is located. The file must be in the OpenSSH format, it can be generated with Putty Key Generator.
ImportantEither hostPassword or hostKey field must be filled in. If both fields are filled in, the connection will be performed using the key first, if unsuccessful, the password will be used.
ImportantThe user (hostUsername) specified in the settings must have rights to read and write the folder with the Mail Server files (pathToMailFilesOnHost). For Linux machines, you can execute the following command: chmod -R 755 /app/onlyoffice/MailServer/data.
Save the file (Ctrl+S) and exit (Ctrl+X).
Restart the service:
```
systemctl restart onlyofficeBackup
```
Proceed to the Data restore section to restore data from the backup file.

Automatic backup

To automate the backup process, switch to the Backup page in the COMMON SETTINGS section on the left sidebar and use the Automatic backup section:

click the Disabled switcher to enable the feature.
select the necessary Storage for your backup files (the available options are the same as those described above, except for the Temporary storage, which is only available in the Data Backup section).
specify the time interval at which backups should be created: Every day with an indication of the necessary time of the day, Every week with an indication of the necessary day of the week and time of the day, or Every month with an indication of the necessary day of the month and time of the day.
set The maximal number of backup copies to be stored by selecting the necessary value (from 1 to 30) from the corresponding drop-down list.
check the Include Mail in backup box if you want to backup the Mail data as well.
click the SAVE button.

Backups will be created automatically with the specified periodicity.

Data restore

Due to the new mechanism of password encryption, there is no possibility to restore the password from the backup using the core.machinekey key, which differs from the original one. To ensure correct portal operation, specify the old server key in the web.appsettings.config, TeamlabSvc.exe.Config files, and in the Control Panel production.json config file before restoring the backup on a new server.

For the Docker version, you can replace machinekey here /app/onlyoffice/CommunityServer/data/.private/machinekey and restart the Community Server container. It's also possible to use the mk parameter in the installation script to specify the machinekey when installing ONLYOFFICE Workspace. E.g., bash workspace-enterprise-install.sh -mk yourmachinekey or bash workspace-install.sh -mk yourmachinekey.

To restore your portal data from the previously created backup file, switch to the Restore page in the COMMON SETTINGS section on the left sidebar.

select the Source where your backup files are stored:
- select the Documents module tab and click the Plus button below. In the Select file window, choose the necessary backup file stored in the Common Documents and click OK.
- select the Third-Party Storage tab, choose the necessary third-party storage, and enter the data to access it as well as the necessary backup file URL address in the Path field.
  For accounts connected to the Documents module (DropBox, Box.com, OneDrive, Google Drive, Yandex Disk and storages connected via the WebDAV protocol), click the Plus button below. In the Select file window, choose the necessary backup file stored in the third-party resource directory located in the Common Documents section and click OK.
- select the Computer file tab, click the Plus button next to the Choose the storage location field, and browse for the necessary backup file stored on your local drive.
  Instead of selecting a backup file from a certain Source, you can just click the Show the backup list link below the radio buttons to select the necessary backup file from the backup history (if a backup file was deleted manually from the storage, it will not be available in the list). Click the Restore link next to the necessary backup file. To delete a backup file from the list, click the icon.
if necessary, leave the Send notification about portal restore process to users box checked to notify your portal users;
click the RESTORE button.
Remember that you will need to upload your license file again when the restoring process is complete. This can be done in the Payments section.
If you create a backup file in the cloud version and then restore it in the server version, current passwords will be reset, and access can only be restored via the Forgot your password? link on the authorization page.

Host ONLYOFFICE Workspace on your own server

Download