onlyoffice-owncloud

ONLYOFFICE app for ownCloud

This app allows users to edit office documents from ownCloud using ONLYOFFICE Docs packaged as Document Server - Community or Enterprise Edition.

Features ✨

The app allows to:

• ✍️ Create and edit text documents, spreadsheets, and presentations.
• 📝 Create and edit PDF forms.
• ✂️ Edit PDF files.
• 📊 View diagram files.
• 🔗 Share files with different permission types - viewing/editing, commenting, reviewing, filling forms. It’s also possible to restrict downloading (in all editors) and modifying filters (in spreadshhets). Sharing via public link is also available.
• 👥 Co-edit documents in real time: two co-editing modes (Fast and Strict), Track Changes, comments, and built-in chat. Co-editing is also available several federated ownCloud instances connected to one Document Server.
• 🌐 Work with documents, spreadsheets, and presentations within ownCloud Web.
• 🤖 Enable AI assistants in the editors to work faster and more efficient (it’s possible to connect any AI provider).

Supported formats:

For viewing:

• WORD: DOC, DOCM, DOCX, DOT, DOTM, DOTX, EPUB, FB2, FODT, HML, HTM, HTML, HWP, HWPX, MD, MHT, MHTML, ODT, OTT, PAGES, RTF, STW, SXW, TXT, WPS, WPT, XML
• CELL: CSV, ET, ETT, FODS, NUMBERS, ODS, OTS, SXC, XLS, XLSM, XLSX, XLT, XLTM, XLTX
• SLIDE: DPS, DPT, FODP, KEY, ODG, ODP, OTP, POT, POTM, POTX, PPS, PPSM, PPSX, PPT, PPTM, PPTX, SXI
• PDF: DJVU, DOCXF, OFORM, OXPS, PDF, XPS
• DIAGRAM: VSDM, VSDX, VSSM, VSSX, VSTM, VSTX

For editing:

• WORD: DOCM, DOCX, DOTM, DOTX
• CELL: XLSB, XLSM, XLSX, XLTM, XLTX
• SLIDE: POTM, POTX, PPSM, PPSX, PPTM, PPTX
• PDF: PDF

ODT, ODS, and ODP is 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.

Installing ONLYOFFICE Docs 📦

You will need an instance of ONLYOFFICE Docs (Document Server) that is resolvable and connectable both from ownCloud and any end clients. ONLYOFFICE Document Server must also be able to POST to ownCloud directly.

ONLYOFFICE Document Server and ownCloud can be installed either on different computers, or on the same machine. If you use one machine, set up a custom port for Document Server as by default both ONLYOFFICE Document Server and ownCloud work on port 80.

You can install free Community version of ONLYOFFICE Docs or scalable Enterprise Edition.

To install free Community version, use Docker (recommended) or follow these instructions for Debian, Ubuntu, or derivatives.

To install Enterprise Edition, follow instructions here.

Community Edition vs Enterprise Edition comparison can be found here.

To use ONLYOFFICE behind a proxy, please refer to this article.

You can also use our Docker installation to install pre-configured Document Server (free version) and ownCloud with a couple of commands.

Alternatively, you can opt for ONLYOFFICE Docs Cloud which doesn’t require downloading and installation. To get ONLYOFFICE Docs Cloud, get started here.

Installing ONLYOFFICE app for ownCloud 📥

The ownCloud administrator can install the app from the in-built application market. For that click the upper-left hamburger menu and select Market. After that find ONLYOFFICE in the list of available applications and install it.

If the server with the ownCloud installed does not have an Internet access, or if you need it for some other reason, the administrator can install the application manually:

1. Go to the ownCloud server apps/ directory (or some other directory used):

   cd apps/
   

2. Get the ONLYOFFICE app for ownCloud. There are several ways to do that:

   a. Download the latest signed version from the official store for ownCloud.

   b. Or you can download the latest signed version from the application release page on GitHub.

   c. Or you can 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 giving an alert, so you will need to use either option a or b to get the application.

