HumHub ONLYOFFICE integration plugin

This plugin enables users to edit office documents from HumHub 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: ODT, ODS, ODP, DOC, XLS, PPT, TXT, PDF.
• For conversion to Office Open XML: ODT, ODS, ODP, DOC, XLS, PPT, TXT, CSV.

Installing ONLYOFFICE Docs

You will need an instance of ONLYOFFICE Docs (Document Server) that is resolvable and connectable both from HumHub and any end clients. ONLYOFFICE Document Server must also be able to POST to HumHub 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 HumHub ONLYOFFICE integration plugin

Either install it from HumHub Marketplace or simply clone the repository inside one of the folder specified by moduleAutoloadPaths parameter. Please see HumHub Documentation for more information.

Configuring HumHub CONLYOFFICE integration plugin

Navigate to Administration -> Modules find the plugin under Installed tab and click Configure.

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 JWT Secret on the HumHub configuration page. In the ONLYOFFICE Docs config file, specify the same secret key and enable the validation.

How it works

The ONLYOFFICE integration follows the API documented here:

• When creating a new file, the user will be provided with Document, Spreadsheet or Presentation options in the Create document menu.

• The browser invokes the index method in the /controllers/CreateController.php controller.

• Or, when opening an existing file, the user will be provided with View document or Edit document depending on an extension.

• A popup is opened and the index method of the /controllers/OpenController.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;
  • callbackUrl - the URL that ONLYOFFICE Document Server informs about status of the document editing;
  • key - the random MD5 hash to instruct ONLYOFFICE Document Server whether to download the document again or not;
  • title - the document Title (name);
  • id - the identification of the user;
  • name - the name of the user.

• HumHub takes this object and constructs a page from views/open/index.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 HumHub and the user begins editing.

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

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

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.

* If supported by DMS.