Skip to main content

Nuxeo integration

This package enables users to edit office documents from Nuxeo using ONLYOFFICE Docs.

Features​

  • Currently, the following document formats can be edited: DOCM, DOCX, DOTM, DOTX, HTM, XML, XLSM, XLSX, XLTM, XLTX, POTM, POTX, PPSM, PPSX, PPTM, PPTX.
  • The following formats are available for viewing only: DJVU, DOC, DOT, EPUB, FB2, FODT, HTML, MHT, ODT, OTT, OXPS, PDF, RTF, TXT, XPS, CSV, FODS, ODS, OTS, XLS, XLT, FODP, ODP, OTP, POT, PPS, PPT.
  • The following formats are available for converting to Office Open XML formats: DOC, DOCM, DOT, DOTM, DOTX, EPUB, FB2, FODT, HTM, HTML, MHT, ODT, OTT, OXPS, PDF, RTF, XML, XPS, FODS, ODS, OTS, XLS, XLSM, XLT, XLTM, XLTX, FODP, ODP, OTP, POT, POTM, POTX, PPS, PPSM, PPSX, PPT, PPTM.
  • The package allows multiple users to collaborate in real time and to save back those changes to Nuxeo.

Installing ONLYOFFICE Docs​

You will need an instance of ONLYOFFICE Docs (Document Server) that is resolvable and connectable both from Nuxeo and any end clients. If that is not the case, use the official ONLYOFFICE Docs documentation page. ONLYOFFICE Docs must also be able to POST to Nuxeo directly.

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

Installing ONLYOFFICE addon package for Nuxeo​

You have two options:

Option 1. Nuxeo Marketplace (recommended)

Install directly from Nuxeo Marketplace

Option 2. nuxeoctl

nuxeoctl mp-install /path/to/onlyoffice-nuxeo-package-x.x.zip

Configuring ONLYOFFICE addon package for Nuxeo​

Open the nuxeo.conf file and enter the name of the server with ONLYOFFICE Docs installed:

onlyoffice.docserv.url=http://documentserver/

where the documentserver is the name of the server with ONLYOFFICE Docs installed. The address must be accessible from both the user's browser and the Nuxeo server. The Nuxeo server address must also be accessible from ONLYOFFICE Docs for correct work. You can register a free ONLYOFFICE Cloud and use its public IP address or public DNS that can be found in the Instances section of the cloud console.

Starting from version 7.2, JWT is enabled by default and the secret key is generated automatically to restrict access to ONLYOFFICE Docs and for security reasons and data integrity. Specify your own secret key by adding the onlyoffice.jwt.secret=yoursecret line to the nuxeo.conf file. In the ONLYOFFICE Docs config file, specify the same secret key and enable the validation.

Compiling ONLYOFFICE addon package for Nuxeo​

To build Nuxeo package, the following steps must be performed for Ubuntu:

  1. The stable Java version is necessary for the successful build. If you do not have it installed, use the following commands to install Open JDK 8:

    sudo apt-get update
    sudo apt-get install openjdk-8-jdk

  2. Install the latest Maven. Installation process is described here.

  3. Download the ONLYOFFICE addon package for Nuxeo source code:

    git clone https://github.com/onlyoffice/onlyoffice-nuxeo.git

  4. Compile ONLYOFFICE addon package for Nuxeo:

    cd onlyoffice-nuxeo/
    mvn clean install

  5. Built package is located here ./onlyoffice-nuxeo-package/target/onlyoffice-nuxeo-package-x.x.zip.

How it works​

The ONLYOFFICE integration follows the API documented here.

Create a new file​

  1. Open the target workspace/folder.
  2. Click Create new (ONLYOFFICE icon).
  3. Choose Document / Spreadsheet / Presentation, name it, and confirm.
  4. The editor opens - start working immediately.

Open an existing file​

  1. Locate your file in Nuxeo.
  2. Click Open with ONLYOFFICE (or the editor icon).
  3. The file opens in the embedded editor for viewing or editing (per your permissions).

Auto-save and versioning​

Changes are sent back to Nuxeo; Nuxeo handles repository updates/versioning.

Download the ONLYOFFICE addon package for Nuxeo here.