3. Change the owner to update the application right from ownCloud web interface:

   chown -R www-data:www-data onlyoffice
   

4. In ownCloud open the ~/settings/admin?sectionid=apps&category=disabled page with Not enabled apps by administrator and click Enable for the ONLYOFFICE application.

Configuring ONLYOFFICE app for ownCloud 🛠️

In ownCloud open the ~/settings/admin?sectionid=additional#onlyoffice page with administrative settings for ONLYOFFICE section. Enter the following address to connect ONLYOFFICE Document Server:

https://<documentserver>/

Where the documentserver is the name of the server with the ONLYOFFICE Document Server installed. The address must be accessible for the user browser and from the ownCloud server. The ownCloud server address must also be accessible from ONLYOFFICE Document Server for correct work.

Sometimes your network configuration might not allow the requests between installed ownCloud and ONLYOFFICE Document Server using the public addresses. The Advanced server settings allows to set the ONLYOFFICE Document Server address for internal requests from ownCloud server and the returning ownCloud address for the internal requests from ONLYOFFICE Document Server. You need to enter them in the appropriate fields.

JWT is enabled by default and the secret key is generated automatically to restrict the access to ONLYOFFICE Docs and for security reasons and data integrity. Specify your own Secret key in the ownCloud administrative configuration. In the ONLYOFFICE Docs config file, specify the same secret key and enable the validation.

Enable or disable the Open file in the same tab setting.

The Open in ONLYOFFICE action will be added to the file context menu. You can specify this action as default and it will be used when the file name is clicked for the selected file types.

Checking the connection ☑️

You can check the connection to ONLYOFFICE Document Server 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.

Restricting the address of ONLYOFFICE Docs 🔒

When the address of ONLYOFFICE Docs is saved on the administrative settings page, ownCloud checks whether it can be reached, and that check refuses some addresses instead of contacting them. Only the check that runs on save refuses them: the occ onlyoffice:documentserver --check command and the background job that verifies availability contact the address as before.

Some addresses are always refused, because no document server can be reached at them: 0.0.0.0/8, ::/128, the link-local ranges 169.254.0.0/16 and fe80::/10 (which contain the cloud metadata service at 169.254.169.254), the multicast ranges 224.0.0.0/4 and ff00::/8, and 240.0.0.0/4, 100::/64, 192.0.0.0/24 and 198.18.0.0/15. The metadata addresses of providers that do not use 169.254.169.254 are refused as well, namely 100.100.100.200 and fd00:ec2::254.

The address is resolved before the check is sent and the result is pinned for it, so a name that resolves to one address when it is examined and to another when the request is sent cannot be used to reach a refused address. An address that cannot be resolved at all is refused too.

The private ranges 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16, 127.0.0.0/8, fc00::/7 and fec0::/10 are refused as well. ONLYOFFICE Docs is often reached at one of them over a container network, over a LAN, or on the same host as ownCloud, so allow them in config.php before saving such an address on the settings page:

"onlyoffice" => [
    "allow_local_address" => true
],

Without that option an address in one of the private ranges cannot be saved on the settings page, and the save reports that ONLYOFFICE Docs could not be reached. An address that is already configured keeps working: only the check that runs on save refuses it.

The addresses can also be written to config.php instead of being saved on the settings page:

"onlyoffice" => [
    "DocumentServerUrl" => "https://<documentserver>/",
    "DocumentServerInternalUrl" => "http://<documentserver>/",
    "StorageUrl" => "http://<owncloud>/"
],

Addresses set this way are not sent through the settings page, so a private address can be used without allowing the private ranges. Nothing else refuses it: the background job keeps reporting the address as available, and the requests exchanged with ONLYOFFICE Docs while documents are edited are not restricted.

An address saved on the settings page takes precedence over the one in config.php, so clear it there first if it has been saved before.

