Overview
Integrating ONLYOFFICE with Nuxeo open sourse content management system through a connector, available in in the official Nuxeo Marketplace or on ONLYOFFICE GitHub page, allows you to edit Office documents within Nuxeo platform.
ONLYOFFICE add-on adds the following features:
- Creating and editing office text docuemnt,s spreadsheets and presentations.
- Co-editing documents in real-time: use two co-editing modes (Fast and Strict), Track Changes, comments, and built-in chat.
- Opening for editing and viewing docx, pptx and xlsx formats.
The following formats are only available for viewing only: pdf, odt, ods, odp, doc, xls, ppt.
Online editors integration
This addon enables users to edit office documents from Nuxeo using ONLYOFFICE Docs.
Installing ONLYOFFICE Docs
You will need an instance of ONLYOFFICE Docs 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 for Linux.
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 Compose.
Installing ONLYOFFICE addon for Nuxeo
Go to the Nuxeo marketplace and find the latest connector version of Nuxeo ONLYOFFICE connector.
The provided instructions use the
nuxeoctl
script. Visit official Nuxeo
documentation page to find more available options on how to install packages.
- For a Nuxeo Online Services registered instance with internet access:
- Stop your server
./nuxeoctl stop
- Run the following command to install the connector:
./nuxeo/bin/nuxeoctl mp-install onlyoffice-nuxeo-x.x.x
Where onlyoffice-nuxeo-x-x-x
is the latest available version of the Nuxeo ONLYOFFICE connector.
- After the package is downloaded and installed, start your server
./nuxeoctl start
- For an unregistered instance, or an offline instance:
- Stop your server
./nuxeoctl stop
- Download the connector
wget https://connect.nuxeo.com/nuxeo/site/marketplace/package/onlyoffice-nuxeo/download?version=x.x.x
Where version=x.x.x
is the latest available version of the Nuxeo ONLYOFFICE connector. Otherwise, visit the Nuxeo marketplace and find the link manualy.
- Install the package by providing the path to the downloaded
.zip
file
./nuxeoctl mp-install /Path/to/file/onlyoffice-nuxeo-x.x.x.zip
- After the package is downloaded and installed, start your server
./nuxeoctl start
Configuring ONLYOFFICE addon for Nuxeo
Open the nuxeo/bin/nuxeo.conf
file via any available text editor and add the following lines into it:
onlyoffice.docserv.url=http://documentserver/
onlyoffice.jwt.secret=/your_secret/
Where docserv.url
is an url of an installed and running ONLYOFFICE Docs and jwt.secret
is the secret to validate the JSON web token in the request to ONLYOFFICE Docs.
If you used Docker to install ONLYOFFICE Docs, use information from ONLYOFFICE Github page to properly configure JWT.
If you used other installation options, check the API documentation for configuring JWT on the ONLYOFFICE Docs side.
Compiling ONLYOFFICE addon for Nuxeo
To build Nuxeo plugin, the following steps must be performed for Ubuntu:
- The stable Java version is necessary for the successful build. Use the following commands to install Open JDK 8:
sudo apt-get update
sudo apt-get install openjdk-8-jdk
- Install Maven by running the following command:
sudo apt install maven
Installation process of Maven in details is described here.
To verify the Maven installation and see the current version, run
mvn -version
- Download the Nuxeo ONLYOFFICE integration plugin source code:
git clone https://github.com/onlyoffice/onlyoffice-nuxeo.git
- Compile Nuxeo ONLYOFFICE integration plugin:
cd onlyoffice-nuxeo/
mvn clean install
- Built package is located here
./onlyoffice-nuxeo-package/target/onlyoffice-nuxeo-package-x.x.zip
.