ownCloud

About the ONLYOFFICE and ownCloud integration

ONLYOFFICE offers an official connector to integrate ONLYOFFICE Docs with ownCloud and edit office documents within the cloud storage. You can download the ONLYOFFICE connector from the ownCloud Marketplace or the ONLYOFFICE GitHub page.

To learn more about the ONLYOFFICE and ownCloud integration connector and how it works in detail, please visit our API documentation page.

Main features

Creating, editing, and viewing documents, spreadsheets, and presentations.
Sharing files with different permissions — viewing/editing, reviewing, filling forms and commenting with user mentions. It's also possible to restrict downloading (in all editors) and modifying filters (in spreadsheets). Sharing via public links is also available.
Co-editing documents in real-time: two co-editing modes (Fast and Strict), Track Changes, comments, and a built-in chat.
Co-editing between several federated ownCloud instances connected to one Document Server.
JWT support to secure your traffic so that no one, besides the users with proper rights, can have access to your documents.

Supported formats

For editing and viewing: DOCX, XLSX, PPTX, CSV, TXT, PDF form.
For viewing only: PDF, DJVU, XPS.
For editing via OOXML conversion: ODT, ODS, ODP, and RTF.
For converting to Office Open XML formats using the Convert with ONLYOFFICE option: DOC, DOCM, DOT, DOTX, EPUB, HTM, HTML, ODP, ODT, POT, POTM, POTX, PPS, PPSM, PPSX, PPT, PPTM, RTF, XLS, XLSM, XLT, XLTM, XLTX.
ODT, ODS, and ODP are also available for instant conversion. After you enable the corresponding option in the admin settings, ODF-formatted documents are immediately converted in the editor and opened after you click on it.

What's new in version 9.6.1

Added

Unknown author display name settings
Email notifications settings
DOCM, XLSM, PPTM support
IMPORTRANGE support

Changed

Changed the URL for requests to Conversion API
Reading JSON instead of XML from Conversion API

The full change log is available here.

Connecting ONLYOFFICE Docs to ownCloud

Requirements

ONLYOFFICE Document Server v7.0 (server or cloud version) or later
You need an instance of ONLYOFFICE Docs that is resolvable and connectable both from ownCloud and any end clients. ONLYOFFICE Docs must be able to POST to ownCloud directly.
Starting from version 4.3.0, ONLYOFFICE Docs and ownCloud can be installed either on different computers or on the same machine. In case you select the latter variant, you will need to set up a custom port for ONLYOFFICE Docs, as by default both ONLYOFFICE Docs and ownCloud work on port 80.
Please refer to the official documentation page to learn more about installing ONLYOFFICE Docs.
ownCloud v10.0.0 and later
ONLYOFFICE Connector v8.2.3 and later for ownCloud

Installing the ONLYOFFICE connector for ownCloud

The ownCloud administrator can install the integration app from the in-built application market. To do it, please follow these steps:

Click the upper-left hamburger menu.
Select Market.
Go to the Tools category.
Find ONLYOFFICE in the list of available applications.
Click the Install button.

Alternatively, the administrator can install the application manually:

Get the ownCloud ONLYOFFICE integration app. There are several ways to do that:
1. Download the latest signed version from the official ownCloud store.
2. Download the latest signed version from the application release page on GitHub. E.g.:
```
wget https://github.com/ONLYOFFICE/onlyoffice-owncloud/archive/refs/tags/vX.X.X.tar.gz
```
  Where vX.X.X is the necessary connector version.
  Unzip the archive, e.g.:
```
tar -xvzf vX.X.X.tar.gz
```
  Rename the folder to onlyoffice, e.g.
```
mv onlyoffice-owncloud-X.X.X onlyoffice
```

Clone the application source code and compile it yourself:

git clone https://github.com/ONLYOFFICE/onlyoffice-owncloud.git onlyoffice
cd onlyoffice
git submodule update --init --recursive

ownCloud does not work with unsigned applications showing an alert message, so you will need to use either option a or b to get the application for your production environment.

