ONLYOFFICE Alfresco module package

This plugin enables users to edit office documents from Alfresco Share using ONLYOFFICE Document Server.

The plugin is available in the official Alfresco Add-ons directory.

  • Currently the following document formats can be opened and edited with this plugin: DOCX, XLSX, PPTX.
  • The plugin will create a new Edit in ONLYOFFICE menu option within the document library for Office documents. Edit in OnlyOffice
  • This allows multiple users to collaborate in real time and to save back those changes to Alfresco.
  • And a Convert using ONLYOFFICE option to quickly convert ODT, ODP, ODS, DOC, XLS, PPT files to their Office Open XML counterpart
  • Context menu Create new... option within document library Create new...

You will need an instance of ONLYOFFICE Document Server that is resolvable and connectable both from Alfresco and any end clients (version 3.0 and later are supported for use with the plugin). 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 Alfresco directly.

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

To start using ONLYOFFICE Document Server with Alfresco, the following steps must be performed for Ubuntu 14.04:

Steps 14 are only necessary if you for some reason plan to compile the ONLYOFFICE Alfresco module package yourself (e.g. edit the source code and compile it afterwards). If you do not want to do that and plan to use the already compiled module files, please skip to step 5 directly. The latest compiled package files are available here.
  1. The latest stable Oracle Java version is necessary for the successful build. If you do not have it installed, use the following commands to install Oracle Java 8: sudo apt-get update sudo apt-get install openjdk-8-jdk
  2. Install latest Maven: Installation process is described here
  3. Download the ONLYOFFICE Alfresco module package source code: cd .. git clone
  4. Get a submodule: git submodule update --init --recursive
  5. Compile packages in the repo and share directories: cd onlyoffice-alfresco/ mvn clean install
  6. Upload the compiled *.jar packages to directories accordingly for your Alfresco installation:
    • from onlyoffice-alfresco/repo/target/ to the /webapps/alfresco/WEB-INF/lib/ for Alfresco repository,
    • from onlyoffice-alfresco/share/target/ to /webapps/share/WEB-INF/lib/ for Share.
    You can download the already compiled package files here and place them to the respective directories.
  7. Make sure that Document Server will be able to POST to Alfresco

    You may need to change these lines in<hostname> alfresco.port=443 alfresco.protocol=https<hostname> share.port=443 share.protocol=https
    Probably located here /usr/local/tomcat/shared/classes/
  8. Restart Alfresco: sudo ./ stop sudo ./ start

The module can be checked in administrator tools at /share/page/console/admin-console/module-package in Alfresco.

Other way to build ONLYOFFICE Alfresco module package is using docker-compose file.

Use this command from project directory:

docker-compose up

Module configuration can be found inside Alfresco Administration Console or by simply navigating to http://<alfrescohost>/alfresco/s/onlyoffice/onlyoffice-config

You can also add onlyoffice.url in Configuration made via settings page will override

JWT can be configured via configuration page or by adding onlyoffice.jwtsecret in

The JWT configuration on the Document Server side can be found here.

File types that can be converted

  • .doc, .odt -> .docx
  • .xls, .ods -> .xlsx
  • .ppt, .odp -> .pptx

To convert one specific file you can simply select Convert using ONLYOFFICE action. Resulting file will be placed in the same folder. You can also configure rules for a folder, that will automatically convert files on upload or on change. You can read how such rules can be configured here.

User navigates to a document within Alfresco Share and selects the Edit in ONLYOFFICE menu option.

Alfresco Share makes a request to the repo end (URL of the form: /parashift/onlyoffice/prepare?nodeRef={nodeRef}).

Alfresco Repo end prepares a JSON object for the Share with the following properties:

  • url - the URL that ONLYOFFICE Document Server uses to download the document (includes the alf_ticket of the current user);
  • callbackUrl - the URL that ONLYOFFICE Document Server informs about status of the document editing;
  • onlyofficeUrl - the URL that the client needs to respond to ONLYOFFICE Document Server (provided by the onlyoffice.url property);
  • key - the UUID+Modified Timestamp to instruct ONLYOFFICE Document Server whether to download the document again or not;
  • title - the document Title (name).

Alfresco Share takes this object and constructs a page from a freemarker 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 Alfresco and the user begins editing.

ONLYOFFICE Document Server sends a POST request to the callback URL to inform Alfresco that a user is editing the document.

Alfresco locks the document, but still allows other users with write access the ability to collaborate in real time with ONLYOFFICE Document Server by leaving the Action present.

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 Alfresco know that the clients have finished editing the document and closed it.

Alfresco downloads the new version of the document, replacing the old one.

Download the ONLYOFFICE Alfresco module package here.