Connecting third-party storages

Introduction

By default, the portal data are stored on the local disk of the machine where ONLYOFFICE Workspace is installed. You can also connect third-party services and use them as storage for your portal data.

This can be done in the Storage section available in the Control Panel. 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.

You can connect one of the following third-party services and use it as a storage for static data:

1. Google Cloud Storage
2. Amazon AWS S3
3. Rackspace Cloud Storage
4. Selectel Cloud Storage

It’s also possible to use a third-party service as a CDN (Content Delivery Network), i.e., as a distributed network that allows to speed up loading your portal data for users.

You can connect one of the following third-party services and use it as a CDN:

1. Amazon AWS S3
2. Selectel Cloud Storage

Connect third-party services in the portal settings

First of all, the necessary service (Amazon AWS S3, Google Cloud Storage, Rackspace Cloud Storage, or Selectel Cloud Storage) must be connected in the Integration section of the portal settings. Otherwise, the corresponding storages will be disabled and grayed out in the Control Panel.

To learn more on how to do that, please refer to the Connecting third-party services section.

Once the necessary service is connected in the portal settings, you can connect it in the Control Panel and use the connected service as a storage or CDN.

Connect a third-party service as a Storage

To connect one of the third-party services as a storage, switch to the Storage page in the COMMON SETTINGS section on the left sidebar and use the Storage section.

If you have connected several storages in your portal settings, you can specify the data individually for each storage and store your portal data in the selected storage.

1. Select the necessary location of the Storage for your portal data:
   • the Disk Default option is selected by default. When the Disk Default option is selected, the CONNECT button is inactive.
   • select one of the available third-party storages. Once you select one of the third-party storages, the CONNECT button becomes active.
2. When the necessary service 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).
3. Click the CONNECT button to connect the selected storage and save your settings.

Once the storage is connected, the page will be reloaded and the data migration process will start. This may take some time. When the data migration process is over, the Storage page in the Control Panel will be loaded with the connected storage selected.

Connect a third-party service as a CDN

To connect one of the third-party services as a CDN, switch to the Storage page in the COMMON SETTINGS section on the left sidebar and use the CDN section.

1. Select the necessary location of the Storage for your portal data:
   • the Disk Default option is selected by default. When the Disk Default option is selected, the CONNECT button is inactive.
   • select one of the available third-party storages. Once you select one of the third-party storages, the CONNECT button becomes active.
2. When the necessary service 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.
     • Subdir - i.e., a name of a nested folder within the Amazon bucket, e.g., testfolder.
     • 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 Selectel Cloud Storage service, the following fields are available: Public container (Selectel public container name, e.g., test_container_public) and Subdir, i.e. a name of a nested folder within the Selectel container, e.g., testfolder.
3. Click the CONNECT button to connect the selected storage and save your settings.

Once the storage is connected, the page will be reloaded and the data migration process will start. This may take some time. When the data migration process is over, the Storage page in the Control Panel will be loaded with the connected storage selected.