ONLYOFFICE Connector for HumHub

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

The plugin is available in the official HumHub Marketplace.

  • Currently the following document formats can be opened and edited with this plugin: DOCX, XLSX, PPTX.
  • The following formats are available for view only: ODT, ODS, ODP, DOC, XLS, PPT, TXT, PDF.
  • The plugin will create a new Edit/View menu option for Office documents.
  • This allows multiple users to collaborate in real time and to save back those changes to HumHub.
  • The following formats can be converted to Office Open XML: ODT, ODS, ODP, DOC, XLS, PPT, TXT, CSV.

You will need an instance of ONLYOFFICE Document Server that is resolvable and connectable both from HumHub and any end clients. If that is not the case, use the official ONLYOFFICE Document Server documetnation page: Document Server for Linux. ONLYOFFICE Document Server must also be able to POST to HumHub directly.

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

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.

In order to configure plugin you must navigate to Administation -> Modules. Find ONLYOFFICE plugin and click Configure.

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.

Download the ONLYOFFICE Connector for HumHub here.