The option is read from config.php alone, so it cannot be changed from the administrative settings page.

These rules apply to the requests that check the address. The requests exchanged with ONLYOFFICE Docs while documents are edited and converted are not restricted this way. Restricting outbound connections from the ownCloud server at the network level, to the addresses it legitimately needs, remains the most reliable control and is worth doing regardless of this option.

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 <owncloud-root-catalog>/config/config.json
• If you compiled it from source code yourself using this instruction, the path is <owncloud-web-root-catalog>/config/config.json.

To register the connector, use these lines:

"external_apps": [
    {
        "id": "onlyoffice",
        "path": "http(s)://<owncloud-10-server-address>/index.php/apps/onlyoffice/js/onlyoffice.js",
    }
]

Depending on your webserver configuration you can drop the index.php segment from the url path.

How it works ⚙️

The ONLYOFFICE app follows the API documented here api.onlyoffice.com:

• 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 the copy of the file from the assets folder to the folder the user is currently in.

• Or, 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 Document Server uses to download the document;
  • callbackUrl - the URL that ONLYOFFICE Document Server informs 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 etag to instruct ONLYOFFICE Document Server whether to download the document again or not;

• ownCloud takes this object and constructs a page from templates/editor.php template, filling in all of those values so that the client browser can load up the editor.

• The client browser makes a request for the javascript library from ONLYOFFICE Document Server and sends ONLYOFFICE Document Server the DocEditor configuration with the above properties.

• Then ONLYOFFICE Document Server downloads the document from ownCloud and the user begins editing.

• ONLYOFFICE Document Server sends a POST request to the 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 Document Server sends a POST to the callbackUrl letting ownCloud know that the clients have finished editing the document and closed it.

• ownCloud downloads the new version of the document, replacing the old one.

Known issues ❓

• Adding the storage using the External storages app has issues with the co-editing in some cases. If the connection is made using the same authorization keys (the Username and password or Global credentials authentication type is selected), then the co-editing is available for the users. If different authorization keys are used (Log-in credentials, save in database or User entered, store in database authentication options), the co-editing is not available. When the Log-in credentials, save in session authentication type is used, the files cannot be opened in the editor.

• ownCloud provides an option to encrypt the file storage. But if the encryption with the per-user encryption keys (used by default in ownCloud Default encryption module app) is enabled, ONLYOFFICE Document Server cannot open the encrypted files for editing and save them after the editing. The ONLYOFFICE section of the administrative settings page will display a notification about it. However if you set the encryption with the master key, ONLYOFFICE application will work as intended. The instruction on enabling master key based encryption is available in the official documentation on ownCloud websites.

• If you are using a self-signed certificate for your Document Server, ownCloud will not validate such a certificate and will not allow connection to/from Document Server. This issue can be solved in two ways.

  You can check the ‘Disable certificate verification (insecure)’ box on the ONLYOFFICE administration page, Server settings section, within your ownCloud.

  Another option is to change the ownCloud config file manually. Locate the ownCloud config file (/owncloud/config/config.php) and open it. Insert the following section to it:

  'onlyoffice' => array (
      'verify_peer_off' => true
  )
  

  This will disable the certificate verification and allow ownCloud to establish connection with Document Server.

  Please remember that this is a temporary insecure solution and we strongly recommend that you replace the certificate with the one issued by some CA. Once you do that, do not forget to uncheck the corresponding setting box or remove the above section from the ownCloud config file.