Move the onlyoffice folder to the ownCloud server apps/ directory (or some other directory used to connect applications):
```
cp -r /root/onlyoffice/ /var/www/owncloud/apps/
```
Go to the apps/ directory:
```
cd /var/www/owncloud/apps
```
Change the owner to update the application right from the ownCloud web interface:
```
chown -R www-data:www-data onlyoffice
```
In ownCloud, go to Settings > Admin > Apps, click Show disabled apps and click Enable for the ONLYOFFICE application.

Configuring the ONLYOFFICE connector for ownCloud

To configure the ONLYOFFICE application settings, please go to Settings > Admin > Additional.

In the Server settings section, specify the following options:

ONLYOFFICE Docs address - specify the URL address where the Document Editing Service is installed. This field mandatory. If you install ONLYOFFICE Docs on a custom port, you must specify the port, e.g.: http://127.0. 0.1:8081/
The address of ONLYOFFICE Docs must be accessible from ownCloud, as well as the address of ownCloud must be accessible from ONLYOFFICE Docs.
Disable certificate verification (insecure) - check this box to disable the certificate verification and allow ownCloud to establish connection with ONLYOFFICE Docs if you are using a self-signed certificate for your ONLYOFFICE Docs (otherwise, ownCloud will not validate a self-signed certificate and will not allow for connection to/from ONLYOFFICE Docs). This is an insecure solution, and we strongly recommend that you replace the certificate with the one issued by some CA.
Secret key - specify the secret used to sign the data.
Starting from ONLYOFFICE Docs v7.2, JWT is enabled by default and the secret key is generated automatically. You need to enable it on the ownCloud side as well: find your secret key in the ONLYOFFICE Docs configuration file, then specify the same secret key in the connector settings. For more details, see the Enabling JWT for the ONLYOFFICE and ownCloud integration section of this article.
The Advanced server settings section can be used if your network configuration does not allow for requests between the installed ownCloud and ONLYOFFICE Docs using the public addresses. In this case, specify addresses for internal requests in the corresponding fields:
- In the ONLYOFFICE Docs address for internal requests from the server field, specify the address that is used to access Document Editing Service from ownCloud.
- In the Server address for internal requests from ONLYOFFICE Docs field, specify the address that is used to access ownCloud from Document Editing Service.

Click the Save button. After saving the Server settings, the Common settings, Editor customization settings, and Common templates sections will appear.

In the Common settings section, you can specify the following options:

Restrict access to the editors to following groups - check this box and select user groups that will not be allowed to use the ONLYOFFICE editors in ownCloud.
Use ONLYOFFICE to generate a document preview - check this box for thumbnail generation via ONLYOFFICE. It will take up some disk space.
Open file in the same tab - check this box to open a file in the current browser tab. If this option is unchecked, a file will be opened in a new browser tab.
Keep metadata for each version once the document is edited function makes it possible to keep metadata and display changes for each document version in the version history. It will take up some disk space. You can use the Clear button to remove the metadata and free up disk space.
The default application for opening the format - allows you to check the formats to associate with the ONLYOFFICE editors. The docx, xlsx, and pptx formats are selected by default.
Opening in ONLYOFFICE editors will be performed only for the formats selected in this section.
Open the file for editing - allows administrators to choose the document formats to edit via conversion to OOXML formats. The csv and txt formats are selected by default.
ImportantDue to format restrictions, some data might be lost when saving to the formats from the list (csv, odp, ods, odt, rtf, txt).
After you enable the corresponding option, documents in the specified formats will be immediately converted and opened in the ONLYOFFICE editor for editing after clicking on them and choosing the Open in ONLYOFFICE menu item. If a format is unchecked, the file will be opened for viewing.

In the Editor customization settings section, you can specify the following options:

Keep intermediate versions when editing (forcesave) function allows you to send all changes to the storage directly when clicking the Save button in the ONLYOFFICE editors' interface if you want to prevent data loss. When this option is disabled, your changes are saved to the editors' cache automatically.
Select the interface elements of the editors that you want to hide / show (Chat, More compact header, Feedback & Support, Help, Monochrome toolbar header).
Review mode for viewing function allows you to set the default document review display mode:
- Markup - for highlighting the proposed changes,
- Final - for showing with changes applied,
- Original - for showing the original document without any changes.

