Collabora Plugin 1.1

1. Pre-requisite

The Collabora plugin requires:

• JPlatform 10SP2 (+)
• A running Collbora Online server 4.0.9.4 (+)

The Collabora plugin implements the WOPI protocol (cf. https://wopi.readthedocs.io/en/latest/) where JPlatform acts as a WOPI host, and Collabora Online server acts as a WOPI client. Therefore: 

• JPlatform must be reachable in HTTP or HTTPS from the Collabora server
• Both JPlatform and Collabora servers must be reachable from clients browsers
• JPlatform and Collabora servers must be reachable using the same web protocol i.e. if JPlatform is configured in HTTPS, the collabora server must also be configured in HTTPS

2. Minimal configuration

2.1 Collabora Online server configuration

Edit the configuration file /etc/loolwsd.xml

• set the JPlalform host name

<config>
    <storage desc="Backend storage">
        <wopi desc="Allow/deny wopi storage. Mutually exclusive with webdav." allow="true">
            <host desc="Regex pattern of hostname to allow or deny." allow="true">host.docker.internal</host>
(...)

• Activatealways_save_on_exit option.

<config>
    <per_document desc="Document-specific settings, including LO Core settings.">
        <always_save_on_exit desc="On exiting the last editor, always perform the save, even if the document is not modified." type="bool" default="false">true</always_save_on_exit>

(...)

2.2 JPlatform configuration

2.2.1 Collabora plugin configuration

• In the collabora plugin configuration set the Collabora server URL

• By default, the Collabora server will try to reach JPlatform using the url defined in the channel.url property. If this URL is not reachable from the Collabora server (e.g. collabora server in an internal network), then set the reachable URL (e.g. https://<jplatform_ip_address>:<port>) in property jcmsplugin.collabora.jplatform-url 

Example :

jcmsplugin.collabora.jplatform-url: https://host.docker.internal:9443/

2.2.2 Open API configuration

• In the JPlatform configuration, activate Open API and add the IP address of the Collabora server into the list of authorized IP addresses (read access, and operations)

2.2.3 JWT configuration

Each time a coedition session is opened, a JWT key is generated and passed to the collabora server so that it can authenticate to JPlatform on behalf of the currently editing user.

JWT configuration must then be correctly set up. To do so:

• activate JWT authentication in properties,
• configure PKI.

For more details, please refer to this documentation.

3. Advanced configuration

3.1 Supported file types

The list of supported applications is defined in property jcmsplugin.collabora.compatible-applications

The list of supported file content types per application type is defined in property jcmsplugin.collabora.application.<application_type>.content-types.

These properties can be overriden, i.e. redeclared in custom.prop (e.g : propose Collabora edition only for LibreOffice documents).

Below the default supported content types

jcmsplugin.collabora.compatible-applications: ms-word ms-excel ms-powerpoint libreoffice

jcmsplugin.collabora.application.ms-word.content-types:\
application/msword \
application/vnd.ms-word.document.12 \
application/vnd.ms-word.document.macroenabled.12 \
application/vnd.openxmlformats-officedocument.wordprocessingml.document \
text/richtext

jcmsplugin.collabora.application.ms-excel.content-types:\
application/vnd.ms-excel \
application/vnd.ms-excel.12 \
application/vnd.ms-excel.sheet.macroenabled.12 \
application/vnd.ms-excel.sheet.binary.macroenabled.12 \
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet \

jcmsplugin.collabora.application.ms-powerpoint.content-types:\
application/vnd.ms-powerpoint \
application/vnd.ms-powerpoint.presentation.macroenabled.12 \
application/vnd.ms-powerpoint.slideshow.macroenabled.12 \
application/vnd.openxmlformats-officedocument.presentationml.slideshow \
application/vnd.openxmlformats-officedocument.presentationml.presentation \
application/vnd.openxmlformats-officedocument.presentationml.slide

jcmsplugin.collabora.application.libreoffice.content-types:\
application/vnd.oasis.opendocument.text \
application/vnd.oasis.opendocument.text-master \
application/vnd.oasis.opendocument.text-web \
application/vnd.oasis.opendocument.spreadsheet \
application/vnd.oasis.opendocument.presentation \
application/vnd.oasis.opendocument.graphics \
application/vnd.oasis.opendocument.chart \
application/vnd.oasis.opendocument.formula \
application/vnd.oasis.opendocument.database \
application/vnd.oasis.opendocument.image

3.2 ACL

It is possible to limit the list of users authorized to coedit a document with Collabora using the ACL below:

3.3 DocumentEditorPolicyFilter

Since JPlatform 10 SP3, it is possible to filter the list of document editors, including Collabora editor, thanks to interfaceDocumentEditorPolicyFilter. 

public class CollaboraEditorPolicyFilter extends AbstractDocumentEditorPolicyFilter {

  @Override
  public List<DocumentEditor> filterEditorList(List<DocumentEditor> editorList, FileDocument doc, Member mbr) {

    if (doc instanceof DBFileDocument) {
      return editorList;
    }

    return editorList.stream()
        .filter(editor -> !(editor instanceof CollaboraDocumentEditor))
        .collect(Collectors.toList());
  }
}