The app which enables the users to edit office documents from Nextcloud using ONLYOFFICE Document Server, allows multiple users to collaborate in real time and to save back those changes to Nextcloud
Clone or download
Latest commit a72c491 Dec 11, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
3rdparty/jwt jwt for config Apr 4, 2017
appinfo 2.1.2 Dec 11, 2018
assets sv Sep 14, 2018
controller render error template Dec 7, 2018
css using Notification (ONLYOFFICE/onlyoffice-owncloud#229) Dec 6, 2018
img Nextcloud link Aug 17, 2018
js do not hide the error message on the editor page Dec 7, 2018
l10n l10n Dec 6, 2018
lib fix type Dec 7, 2018
screenshots screenshots Aug 17, 2018
templates setting a limit Dec 5, 2018
AUTHORS.md Initial release v1.0.0 Feb 2, 2017
CHANGELOG.md 2.1.2 Dec 11, 2018
LICENSE OwnCloud ONLYOFFICE™ integration app Jan 27, 2017
README.md support for a format with a duplicate mimetype Aug 17, 2018
settings.php delete a space Jul 16, 2018

README.md

Nextcloud ONLYOFFICE integration app

This app enables users to edit office documents from Nextcloud using ONLYOFFICE Document Server. Currently the following document formats can be edited with this app: csv, docx, pptx, txt, xlsx. The above mentioned formats are also available for viewing together with pdf. The edited files of the corresponding type can be converted into the Office Open XML formats: doc, docm, dot, dotx, epub, htm, html, odp, odt, pot, potm, potx, pps, ppsm, ppsx, ppt, pptm, rtf, xls, xlsm, xlsx, xlt, xltm, xltx.

The app will create an item in the new (+) menu to create Document, Spreadsheet, Presentation. It will also create a new Open in ONLYOFFICE menu option within the document library for Office documents. This allows multiple users to collaborate in real time and to save back those changes to Nextcloud.

You can also use our Docker installation to get installed and configured Document Server and Nextcloud installation with a couple of commands.

Installing ONLYOFFICE Document Server

You will need an instance of ONLYOFFICE Document Server that is resolvable and connectable both from Nextcloud and any end clients (version 4.2.7 and later are supported for use with the app). If that is not the case, use the official ONLYOFFICE Document Server documentation page: Document Server for Linux. ONLYOFFICE Document Server must also be able to POST to Nextcloud directly.

Starting with version 4.3.0, ONLYOFFICE Document Server and Nextcloud 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 Document Server as by default both ONLYOFFICE Document Server and Nextcloud work on port 80. Or you can use Document Server behind a proxy, please refer to this article to learn how you can configure it.

The easiest way to start an instance of ONLYOFFICE Document Server is to use Docker.

Installing Nextcloud ONLYOFFICE integration app

The Nextcloud administrator can install the integration app from the in-built application market. For that go to the user name and select Apps. After that find ONLYOFFICE in the list of available applications and install it.

If the server with the Nextcloud installed does not have an Internet access, or if you need it for some other reason, the administrator can install the application manually. To start using ONLYOFFICE Document Server with Nextcloud, the following steps must be performed:

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

    cd apps/
    
  2. Get the Nextcloud ONLYOFFICE integration app. There are several ways to do that:

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

    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-nextcloud.git onlyoffice
    
  3. Change the owner to update the application right from Nextcloud web interface:

    chown -R www-data:www-data onlyoffice
    
  4. In Nextcloud open the ~/index.php/settings/apps?category=disabled page with Not enabled apps by administrator and click Enable for the ONLYOFFICE application.

Configuring Nextcloud ONLYOFFICE integration app

In Nextcloud open the ~/index.php/settings/admin/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 Nextcloud server. The Nextcloud server address must also be accessible from ONLYOFFICE Document Server for correct work.

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

To restrict the access to ONLYOFFICE Document Server and for security reasons and data integrity the encrypted signature is used. Specify the Secret key in the Nextcloud administrative configuration. In the ONLYOFFICE Document Server 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.

How it works

The ONLYOFFICE integration follows the API documented here https://api.onlyoffice.com/editors/basic:

  • When creating a new file, the user navigates to a document folder within Nextcloud 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 Nextcloud 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;
    • callback - 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 UUID+Modified Timestamp to instruct ONLYOFFICE Document Server whether to download the document again or not;
    • fileName - the document Title (name);
    • userId - the identification of the user;
    • userName - the name of the user.
  • Nextcloud 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 Nextcloud and the user begins editing.

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

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

Known issues

  • If the document is shared using the Federated Cloud Sharing app, the co-editing among the servers will not be avaialble. The users from one and the same server can edit the document in the co-editing mode, but the users from two (or more) different servers will not be able to collaborate on the same document in real time.

  • 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.

  • Nextcloud provides an option to encrypt the file storage. But if the encryption with the per-user encryption keys (used by default in Nextcloud 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 Nextcloud websites.