After making changes to the Common settings and/or Editor customization settings, click the Save button located below to save the changes.

In the Common templates section, you can click the Add icon icon and upload docx, xlsx, or pptx templates for creating new documents.

You can download or delete a template from this list using the corresponding icons.

After adding templates in the admin settings, users will be able to choose a template when creating a new document using the Add icon add button in the ownCloud interface or via the File > Create new menu in the ONLYOFFICE editors' interface.

Checking the connection

You can check the connection to ONLYOFFICE Docs by using the following occ command:

occ onlyoffice:documentserver --check

You will see a text, either with information about the successful connection or the cause of the error.

How it works

The ONLYOFFICE integration follows the API documented here.

When creating a new file, the user navigates to a document folder within ownCloud and clicks the Document, Spreadsheet or Presentation item in the new (+) menu.
The browser invokes the create method in the /lib/Controller/EditorController.php controller. This method adds a copy of a file from the assets folder to the folder the user is currently in.
When opening an existing file, the user navigates to it within ownCloud and selects the Open in ONLYOFFICE menu option.
A new browser tab is opened and the index method of the /lib/Controller/EditorController.php controller is invoked.
The app prepares a JSON object with the following properties:
- url - the URL that ONLYOFFICE Docs uses to download the document;
- callbackUrl - the URL that ONLYOFFICE Docs uses to inform about status of the document editing;
- documentServerUrl - the URL that the client needs to respond to ONLYOFFICE Document Server (can be set at the administrative settings page);
- key - the UUID+Modified Timestamp to instruct ONLYOFFICE Docs whether to download the document again or not.
ownCloud takes this object and constructs a page from templates/editor.php template, populating all the necessary values to ensure the client browser successfully loads the editor.
The client browser makes a request to the JavaScript library from ONLYOFFICE Docs and sends ONLYOFFICE Docs the DocEditor configuration with the above properties.
Then ONLYOFFICE Docs downloads the document from ownCloud and the user begins editing.
ONLYOFFICE Docs sends a POST request to callbackUrl to inform ownCloud that a user is editing the document.
When all users and client browsers are done with editing, they close the editing window.
After 10 seconds of inactivity, ONLYOFFICE Docs sends a POST to callbackUrl letting ownCloud know that the clients have finished editing the document and closed it.
ownCloud downloads a new version of the document, replacing the old one.

Enabling JWT for the ONLYOFFICE and ownCloud integration

To protect documents from unauthorized access, ONLYOFFICE editors use the JSON Web Token (JWT). The token is added in the configuration when the Document Editor is initialized and during the exchange of commands between inner ONLYOFFICE Docs services. The secret key is used to sign the JSON web token and validate the token upon the request to ONLYOFFICE Docs.

Starting from ONLYOFFICE Docs v7.2, JWT is enabled by default and the secret key is generated automatically. You need to find your secret key in the ONLYOFFICE Docs configuration file, then specify the same secret key in the connector settings.

Step 1: Find your secret key in the ONLYOFFICE Docs configuration file

Open the local.json file with any available text editor.
- For Linux - /etc/onlyoffice/documentserver/local.json
- For Windows - %ProgramFiles%\ONLYOFFICE\DocumentServer\config\local.json
- For Docker – enter the ONLYOFFICE Docs container using the docker exec -it <containerID> bash command and open /etc/onlyoffice/documentserver/local.json
  Alternatively, you can use the following command to find the default secret key without opening local.json:
