Skip to content

Plugin for integrating ONLYOFFICE online editors with Nuxeo

License

Notifications You must be signed in to change notification settings

ONLYOFFICE/onlyoffice-nuxeo

Repository files navigation

Nuxeo ONLYOFFICE integration plugin

This plugin enables users to edit office documents from Nuxeo using ONLYOFFICE Docs packaged as Document Server - Community or Enterprise Edition.

Features

The plugin allows to:

  • Create and edit text documents, spreadsheets, and presentations.
  • Share documents with other users.
  • Co-edit documents in real-time: use two co-editing modes (Fast and Strict), Track Changes, comments, and built-in chat.

Supported formats:

  • For viewing and editing: DOCX, XLSX, PPTX, DOCXF, OFORM.
  • For viewing only: PDF, ODT, ODS, ODP, DOC, XLS, PPT.

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. ONLYOFFICE Document Server must also be able to POST to Nuxeo directly.

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

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.

Installing Nuxeo ONLYOFFICE integration plugin

Install it from marketplace.

You can also install it using nuxeoctl.

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

Configuring Nuxeo ONLYOFFICE integration plugin

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 the user browser and from the Nuxeo server. The Nuxeo server address must also be accessible from ONLYOFFICE Docs for correct work.

Starting from version 7.2, 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 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 Nuxeo ONLYOFFICE plugin

To build Nuxeo plugin, 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 latest Maven: Installation process is described here

  3. Download the Nuxeo ONLYOFFICE integration plugin source code:

    git clone https://github.com/onlyoffice/onlyoffice-nuxeo.git
  4. Compile Nuxeo ONLYOFFICE integration plugin:

    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.

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 make the right choice.

Pricing and licensing Community Edition Enterprise Edition
Get it now Start Free Trial
Cost FREE Go to the pricing page
Simultaneous connections up to 20 maximum As in chosen pricing plan
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 paid One year support included
Premium support Contact us Contact us
Services Community Edition Enterprise Edition
Conversion Service + +
Document Builder Service + +
Interface Community Edition Enterprise Edition
Tabbed interface + +
Dark theme + +
125%, 150%, 175%, 200% scaling + +
White Label - -
Integrated test example (node.js) + +
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 + +
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 + +
Presentation Editor features Community Edition Enterprise Edition
Font and paragraph formatting + +
Object insertion + +
Transitions + +
Presenter mode + +
Notes + +
Form creator features Community Edition Enterprise Edition
Adding form fields + +
Form preview + +
Saving as PDF + +
Get it now Start Free Trial

* If supported by DMS.