helpcenter/Web/Controls/Help/TipsTricks/General/Data-Backup-Restore/Data-Backup-Restore.ascx

162 lines
16 KiB
Plaintext
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<%@ Control Language="C#" Inherits="BaseContentUserControls"%>
<%@ Register Namespace="TeamLab.Controls" Assembly="__Code" TagPrefix="cc" %>
<script runat="server">
protected override void Init()
{
PageTitle = PageCaption = "Data backup and restore in the cloud version";
MetaKeyWords = "perform backup, data backup, cloud version, restore backup";
MetaDescription = "ONLYOFFICE. Create a backup of your portal data any time on your local server";
}
</script>
<div class="main_buscall_container dataBackup">
<div class="MainHelpCenter">
<h1 class="subHeaderFeaturesCaption">Data backup and restore in the cloud version</h1>
<cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/VariousControls/AdminLabel/AdminLabel.ascx" />
<div class="keyword_block">
<ul>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Tags/backup-saas-data/backup-saas-data.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Tags/data-backup/data-backup.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Tags/restore-backup/restore-backup.ascx" /></li>
</ul>
</div>
<p>Need to backup your portal data to be able to restore it later in the cloud version? This procedure is very simple.</p>
<h2 id="BareBonesInstructions">Bare Bones Instructions</h2>
<p>Follow these simple steps to create a backup of your portal:</p>
<ol class="instructions">
<li>Enter your portal.</li>
<li>Click the <img alt="Settings Icon" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/tipstricks/settingsicon.png")%>" /> icon in the right upper corner to open the 'Settings' section.</li>
<li>Switch to the <b>Data Management</b> tab at the left-side panel, then go to the <b>Backup<%--/Restore--%></b> subsection.
<h5 id="manual">Manual backup</h5>
<p>If you want to backup the portal data manually:</p>
<div class="screen_block">
<img alt="Data Backup" target="img1_eventcom_guides" class="screenphoto screen_guides" src="<%=VirtualPathUtility.ToAbsolute("~/images/Help/Guides/small/guide148/databackup.png")%>" />
<img alt="Data Backup" id="img1_eventcom_guides" class="bigphoto_screen" src="<%=VirtualPathUtility.ToAbsolute("~/images/Help/Guides/big/guide148/databackup.png")%>" />
<div target="img1_eventcom_guides" class="screenphoto magnifier"></div>
</div>
<ol>
<li>Choose the storage for your backup checking one of the corresponding options:
<p><i>Temporary.</i>
Choose the <i>Temporary</i> option if you want to download the created backup to your local drive. The link to the created backup is available only for 24 hours.</p>
<p><i>ONLYOFFICE documents.</i>
Click the <b>Choose</b> button next to the empty field under the options list, select a folder in the <b>Common Documents</b> section and click the <b>OK</b> button.</p>
<p><i>DropBox, Box, OneDrive, Google Drive...</i>
Click the <b>Choose</b> button next to the empty field under the options list, select a folder that corresponds to the integrated third-party service and click the <b>OK</b> button.</p>
<p><i>Third-Party Storage</i>.
Choose one of the available services previously connected in the <b>Integration</b> section and enter the necessary data to access the selected third-party storage in the fields below.</p>
<ul>
<li>For the <b>Amazon AWS S3</b> service, the following fields are available:
<ul>
<li><b>Bucket</b> - unique Amazon bucket name, e.g. <em>my-new-test-bucket-12345</em>.</li>
<li><b>Region</b> - an AWS region where your Amazon bucket resides, e.g. <em>us-east-2</em>.</li>
<li><b>Service Url</b> - 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.</li>
<li><b>Force Path Style</b> - when <em>true</em>, requests will always use path style addressing. Leave this field empty, as the <b>Service Url</b> property is not specified.</li>
<li><b>Use Http</b> - if this property is set to <em>true</em>, the client attempts to use HTTP protocol, if the target endpoint supports it. By default, this property is set to <em>false</em>. Set it to <em>true</em> or leave this field empty to use the default value.</li>
<li><b>Server Side Encryption Method</b> - the server-side encryption algorithm used when storing this object in S3. The possible values are <em>none</em>, <em>aes256</em>, <em>awskms</em>. Leave this field empty to use the default <em>aes256</em> value.</li>
</ul>
</li>
<li>For the <em>Google Cloud Storage</em> service, fill in the <b>Bucket</b> field.</li>
<li>For the <em>Rackspace Cloud Storage</em> service, fill in the <b>Public container</b>, <b>Private container</b> and <b>Region</b> fields.</li>
<li>For the <em>Selectel Cloud Storage</em> service, fill in the <b>Private container</b> and <b>Public container</b> fields.</li>
</ul>
</li>
<li>Check the <b>Include Mail in backup</b> box if it's necessary.</li>
<li>Click the <b>Make copy</b> button.</li>
</ol>
<p>The backup will be saved in the selected folder.</p>
<h5 id="auto">Automatic backup</h5>
<div class="notehelp">
The <b>Automatic backup</b> function is only available if your pricing plan includes it.
</div>
<p>If you want to use the <b>Automatic backup</b> function:</p>
<div class="screen_block">
<img alt="Automatic backup" target="img2_eventcom_guides" class="screenphoto screen_guides" src="<%=VirtualPathUtility.ToAbsolute("~/images/Help/Guides/small/guide148/automaticbackup.png")%>" />
<img alt="Automatic backup" id="img2_eventcom_guides" class="bigphoto_screen" src="<%=VirtualPathUtility.ToAbsolute("~/images/Help/Guides/big/guide148/automaticbackup.png")%>" />
<div target="img2_eventcom_guides" class="screenphoto magnifier"></div>
</div>
<ol>
<li>Check the <b>Enable</b> option button.</li>
<li>Choose the storage for your backup checking one of the corresponding options:
<p><i>ONLYOFFICE documents.</i>
Click the <b>Choose</b> button next to the empty field under the options list, select a folder in the <b>Common Documents</b> section and click the <b>OK</b> button.</p>
<p><i>DropBox, Box, OneDrive, Google Drive...</i>
Click the <b>Choose</b> button next to the empty field under the options list, select a folder that corresponds to the integrated third-party service and click the <b>OK</b> button.</p>
<p><i>Third-Party Storage</i>.
Сhoose one of the available services previously connected in the <b>Integration</b> section and enter the necessary data to access the selected third-party storage in the fields below.</p>
<ul>
<li>For the <b>Amazon AWS S3</b> service, the following fields are available:
<ul>
<li><b>Bucket</b> - unique Amazon bucket name, e.g. <em>my-new-test-bucket-12345</em>.</li>
<li><b>Region</b> - an AWS region where your Amazon bucket resides, e.g. <em>us-east-2</em>.</li>
<li><b>Service Url</b> - 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.</li>
<li><b>Force Path Style</b> - when <em>true</em>, requests will always use path style addressing. Leave this field empty, as the <b>Service Url</b> property is not specified.</li>
<li><b>Use Http</b> - if this property is set to <em>true</em>, the client attempts to use HTTP protocol, if the target endpoint supports it. By default, this property is set to <em>false</em>. Set it to <em>true</em> or leave this field empty to use the default value.</li>
<li><b>Server Side Encryption Method</b> - the server-side encryption algorithm used when storing this object in S3. The possible values are <em>none</em>, <em>aes256</em>, <em>awskms</em>. Leave this field empty to use the default <em>aes256</em> value.</li>
</ul>
</li>
<li>For the <em>Google Cloud Storage</em> service, fill in the <b>bucket</b> field.</li>
<li>For the <em>Rackspace Cloud Storage</em> service, fill in the <b>public_container</b>, <b>private_container</b> and <b>region</b> fields.</li>
<li>For the <em>Selectel Cloud Storage</em> service, fill in the <b>private_container</b> and <b>public_container</b> fields.</li>
</ul>
</li>
<li>Check the <b>Include Mail in backup</b> box if it's necessary.</li>
<li>Specify the frequency of the backup creation, clicking the down arrow in the <b>Every day</b> field and choosing the option which suites you the best.</li>
<li>Set the time and/or choose the day of the week/month.</li>
<li>Choose the number of the backup copies to be stored (from 1 to 30) in the corresponding field.</li>
<li>Click the <b>Save</b> button.
<p>The backup will be created in the selected folder on a specified day.</p>
</li>
</ol>
</li>
</ol>
<h5 id="restore">Data restore</h5>
<p>The <b>Restore</b> function allows you to restore your portal data in the ONLYOFFICE Workspace Cloud.</p>
<div class="notehelp">
The <b>Restore</b> function is only available if your pricing plan includes restoring from a backup.
</div>
<p>To restore your portal data from the previously created backup file that has been hashed (for ONLYOFFICE Workspace Cloud 11.5 or later) in the ONLYOFFICE Workspace Cloud, access the <b>Settings</b> from any portal page by clicking the <img alt="Settings Icon" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/tipstricks/settingsicon.png")%>" /> icon at the top of the page or use the drop-down list in the top left corner and select the corresponding option.</p>
<p>Switch to the <b>Data Management</b> tab at the left-side panel, then go to the <b>Backup</b> subsection and scroll for <b>Data Restore</b>.</p>
<div class="screen_block">
<img alt="Data Restore" target="img3_eventcom_guides" class="screenphoto screen_guides" src="<%=VirtualPathUtility.ToAbsolute("~/images/Help/Guides/small/guide148/datarestore.png")%>" />
<img alt="Data Restore" id="img3_eventcom_guides" class="bigphoto_screen" src="<%=VirtualPathUtility.ToAbsolute("~/images/Help/Guides/big/guide148/datarestore.png")%>" />
<div target="img3_eventcom_guides" class="screenphoto magnifier"></div>
</div>
<ol class="instructions">
<li>Select the <b>Source</b> where the backup is stored.
<ul>
<li>select the <b>ONLYOFFICE Documents</b> option and click the <b>Choose</b> button below. In the <b>Select file</b> window, choose the necessary backup file stored in the <b>Common</b> folder and click OK.</li>
<li>select the <b>DropBox</b>, <b>Box.com</b>, <b>OneDrive</b>, <b>Google Drive</b> option (third-party services connected to the <b>Documents</b> module, including services connected via the WebDAV protocol) and click the <b>Choose</b> button below. In the <b>Select file</b> window, choose the necessary backup file stored in the third-party resource directory and click <b>OK</b>.</li>
<li>select the <b>Third-Party Storage</b> option, choose the necessary third-party storage previously connected in the <b>Integration</b> section and enter the data required to to access the chosen storage.</li>
<li>select the <b>Computer file</b> option, click the <b>Choose</b> button below, and browse for the necessary backup file stored on your local drive.
<div class="notehelp">
Instead of selecting a backup file from a certain <b>Source</b>, you can just click the <b>Show the backup list</b> link below the Choose field 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 <b>Restore</b> link next to the necessary backup file. To delete a backup file from the list, click the <img alt="Delete Icon" src="<%=VirtualPathUtility.ToAbsolute("~/images/Help/Guides/big/guide148/deleteicon.png")%>" /> icon.
</div>
</li>
</ul>
</li>
<li>Leave the <b>Send notification about portal restoring to users</b> box checked to notify your portal users;</li>
<li>Click the <b>Restore</b> button.</li>
</ol>
<p>After restoring the backup in the cloud version, current passwords will be reset and users will need to restore their access via the emails specified in their profiles by specifying the password which will be used for signing in. <%--Users will receive notifications to the emails specified in their profiles and will be able to use the <b>Set password</b> button in this message to specify the password which will be used for signing in.--%></p>
<div class="notehelp">If you created a backup file in the cloud version and then restore it in the <a href="<%=VirtualPathUtility.ToAbsolute("~/administration/control-panel-backup.aspx#step3")%>">server version</a>, access can only be restored via the <b>Forgot your password?</b> link on the authorization page.</div>
<h2 id="HelpfulHints">Helpful Hints</h2>
<h3>Can any administrator create a backup of portal data?</h3>
<p>The portal owner and full access administrators only can back up the portal data.</p>
<%--<h3>In what ONLYOFFICE version is this feature available?</h3>
<p>The backup feature is available in ONLYOFFICE SaaS version only. But you can always create a backup of the portal data stored on your local server manually.</p>--%>
<%--<h3>How to transfer my portal data to an AMI instance?</h3>
<p>Using the backup procedure described above you can switch to the ONLYOFFICE <a href="<%=VirtualPathUtility.ToAbsolute("~/ami.aspx")%>">AMI version</a>. The transition process is extremely smooth and loss-free.
You just need to restore the backup of your portal data on an AMI instance. The detailed instructions you can find in our <a href="<%=VirtualPathUtility.ToAbsolute("~/content/TeamlabAMIUserGuide.pdf")%>">PDF guide</a>.</p>--%>
</div>
</div>