Articles with the tag:
Close
Changelog
Close
Help Center
Control Panel

Using the Control Panel backup/restore feature

Control Panelv.2.9 Control Panel changelog

Version 2.9

Release date: 10/15/2020

General

  • Control Panel is available in the free Community version with all settings excepting the Private Room activation and the editors logo replacement;
  • Added the vsyscall check to the installation scripts when installing Mail Server on Debian with kernel 4.18.0 and later;
  • Redesign of the navigation menu: added Common and Portal settings sections, added icons to menu items;
  • Added the advanced rebranding page in the Common Settings;
  • Added the possibility to reindex the full-text search;
  • Updated node.js, updated packages (transition to samlify for SSO);
  • Added the Encryption at rest block in the Storage section;
  • Added the Private Room section for the paid server version only;
  • Added the upgrade page with a proposal to upgrade to Enterprise Edition;
  • Added the activate page with a possibility to upload a license file;
  • Added the HideAuthPage option to the SSO settings to hide the authorization page. When the HideAuthPage option is enabled, an automatic redirect from the authorization page to the SSO service will occur.

LDAP

  • Added the Sign in to domain option on the authorization page.

Single Sign-on

  • Transition to the new samlify library;
  • Added the HideAuthPage option to the SSO settings to hide the authorization page. When the HideAuthPage option is enabled, an automatic redirect from the authorization page to the SSO service will occur.

Version 2.7

Release date: 04/25/2019

LDAP

  • Added more fields mapped for the users loaded via LDAP: user photo, birthday, contacts, primary phone number;
  • Added the setting to autosync LDAP on schedule;
  • Added the possibility to give administrator rights to the user group at the portal via LDAP;
  • Updated the rules for LDAP users.

Version 2.5.1

Release date: 04/07/2018

