helpcenter/Web/Controls/Help/Server/Alibaba/DocsDEAlibaba/DocsDEAlibaba.ascx

206 lines
19 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 = "Deploying ONLYOFFICE Docs Developer Edition on Alibaba Cloud";
MetaKeyWords = "ONLYOFFICE Docs, on Alibaba Cloud";
MetaDescription = "Launch the ONLYOFFICE Docs instance on Alibaba Cloud.";
var guides = new GuidesModel();
guides.TitleVideo = "Deploying ONLYOFFICE Docs Developer Edition on Alibaba Cloud";
(Page as BasePage).Guides = guides;
}
</script>
<div class="MainHelpCenter">
<h1 class="subHeaderFeaturesCaption Guides_Video_Captions">Deploying ONLYOFFICE Docs Developer Edition on Alibaba Cloud</h1>
<cc:localizecontent runat="Server" controlname="~/Controls/Help/VariousControls/Versions/DocumentServer/DocumentServer_Current.ascx" />
<div class="keyword_block">
<ul>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Tags/install-ONLYOFFICE/install-ONLYOFFICE.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Tags/document-server/document-server.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Tags/docker-version/docker-version.ascx" /></li>
</ul>
</div>
<div class="video_ground video_trips">
<h2 id="introduction">Introduction</h2>
<div class="video_ground video_trips">
<div class="video_text">
<p>Now you can easily launch the <b>ONLYOFFICE Docs Developer Edition</b> instance on <b>Alibaba Cloud</b> using the <b>ONLYOFFICE Alibaba Cloud Image</b> available on the <b>Alibaba Cloud Marketplace</b>.</p>
<p><b>The Alibaba Cloud Image</b> is a pre-configured template that allows to easily launch an instance on a virtual cloud server.</p>
<p>The <b>ONLYOFFICE Docs Developer Edition Alibaba Cloud Image</b> includes all the necessary components - both the operating system and the software itself - to deploy your web office on a virtual server running under Linux.</p>
<p>Once your <b>ONLYOFFICE Docs Developer Edition</b> instance is launched, you can integrate <b>ONLYOFFICE Docs</b> with your own SaaS or on-premises solution. The license also allows you to provide <b>Online Editors</b> to end users as a part of your solution under your brand.</p>
</div>
</div>
</div>
<h2 id="step1"><span class="style_step">Step 1. </span> Choose the necessary ONLYOFFICE Alibaba Cloud Image and subscribe for the solution</h2>
<div class="block_of_step">
<div class="screen_text">
<p>Log in to your existing <a target="_blank" class="links" href="https://eu.alibabacloud.com/">Alibaba Cloud account</a> or sign up for a new one and go to the <a target="_blank" class="links" href="https://marketplace.alibabacloud.com/">Alibaba Cloud Marketplace</a>.</p>
<p>Find the <a target="_blank" class="links" href="https://marketplace.alibabacloud.com/products?keywords=ONLYOFFICE+Docs+Developer+Edition&pageIndex=1">ONLYOFFICE Docs Developer Edition solution</a> and choose the necessary instance type for 250, 500 or 1000 connections. Connections mean the number of browser tabs with documents that can be opened for editing at the same time. Note that one document opened by two users means two simultaneous connections as it is opened in two tabs. When the maximum value is reached, each next document will open in read-only mode.</p>
<div class="screen_block">
<img alt="Choose the necessary ONLYOFFICE Alibaba Cloud Image" target="img1_eventcom_guides" class="screenphoto screen_guides" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/Guides/small/guide210/step1.png")%>" />
<img alt="Choose the necessary ONLYOFFICE Alibaba Cloud Image" id="img1_eventcom_guides" class="bigphoto_screen" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/Guides/big/guide210/step1.png")%>" />
<div target="img1_eventcom_guides" class="screenphoto magnifier"></div>
</div>
<p>At the <b>Product Details</b> page, you can read the description of the software functions, view the available image versions, the image ID corresponding to each region, estimate pricing details depending on the necessary region and subscription type ('Subscription' and 'Pay-As-You-Go'), read the End User License Agreement.</p>
<div class="notehelp">The Pricing page displays software price only. Final pricing will be calculated on the ECS confirmation page. The total price includes charges for the ONLYOFFICE software and for the Alibaba Cloud ECS services used to deploy this software solution.
To learn more about subscribing to paid Cloud Images and other pricing details, please refer to the <a target="_blank" class="links" href="https://www.alibabacloud.com/help/en/doc-detail/25398.htm"><b>Alibaba Cloud documentation</b></a>.
</div>
<div class="screen_block">
<img alt="Choose the necessary ONLYOFFICE Alibaba Cloud Image" target="img2_eventcom_guides" class="screenphoto screen_guides" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/Guides/small/guide210/step2.png")%>" />
<img alt="Choose the necessary ONLYOFFICE Alibaba Cloud Image" id="img2_eventcom_guides" class="bigphoto_screen" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/Guides/big/guide210/step2.png")%>" />
<div target="img2_eventcom_guides" class="screenphoto magnifier"></div>
</div>
<p>Click the <b>Choose Your Plan</b> button. The <b>Custom Launch</b> tab of the <a target="_blank" class="links" href="https://ecs.console.aliyun.com/#/home"><b>Alibaba Cloud ECS (Elastic Compute Service) console</b></a> will open.</p>
</div>
</div>
<h2 id="step2"><span class="style_step">Step 2. </span> Launch your ONLYOFFICE instance on Alibaba Cloud</h2>
<div class="block_of_step">
<div class="screen_text">
<p>On the <b>Custom Launch</b> tab, follow the configuration wizard steps.</p>
<p>In the <b>1 - Basic Configurations</b> section, you can change the following parameters:</p>
<ul>
<li><b>Billing Method</b> - select Subscription, Pay-As-You-Go, or Preemptible Instance.</li>
<li><b>Region</b> - select a region where the instance will be deployed. Its recommended to select a region with a closest location.</li>
<li><b>Instance Type</b> - you can choose the necessary instance type.</li>
<li><b>Image</b> - the ONLYOFFICE Docs Developer Edition Marketplace image is selected.</li>
<li><b>Storage</b> - you can specify the necessary system disc capacity or add a data disk.</li>
<li><b>Snapshot</b> - you can use automatic snapshot policies to periodically back up disks.</li>
</ul>
<p>Click the <b>Next</b> button in the lower right corner.</p>
<div class="screen_block">
<img alt="Launch your ONLYOFFICE instance" target="img5_eventcom_guides" class="screenphoto screen_guides" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/Guides/small/guide210/step5.png")%>" />
<img alt="Launch your ONLYOFFICE instance" id="img5_eventcom_guides" class="bigphoto_screen" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/Guides/big/guide210/step5.png")%>" />
<div target="img5_eventcom_guides" class="screenphoto magnifier"></div>
</div>
<p>In the <b>2 - Networking</b> section, you can change the following parameters:</p>
<ul>
<li><b>Network Type</b> - you can leave default settings.</li>
<li><b>Public IP Address</b> - an automatically allocated IP address is already enabled.</li>
<li><b>Network Billing Method</b> - choose Pay-By-Bandwidth or Pay-By-Traffic.</li>
<li><b>Security Group</b> - you can create a new security group if necessary. The default security group is already selected.</li>
<li><b>Elastic Network Interface</b> - you can leave default settings.</li>
<li><b>IPv6</b> - you can leave default settings.</li>
</ul>
<p>Click the <b>Next</b> button in the lower right corner.</p>
<div class="screen_block">
<img alt="Launch your ONLYOFFICE instance" target="img6_eventcom_guides" class="screenphoto screen_guides" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/Guides/small/guide210/step6.png")%>" />
<img alt="Launch your ONLYOFFICE instance" id="img6_eventcom_guides" class="bigphoto_screen" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/Guides/big/guide210/step6.png")%>" />
<div target="img6_eventcom_guides" class="screenphoto magnifier"></div>
</div>
<p>In the <b>3 - System Configurations (Optional)</b> section, you can change the following parameters:</p>
<ul>
<li><b>Logon Credentials</b> - you can set a password or create a new key pair to connect to your instance remotely using SSH. The Logon Username is root.
<p>To create a new key pair, </p>
<ol>
<li>Click the <b>Create Key Pair</b> link. The <b>Elastic Compute Service Console</b> will open in a new browser tab.</li>
<li>Enter the key pair name (e.g. ONLYOFFICE) in the corresponding field and select the Auto-create or choose Import and paste your a Base64-encoded public key. Click the <b>Ok</b> button below.
<p>Your public key will be stored in the <b>Elastic Compute Service</b>. The <code>.pem</code> file that contains your private key will be downloaded to your local machine and stored in the default <b>Downloads</b> folder. Please copy it and store in a safe place.</p>
</li>
</ol>
<div class="screen_block">
<img alt="Launch your ONLYOFFICE instance" target="img7_eventcom_guides" class="screenphoto screen_guides" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/Guides/small/guide210/step7.png")%>" />
<img alt="Launch your ONLYOFFICE instance" id="img7_eventcom_guides" class="bigphoto_screen" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/Guides/big/guide210/step7.png")%>" />
<div target="img7_eventcom_guides" class="screenphoto magnifier"></div>
</div>
<p>Return to the <b>System Configurations</b> page, refresh the key pair field using the icon to the right of it and select the created key pair from the list. </p>
<div class="screen_block">
<img alt="Launch your ONLYOFFICE instance" target="img8_eventcom_guides" class="screenphoto screen_guides" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/Guides/small/guide210/step8.png")%>" />
<img alt="Launch your ONLYOFFICE instance" id="img8_eventcom_guides" class="bigphoto_screen" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/Guides/big/guide210/step8.png")%>" />
<div target="img8_eventcom_guides" class="screenphoto magnifier"></div>
</div>
</li>
<li>You can also customize the <b>Instance Name</b>, add a <b>Description</b>, or customize the <b>Host</b> name.</li>
</ul>
<p>Click the <b>Next</b> button in the lower right corner.</p>
<p>In the <b>4 - Grouping (Optional)</b> section, you can change the following parameters:</p>
<ul>
<li><b>Tags</b> - you can add some tags to the instance.</li>
<li><b>Resource Group</b> - you can assign the instance to a resource group for easier management.</li>
<li>You can also choose a <b>Deployment set</b>, <b>Dedicated Host</b>, or <b>Private Pool</b>.</li>
</ul>
<p>Click the <b>Next</b> button in the lower right corner.</p>
<div class="screen_block">
<img alt="Launch your ONLYOFFICE instance" target="img9_eventcom_guides" class="screenphoto screen_guides" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/Guides/small/guide210/step9.png")%>" />
<img alt="Launch your ONLYOFFICE instance" id="img9_eventcom_guides" class="bigphoto_screen" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/Guides/big/guide210/step9.png")%>" />
<div target="img9_eventcom_guides" class="screenphoto magnifier"></div>
</div>
<p>On the <b>Preview</b> page, view the configuration options, accept <b>Terms of Service</b> and click <b>Create Instance</b>.</p>
<div class="screen_block">
<img alt="Launch your ONLYOFFICE instance" target="img10_eventcom_guides" class="screenphoto screen_guides" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/Guides/small/guide210/step10.png")%>" />
<img alt="Launch your ONLYOFFICE instance" id="img10_eventcom_guides" class="bigphoto_screen" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/Guides/big/guide210/step10.png")%>" />
<div target="img10_eventcom_guides" class="screenphoto magnifier"></div>
</div>
<p>It can take some time for the instance to become completely functional after you launched it.</p>
<p>Then you can connect to your instance via SSH to enable test examples and check the solution functionality via a web browser.</p>
</div>
</div>
<h2 id="step3"><span class="style_step">Step 3. </span>Connect to your server via SSH</h2>
<div class="block_of_step">
<div class="screen_text">
<p>Once the instance is running, you can access it via SSH using the username <code>root</code> and your logon password or SSH private key.</p>
<p>To connect to your virtual server via SSH youll also need to use the <b>Public IP address</b> of the instance. It can be found in the <a target="_blank" class="links" href="https://ecs.console.aliyun.com/#/home"><b>Alibaba Cloud ECS console</b></a>. Open the <b>Instances</b> section of the left menu. Select the region where the instance is deployed on the top navigation bar. Find the IP address of your instance in the instance list. </p>
<p>On Windows, you can use the <b>PuTTY</b> utility.</p>
<ul>
<li>If a username and password are used for authentication,
<ol>
<li>Launch <b>PuTTY</b>. Open the <b>Session</b> section in the left-side navigation panel.</li>
<li>Enter the instance <b>Public IP address</b> into the <b>Host Name or IP address</b> field, make sure that port 22 is specified and the SSH connection type is selected and click the <b>Open</b> button.</li>
<li>Click <b>Yes</b> in the <b>PuTTY Security Alert</b> window.</li>
<li>Type in the username <code>root</code> and press <b>Enter</b>.</li>
<li>Type in the logon password of the instance and press <b>Enter</b>.</li>
</ol>
</li>
<li>If a private key is used for authentication, first you need to convert the private key file from .pem to .ppk. For more details, <a target="_blank" class="links" href="https://www.alibabacloud.com/help/en/doc-detail/51798.html?spm=a2c63.p38356.0.0.3b2459e7co8Hyu">read the detailed instruction</a>.
</li>
</ul>
<p>On Linux, you can use an SSH client like <b>OpenSSH</b>.</p>
<ul>
<li>If a password is used for authentication, youll need to specify the <code>root</code> username and your instance <code>IP address</code>.
<p>Enter the following command in your terminal specifying the actual value for the <b>IP Address</b>:</p>
<pre><code>ssh root@your_instance_ip</code></pre>
<p>Type in the logon password of the instance and press <b>Enter</b>. </p>
</li>
<li>If a private key is used for authentication, youll need to specify a path to the <code>.pem</code> file with your private key stored on your local machine, the <code>root</code> username and your instance <code>IP address</code>.
<p>Enter the following command in your terminal specifying the actual values for the <code>.pem</code> file path and the <b>IP Address</b>:</p>
<pre><code>ssh -i /path/onlyoffice.pem root@your_instance_ip</code></pre>
<p>Type <code>yes</code> to continue connecting to the server. </p>
</li>
</ul>
<p>To explore the solution functionality, enable our test example which will allow you to upload your local files for testing. To do that, execute the following command:</p>
<pre><code>sudo docker exec $(sudo docker ps -q) sudo supervisorctl start ds:example
</code></pre>
<p>Add the example to the autostart:</p>
<pre><code>sudo docker exec $(sudo docker ps -q) sudo sed 's,autostart=false,autostart=true,' -i /etc/supervisor/conf.d/ds-example.conf
</code></pre>
</div>
</div>
<h2 id="step4"><span class="style_step">Step 4. </span>Access your Docs Developer Edition via a web browser</h2>
<div class="block_of_step">
<div class="screen_text">
<p>Once the example is started, enter <code>http://&lt;public IP address&gt;/example/</code> into a web browser address bar replacing <code>&lt;public IP address&gt;</code> with the public IP address provided by Alibaba Cloud.</p>
<div class="screen_block">
<img alt="Access Docs Developer Edition via a web browser" target="img21_eventcom_guides" class="screenphoto screen_guides" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/Guides/small/guide120/de_example.png")%>" />
<img alt="Access Docs Developer Edition via a web browser" id="img21_eventcom_guides" class="bigphoto_screen" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/Guides/big/guide120/de_example.png")%>" />
<div target="img21_eventcom_guides" class="screenphoto magnifier"></div>
</div>
<p>The <b>ONLYOFFICE Docs Developer Edition</b> example page opens. Here you can:</p>
<ol>
<li>Upload a file stored on your PC using the <b>Upload file</b> option.</li>
<li>Create a new blank text document, spreadsheet, presentation, or form template using the <b>Create new</b> -> <b>Document</b>, <b>Spreadsheet</b>, <b>Presentation</b>, or <b>Form template</b> options. If you want to create a file with a sample content, first check the <b>With sample content</b> box.</li>
</ol>
<p>The uploaded or created file will open in a new browser tab with the corresponding <b>ONLYOFFICE Online Editor</b> so that you can test editing capabilities.</p>
<p>The file will also appear in the <b>Your documents</b> list at the <b>ONLYOFFICE Docs Developer Edition</b> example page.</p>
<p>If you want to check co-editing capabilities, select another test user from the <b>Username</b> list and then click on the same document in the <b>Your documents</b> list to open it in a new browser tab.</p>
<p>To integrate <b>ONLYOFFICE Docs</b> with your own web application, you can refer to the API Documentation <a target="_blank" class="links" href="https://api.onlyoffice.com/editors/basic">https://api.onlyoffice.com/editors/basic</a></p>
</div>
</div>
</div>