Introduction

Now you can easily launch the ONLYOFFICE Integration Edition instance in the Amazon Web Services cloud infrastructure using the ONLYOFFICE Amazon Machine Image available on the AWS Marketplace.

The Amazon Machine Image (AMI) is a pre-configured template that allows to easily launch an instance, which is a virtual server in the AWS private cloud.

The ONLYOFFICE Integration Edition AMI includes all the necessary components - both the operating system and the software itself, as well as a storage volume - to deploy your web office on a virtual server running under Linux (CentOS).

Once your ONLYOFFICE Integration Edition instance is launched, you can integrate ONLYOFFICE Document Server with one of the file sync and share platforms, such as Alfresco, Confluence, Liferay, Nextcloud, ownCloud, SharePoint, HumHub etc.

Step 1. Choose the necessary ONLYOFFICE AMI and subscribe for the solution

Find the ONLYOFFICE solution and choose the necessary instance type – for 50, 100, 200 or 400 connections. Connections mean the maximum number of documents that can be edited at the same time. When the maximum value is reached, each next document will open in read-only mode.

At the Product Overview page, you can read the description of the software functions.

Switch to the Pricing tab to estimate pricing details that depend on some instance parameters:

Change the Region where the instance will be launched, if necessary. It’s recommended to select a region with a closest location. US East (N. Virginia) is selected by default.

In the Fulfillment option menu, the 64-bit (x86) Amazon Machine Image (AMI) option is only available.

In the Software Pricing Details section, choose the Hourly or Annual subscription type.

The total price includes charges for the ONLYOFFICE software and for the AWS infrastructure services used to deploy this software solution.

Note: to learn more about subscribing to paid AMIs and other pricing details, please refer to the AWS documentation.

If you click on the EC2 Instance type displayed in the table (e.g., t3.large), you can see the instance details. The EC2 instance type determines the hardware of the virtual server used to deploy the ONLYOFFICE solution.

Available instance types differ depending on the selected variant of the ONLYOFFICE Integration Edition solution, i.e. on the number of allowed connections.

The t3.small EC2 Instance type is used for ONLYOFFICE Integration Edition (50 connections). It has the following parameters:

Memory: 2 GB

CPU: 2 virtual cores

Storage: EBS Only

Network: Up to 5 Gigabit Ethernet

The t3.medium EC2 Instance type is used for ONLYOFFICE Integration Edition (100 connections). It has the following parameters:

Memory: 4 GB

CPU: 2 virtual cores

Storage: EBS Only

Network: Up to 5 Gigabit Ethernet

The t3.xlarge EC2 Instance type is used for ONLYOFFICE Integration Edition (200 connections). It has the following parameters:

Memory: 16 GB

CPU: 4 virtual cores

Storage: EBS Only

Network: Up to 5 Gigabit Ethernet

The t3.2xlarge EC2 Instance type is used for ONLYOFFICE Integration Edition (400 connections). It has the following parameters:

Memory: 32 GB

CPU: 8 virtual cores

Storage: EBS Only

Network: Up to 5 Gigabit Ethernet

Switch to the Usage tab where you can find the following information:

The Fulfillment Options section displays the AMI characteristics. The ONLYOFFICE AMI has the 64-bit (x86) architecture.

The Template components section displays the AWS services which are used for this product.

The EC2 service provides the environment necessary to deploy a virtual server running under CentOS and install the ONLYOFFICE software solution on it.

Usage Instructions contain brief recommendations on how to perform initial ONLYOFFICE configuration after launching the instance.

End User License Agreement regulates the terms and conditions upon which the ONLYOFFICE Integration Edition solution is provided.

Click the Continue to Subscribe button in the upper right corner. The Subscribe to this software page opens:

Read the AWS Customer Agreement and click the Accept Terms button. Wait while the subscription is being processed.

When the current date is displayed in the Effective date field instead of 'Pending', click the Continue to Configuration button in the upper right corner.

Step 2. Launch your ONLYOFFICE instance in the AWS cloud

At the Configure this software page, click the Continue to Launch button in the upper right corner.

The Launch this software page opens. At this page, you can review the Configuration Details once again.

The Choose Action section allows to select the method you want to use to launch the instance. The Launch from Website option is selected by default. Leave it unchanged to deploy the instance using the Launch Instance Wizard provided at this web page.

Note: you can also launch your instance through the Amazon EC2 console. To do that, select the Launch through EC2 option from the menu and click the Launch button. You will be redirected to the Launch Instance Wizard in your AWS Management Console where you can select an instance type, configure the instance details, add a storage, tags and configure a security group. This guide does not describe such a method of launching the instance.

In the EC2 Instance Type section, the only option is available (it depends on the previously selected ONLYOFFICE Integration Edition instance type with a certain number of allowed connections).

Create a new security group