```
sudo docker exec <containerID> /var/www/onlyoffice/documentserver/npm/json -f /etc/onlyoffice/documentserver/local.json 'services.CoAuthoring.secret.session.string'
```
The local.json file should look like this:
```
{"services": {"CoAuthoring": {"token": {"enable": {"request": {"inbox": true,"outbox": true},"browser": true}},"secret": {"inbox": {"string": "yoursecret"},"outbox": {"string": "yoursecret"},"session": {"string": "yoursecret"}}}}}
```
The true value is specified in three sections. It means that token validation is enabled.
- services.CoAuthoring.token.enable.browser
- services.CoAuthoring.token.enable.request.inbox
- services.CoAuthoring.token.enable.request.outbox
The automatically generated secret key is specified in three sections. You can replace the default secret value with your own secret key. The secret key must be the same in three sections.
- services.CoAuthoring.secret.inbox.string
- services.CoAuthoring.secret.outbox.string
- services.CoAuthoring.secret.session.string
If you make changes, save them and restart the services for the config changes to take effect.
```
supervisorctl restart all
```

Step 2: Specify the same secret key in the connector settings

In the connector settings, specify the same secret in the Secret key field and save the settings.

Connecting to the demo ONLYOFFICE Docs

Starting from ONLYOFFICE connector version 3.0.1, you can try the ONLYOFFICE online editors within ownCloud without installing ONLYOFFICE Docs.

To turn the connection on, click the Connect to demo ONLYOFFICE Docs server checkbox and click the Save button.

Important This is a public test server that will be available during a 30-day period. Don’t share your sensitive data there.

Installing ONLYOFFICE Docs with ownCloud using Docker Compose

Using Docker Compose, you can quickly and easily deploy the preconfigured version of ONLYOFFICE Docs connected to ownCloud with all the required dependencies in the Docker containers.

Installing Docker and Docker Compose

Follow this instruction to download and install Docker to your computer. Docker is a program for automating application development and management in container-enabled environments.
Then follow this instruction to download and install the Docker Compose package manager, which allows you to describe and run multi-container applications.

Installing ONLYOFFICE Docs and ownCloud servers

Download the latest version of the docker-onlyoffice-owncloud repository. To do so, insert the following line into the Command line interface:
```
git clone --recursive https://github.com/ONLYOFFICE/docker-onlyoffice-owncloud
```
Once the repository is downloaded, go to the docker-onlyoffice-owncloud folder:
```
cd docker-onlyoffice-owncloud
```
Update submodules in the repository:
```
git submodule update --remote
```
Launch Docker Compose:
```
sudo docker-compose up -d
```
You might need to wait a couple of minutes until all the containers are up and running after the command above.

In the browser address bar, enter http://localhost to open the ownCloud setup page and create your admin account. Enter your Login and Password (by default, admin is used for both fields).

Now you can create and edit documents in ownCloud using ONLYOFFICE Docs without configuring any settings.

Server settings are specified during the deployment, but you can adjust Common settings, Editor customization settings, and Common templates. Please refer to the Configuring the ONLYOFFICE connector for ownCloud section to learn more about the available connector settings.

Installing ONLYOFFICE Docs with ownCloud on a virtual machine using UCS

App appliances introduced by Univention are a distribution format that allows installing systems already packed with components such as ONLYOFFICE Docs and ownCloud.

Univention, an open-source corporate infrastructure developer, introduced a handy method of installing systems already equipped with third-party components – virtual app appliances. These are VirtualBox or VMware images that include the app, UCS management system and the UCS runtime environment.

The following virtual images contain Univention Corporate Server, ownCloud and ONLYOFFICE. The apps work out of the box with the additionally created auto-configuration that makes sure that the required ONLYOFFICE add-on in ownCloud is configured correctly. The installation process is far easier than a classic manual method: no manual steps by the administrator are needed.

Download the necessary components

First, you need to install the hypervisor for the virtual machine. Choose between VMware Workstation Pro or VirtualBox and follow the documentation for detailed installation instructions.

Then download ONLYOFFICE-ownCloud VM for the hypervisor that you’ve chosen.

Import the virtual appliance

Now open the hypervisor and import the ONLYOFFICE-ownCloud virtual appliance. This guide describes how to do this in both platforms.

Install the application

Once the image is successfully imported, start the Virtual Machine. Go through the booting process via the installation wizard, following the steps below.