LDAP

  • Fixed the Server internal error error when using the groups enclosed inside each other in the AD (bug #37414).

Single Sign-on

  • Fixed the issue when the user data between the Service Provider and the portal was transferred via HTTP only, even when HTTPS was enabled.

Version 2.4.0

Release date: 01/13/2018

Single Sign-on

  • Fixed the Invalid ssoConfig error which occurred when the link to the IdP contained the question mark '?', e.g.: IdP Single Sign-On Endpoint URL: https://accounts.google.com/o/saml2/idp?idpid=777777;
  • Fixed the Invalid authentication token error which prevented from adding a user to the portal using the AD FS, in case the + or - characters were present when sending the encrypted data.

Version 2.3.0

Release date: 12/15/2017

General

  • Added the changelog for Control Panel and link to it;
  • Fixed the bug when JWT parameters were not sent when updating Document Server(bug #36270);
  • Fixed the bug when Audit Trail heading was present at the login history page (bug #36026);
  • The current machine is now checked for being linked with the domain name for multiple portals.

LDAP

  • Fixed the bug with the LDAP Domain not found error which occurred if the DN record had no DC records (the users with Sun/Oracle DS were affected); now if the LDAP domain could not be specified, the LDAP domain will acquire the unknown value or the ldap.domain value from the web.appsettings.config configuration file;
  • Fixed the bug with the Sizelimit Exceeded error when trying to get more than 1000 users from the Active Directory;
  • Increased the login speed with the Group Membership setting enabled;
  • Added additional logging;
  • Fixed the bug with LDAP operation hanging when using Mono v5.2.0 and older;
  • Fixed the bug with the error when trying to login using the email address entered in the fields different from the Mail Attribute;
  • Fixed the bug occurring in the enclosed groups, when the users were displayed not in all groups.

Version 2.2.0

Release date: 10/31/2017

General

  • Added the documentserver-prepare4shutdown.sh script launch when updating the document-server for the correct edited document saving.

LDAP

  • Dramatically changed LDAP integration, migrated to the single library for the work with LDAP (Novell.Directory.Ldap.NETStandard, Nuget, MIT);
  • Login and email are now split into two separate fields;
  • Added the support for big data;
  • Increased the work speed via the LDAP protocol (the connection to the server and receiving the data is now made once per session, added the limits when only a certain number of results is necessary, fixed the slow login for bit data, removed the sorting out used to find the SID parameter);
  • Fixed the user re-creation issue;
  • Fixed the duplicate username issue;
  • Fixed the already existing email issue;
  • Replaced the LDAP user deletion with account deactivation (for further data migration and data safety);
  • Instead of re-creating a user with an unknown SID but an existing email the data is updated;
  • Added the attempt to save the correct UserName/Login in case a similar one is already taken on the portal.

Single Sign-on

  • Added the AD FS support;
  • Replaced the Single Sign-on link at the authorization page with the customizable button, added the button customization to the SSO setting of the Control Panel.

Version 2.1.0

Release date: 07/03/2017

HTTPS

  • Added the support of letsencrypt service for the domain certificate generation.

Single Sign-on

  • Added the new sso.auth service;
  • Added the new SSO settings page;
  • Added the support for Shibboleth.

Version 2.0.0

Release date: 05/25/2017

General

  • The Control Panel migrated from MVC to Node.js.

Version 1.6.0

Release date: 12/05/2016

LDAP

  • Added LDAP synchronization for users and groups when saving the settings, after login and using the Sync button;
  • Changed email formation for LDAP users;
  • Fixed the problem of creation of users with invalid emails;
  • Fixed the problem of duplicate users;
  • Added icons and hints to the users in the list for the admin;
  • Blocked for editing the user profile fields imported using LDAP;
  • Added the real LDAP password saving to the database during login in case LDAP Auth is disabled, now the LDAP users will become common portal users when LDAP Auth is disabled;
  • Added new API Settings method - Sync LDAP;
  • Added new translations;
  • Bug fixes.

Version for Windows

  • Made changes at the Update page for the Control Panel for Windows;
  • Updates are performed using the downloaded installation packages for each module.
  • The current installed component version numbers are obtained via API request to the Community Server.
  • The new versions available for download are obtained via the request to the https://download.onlyoffice.com/install/windows/updates.txt file, where all the latest component version numbers and links for their download are stored in the JSON format.

Introduction

The Backup/Restore features provided by the Control Panel allow you to backup your portal data and restore it in the ONLYOFFICE Workspace Community Edition. 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.

  1. 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.
      Temporary tab Temporary tab
      Temporary tab Temporary tab
    • 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.
      Documents module tab Documents module tab
      Documents module tab Documents module tab
    • 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 make shared and put into the Common Documents section. Otherwise the corresponding storages will be disabled and grayed out.
      Third-Party Storages tab Third-Party Storages tab
      Third-Party Storages tab Third-Party Storages tab

      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 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, aes256, awskms. Leave this field empty to use the default aes256 value.
      • 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.
      Computer file tab Computer file tab
      Computer file tab Computer file tab
    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.
  2. 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.
    The license data will not be included into the backup. After restoring data from the backup, you will need to upload your license file again.
  3. 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.

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:

Creating Backup automatically Creating Backup automatically
  1. click the Disabled switcher to enable the feature.
  2. 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).
  3. 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.
  4. set The maximal number of backup copies to be stored selecting the necessary value (from 1 to 30) from the corresponding drop-down list.
  5. check the Include Mail in backup box if you want to backup the Mail data as well.
  6. click the SAVE button.

Backups will be created automatically with the specified periodicity.

Data restore

Due to the new mechanism of the password encryption, there is no the 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 and TeamlabSvc.exe.Config files before restoring the backup on a new server.

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.

Restoring Backup Restoring Backup
Restoring Backup Restoring Backup
  1. 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 Remove Icon icon.
  2. if necessary, leave the Send notification about portal restore process to users box checked to notify your portal users;
  3. 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.
Download Host on your own server Available for
Docker, Windows and Linux
You Might Also Like This:
Close