A security group allows to limit access to your instance so that only known IP addresses can access it.

In the Security Group Settings section, click the Create New Based on Seller Settings button.

Enter the name of the security group (for example, ONLYOFFICE) and add its description.

Use the Source (IP or Group) list, to set the necessary rules. You can specify a single IP address, or an IP address range, e.g. 10.040.196.230/32.

The rules are specified for the following ports:

SSH - port 22 is used to access your server using an SSH client over the SSH protocol.

HTTP - port 80 is used to access your web office via a web browser over the HTTP protocol.

HTTPS - port 443 is used to access your web office via a web browser over the secure HTTPS protocol.

When ready, click the Save button.

Generate a key pair

A key pair is required to securely connect to your instance via the SSH protocol using an SSH client like PuTTY or OpenSSH.

In the Key Pair Settings section, click the Create a key pair in EC2 link.

The AWS Management Console will open in a new browser tab.

verify that the AWS Region displayed at the top toolbar is the same that the one where you want to launch the instance.

Click the Create key pair button in the upper right corner. Enter the key pair name (e.g. ONLYOFFICE) in the corresponding field and select the file format depending on which software you want to use to connect to your instance remotely:

pem is used for OpenSSH

ppk is used for PuTTY

Click the Create key pair button below.

Your public key will be stored in the AWS EC2. The .pem/.ppk file that contains your private key will be downloaded to your local machine and stored in the default Downloads folder. Please copy it and store in a safe place.

Return to the AWS Marketplace, refresh the key pair field using the icon to the right of it and select the created key pair from the list.

After that, the Launch button becomes unlocked. Click the Launch button and wait while the instance is being deployed. When ready, the message about the successful deployment appears.

Click the EC2 Console link in this message to open the instance details in the AWS Management Console.

It can take some time for the instance to become completely functional after you launched it. Make sure that the instance status has changed from 'pending' to 'running' in the Instance State column and verify that the instance has passed all status checks. This information is displayed in the Status Checks column.

Then you can connect to your instance via SSH to enable test examples and check the solution functionality via a web browser.

Step 3. Connect to your server via SSH

Once the instance is running, you can access it via SSH using the username centos and your SSH private key.

To connect to your virtual server via SSH you’ll also need to use the Public DNS or IP address of the instance.

They can be found in the AWS Management Console. Switch to the Instances section in the left menu, choose your region (US East (N. Virginia) by default) and select your ONLYOFFICE instance in the list to open the instance details.

If you move the mouse cursor over the Public DNS (IPv4) or IPv4 Public IP at the Description tab, the Copy to clipboard option appears. Click it to copy the necessary value.

On Windows, you can use the PuTTY utility.

The AWS private key file generated while deploying the instance is used for authentication instead of a password.

Launch PuTTY. On the left-side navigation panel, open the Connection -> SSH -> Auth section. Go to the Authentication parameters -> Private key file for authentication section, click the Browse button and find the path to the .ppk file stored on your local machine.

Return to the Session section in the left-side navigation panel. Enter the instance Public DNS or IP address into the Host Name or IP address field, make sure that port 22 is specified and the SSH connection type is selected and click the Open button.

Then click Yes in the PuTTY Security Alert window. Type in the username centos and press Enter.

On Linux, you can use an SSH client like OpenSSH.

You’ll need to specify a path to the .pem file with your private key stored on your local machine, the centos username and your instance IP address or Public DNS.

Enter the following command in your terminal specifying the actual values for the .pem file path and the IP Address:

ssh -i /path/onlyoffice.pem centos@your_instance_ip

Type yes to continue connecting to the server. For more information, you can refer to the AWS documentation.

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:

Step 4. Access your Integration Edition via a web browser

Once the example is started, enter http://<public IP address>/example/ into a web browser address bar replacing <public IP address> with the public IP address or public DNS provided by Amazon.

The Integration Edition example page opens. Here you can:

Upload a file stored on your PC using the Upload File option.

Create a new blank text document, spreadsheet or presentation using the Create Document, Create Spreadsheet, or Create Presentation options. If you want to create a file with a sample content, first check the Create a file filled with sample content box.

The uploaded or created file will open in a new browser tab with the corresponding ONLYOFFICE Online Editor so that you can test editing capabilities.

The file will also appear in the Your documents list at the Integration Edition example page.

If you want to check co-editing capabilities, select another test user from the Username list and then click on the same document in the Your documents list to open it in a new browser tab.

To easily integrate ONLYOFFICE Document Server with one of the business platforms like Alfresco, Confluence, Liferay, Nextcloud, ownCloud, SharePoint, HumHub etc., you can use integration connectors for these solutions as it is described here: https://api.onlyoffice.com/editors/plugins Use the public IP address or public DNS to specify the Document Server address in your web application settings, e.g. http://<public IP address>/