hellonadya / onlyoffice-humhub

Plugin for integrating ONLYOFFICE online editors with HumHub

HumHub ONLYOFFICE integration plugin

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

Features

• 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.

Installing ONLYOFFICE Document Server

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 documentations 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.

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.

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 Document Server editions

ONLYOFFICE offers different versions of its online document editors that can be deployed on your own servers.

ONLYOFFICE Document Server:

• Community Edition (onlyoffice-documentserver package)
• Integration Edition (onlyoffice-documentserver-ie package)

The table below will help you make the right choice.

Pricing and licensing	Community Edition	Integration 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	Integration Edition
Documentation	Help Center	Help Center
Standard support	GitHub or paid	One year support included
Premium support	Buy Now	Buy Now
Services	Community Edition	Integration Edition
Conversion Service	+	+
Document Builder Service	+	+
Interface	Community Edition	Integration Edition
Tabbed interface	+	+
White Label	-	-
Integrated test example (node.js)	-	+
Plugins & Macros	Community Edition	Integration Edition
Plugins	+	+
Macros	+	+
Collaborative capabilities	Community Edition	Integration 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	Integration Edition
Font and paragraph formatting	+	+
Object insertion	+	+
Content control	+	+
Layout tools	+	+
Table of contents	+	+
Navigation panel	+	+
Mail Merge	+	+
Spreadsheet Editor features	Community Edition	Integration Edition
Font and paragraph formatting	+	+
Object insertion	+	+
Functions, formulas, equations	+	+
Table templates	+	+
Pivot tables	+*	+*
Presentation Editor features	Community Edition	Integration Edition
Font and paragraph formatting	+	+
Object insertion	+	+
Animations	+	+
Presenter mode	+	+
Notes	+	+
	Get it now	Start Free Trial

*Changing style and deleting (Full support coming soon)