• If the editors don’t open or save documents after a period of proper functioning, the reason can be a problem in changing network settings or disabling any relevant services, or issues with the SSL certificate.

  To solve this, we added an asynchronous background task which runs on the server to check availability of the editors. It allows testing the connection between your ownCloud instance and ONLYOFFICE Document Server, namely availability of server addresses and the validity of the JWT secret are being checked.

  If any issue is detected, the ONLYOFFICE app (consequently, the ability to create and open files) will be disabled. As an ownCloud admin, you will get the corresponding notification.

  This option allows you to avoid issues when the server settings become incorrect and require changes.

  By default, this background task runs once a day. If necessary, you can change the frequency. To do so, open the ownCloud config file (/owncloud/config/config.php). Insert the following section and enter the required value in minutes:

  'onlyoffice' => array (
      'editors_check_interval' => 3624
  )
  

  To disable this check running, enter 0 value.

• When accessing a document without download permission, file printing and using the system clipboard are not available. Copying and pasting within the editor is available via buttons in the editor toolbar and in the context menu.

ONLYOFFICE Docs editions

ONLYOFFICE offers different versions of its online document editors that can be deployed on your own servers.

• Community Edition 🆓 (onlyoffice-documentserver package)
• Enterprise Edition 🏢 (onlyoffice-documentserver-ee package)

The table below will help you to make the right choice.

Pricing and licensing	Community Edition	Enterprise Edition
	Get it now	Start Free Trial
Cost	FREE	Go to the pricing page
Number of users	up to 20 recommended	As in chosen pricing plan
License	GNU AGPL v.3	Proprietary
Support	Community Edition	Enterprise Edition
Documentation	Help Center	Help Center
Standard support	GitHub or Community	1 or 3 years support included
Premium support	Contact us	Contact us
Services	Community Edition	Enterprise Edition
Conversion Service	+	+
Live Viewer	+	+
Document Builder Service	-	-
Automation API	-	-
Interface	Community Edition	Enterprise Edition
Tabbed interface	+	+
Dark theme	+	+
125%, 150%, 175%, 200% scaling	+	+
White Label	-	-
Integrated test example (node.js)	+	+
Admin Panel	-	+
Mobile web editors	-	+*
Plugins & Macros	Community Edition	Enterprise Edition
Plugins	+	+
Macros	+	+
Collaborative capabilities	Community Edition	Enterprise Edition
Two co-editing modes	+	+
Comments	+	+
Built-in chat	+	+
Review and tracking changes	+	+
Display modes of tracking changes	+	+
Version history	+	+
Document Editor features	Community Edition	Enterprise Edition
Font and paragraph formatting	+	+
Object insertion	+	+
Adding Content control	+	+
Editing Content control	+	+
Layout tools	+	+
Table of contents	+	+
Navigation panel	+	+
Mail Merge	+	+
Comparing documents	+	+
Multipage View	+	+
Spreadsheet Editor features	Community Edition	Enterprise Edition
Font and paragraph formatting	+	+
Object insertion	+	+
Functions, formulas, equations	+	+
Table templates	+	+
Pivot tables	+	+
Data validation	+	+
Conditional formatting	+	+
Sparklines	+	+
Sheet Views	+	+
Solver	+	+
Presentation Editor features	Community Edition	Enterprise Edition
Font and paragraph formatting	+	+
Object insertion	+	+
Transitions	+	+
Animations	+	+
Presenter mode	+	+
Notes	+	+
Slide Master	+	+
Form creator features	Community Edition	Enterprise Edition
Adding form fields	+	+
Form preview	+	+
Saving as PDF	+	+
Role-matching colors for fields	+	+
PDF Editor features	Community Edition	Enterprise Edition
Text editing and co-editing	+	+
Work with pages (adding, deleting, rotating)	+	+
Inserting objects (shapes, images, hyperlinks, etc.)	+	+
Text annotations (highlight, underline, cross out, stamps)	+	+
Redact	+	+
Comments	+	+
Freehand drawings	+	+
Form filling	+	+
	Get it now	Start Free Trial

* If supported by DMS.

Need help? User Feedback and Support 💡

• 🐞 Found a bug? Please report it by creating an issue.
• ❓ Have a question? Ask our community and developers on the ONLYOFFICE Forum.
• 👨‍💻 Need help for developers? Check our API documentation.