Choose your language and enter the nearest city.
The wizard will obtain the default system locale, timezone, and keyboard layout.
Set up your domain and network settings. By default, you obtain an IP address automatically. Alternatively, you can specify your IP address, net mask, and gateway manually. Enter the address of the preferred DNS server.
Select your domain settings. The Manage users and permissions directly on this system option is selected by default. It allows creating a new domain in this system. Alternatively, you can connect to the existing UCS or Microsoft Active Directory domain.
Enter your Company name, admin email address for activating ONLYOFFICE (the license file will be sent to this email address), create and confirm a new password for your administrator account.
Specify the fully qualified domain name for this system and the LDAP base:
Review your settings and make sure everything is filled out correctly. Then click the Configure System button.
Once everything is configured, ONLYOFFICE is ready to start in a newly created UCS platform.
Enter your IP address in the browser address bar and upload your ucs.license file received via email.
To log in to your ONLYOFFICE Docs and ownCloud appliance, click ownCloud in the Applications section and enter the default username and password (owncloud, owncloud).
To log in to your Univention Management Console, click LOGIN on the top or System and domain settings in the Administration section and enter your admin email address and the password specified during the registration (see step 4).

Enabling editing for ownCloud Web

To enable work within ownCloud Web, register the connector in the ownCloud Web config.json:

If you installed ownCloud Web from the official marketplace, the path is
If you compiled it from source code yourself using this instruction, the path is
```
/config/config.json
```

To register the connector, use these lines:

"external_apps": [
                {
                  "id": "onlyoffice",
                  "path": "http(s):///custom/onlyoffice/js/web/onlyoffice.js"
                }
              ]

Depending on your web server configuration, you can drop the index.php segment from the URL path.

Start using ONLYOFFICE Docs within ownCloud

To create a document:

Open the needed folder within ownCloud.
Click the add button.
Choose the needed file type: Document, Spreadsheet, or Presentation.
Type in the document name and press Enter.
Optional. If some templates are added by the administrator, select the necessary template and click Create.

To open a document for editing or viewing:

Open the folder with the needed document.
Click the more button or the document title.
Click the Open in ONLYOFFICE option.

To convert a document to the Office Open XML format:

Open the folder with the needed document.
Click the more button or the document title.
Click the Convert with ONLYOFFICE option.
See the full list of the formats which can be converted into OOXML.
The ODT, ODS, ODP, and RTF formats are also available for instant conversion. If the corresponding option is enabled in the admin settings, documents in the specified formats will be immediately converted and opened in the ONLYOFFICE editor for editing after clicking on them and choosing the Open in ONLYOFFICE menu item.

Connecting ONLYOFFICE Desktop Editors to ownCloud

ONLYOFFICE allows you to edit the files stored in your ownCloud account and collaborate on them using both online and desktop editors. Thereby, you can use not only online collaboration tools but also the features available in your desktop application only:

protecting documents with a password or a digital signature,
sending the currently edited file right from the editor using the Send plugin,
inserting audio and video via the Presentation Editor.

It's supposed that you already have ownCloud server, ONLYOFFICE Docs and the integration app installed and configured.

Launch ONLYOFFICE Desktop Editors. To connect Desktop Editors to your ownCloud server, perform the following actions:

Switch to the Connect to cloud section on the left side panel.
Click the ownCloud cloud service button. Alternatively, you can use the Connect now link at the bottom.
If you pressed the ownCloud service button, the Connect to cloud office window opens with the ownCloud selected. If you used the Connect now link, choose the ownCloud cloud storage from the drop-down list.
- in the Cloud office URL field, enter your ownCloud server domain name or IP address. When ready, click the Connect now button.
- The ownCloud sign in page will open in a new tab of the Desktop Editors interface.
  - Specify your Username or email and the Password you use to access your ownCloud account,
  - Click the Log in button.

The Files section of your ownCloud account will open. Now you can edit your existing files and create new ones, share your documents and collaborate on them with ownCloud users using ONLYOFFICE editors.

To learn more about managing your connected accounts, please refer to this instruction.

Connecting ONLYOFFICE Documents to ownCloud on iOS or Android

You can connect ownCloud to the ONLYOFFICE Documents mobile app to work on your ownCloud documents, spreadsheets, and presentations and edit them collaboratively on-the-go.