ONLYOFFICE Connector for Confluence

This plugin enables users to edit office documents from Confluence using ONLYOFFICE Document Server. 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 action within the document library for Office documents. This allows multiple users to collaborate in real time and to save back those changes to Confluence.

Installing ONLYOFFICE Document Server

You will need an instance of ONLYOFFICE Document Server that is resolvable and connectable both from Confluence 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 Confluence directly.

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

Getting ONLYOFFICE Connector for Confluence from Atlassian Marketplace

You can download the latest connector version from the official Atlassian Marketplace. This is done the following way:

  • Log into your Confluence instance as an administrator.
  • Click the admin drop-down box and choose Add-ons. The Manage add-ons screen will load.
  • Click Find new add-ons from the left-hand side of the page.
  • Locate ONLYOFFICE Connector for Confluence via search. Results will include the add-on versions compatible with your Confluence instance.
  • Click Install to download and install your add-on.
  • Now you can click Close in the Installed and ready to go dialog.

Compiling and installing ONLYOFFICE Connector for Confluence

If for some reason you want to compile ONLYOFFICE Connector for Confluence, then to start using ONLYOFFICE Document Server with Confluence, the following steps must be performed:

  • 1.8.X of the Oracle Java SE Development Kit 8,
  • Atlassian Plugin SDK (official instructions),
  • Compile package: atlas-package

Upload the compiled target/onlyoffice-confluence-plugin-*.jar to Confluence on the Manage add-ons page.

The latest compiled package files are available here.

Configuring ONLYOFFICE Connector for Confluence

Find the uploaded ONLYOFFICE Connector for Confluence on the Manage add-ons page. Click Configure and enter the name of the server with the ONLYOFFICE Document Server installed:

https://documentserver/

User navigates to a Confluence attachments and selects the Edit in ONLYOFFICE action.

Confluence makes a request to OnlyOfficeEditorServlet (URL of the form: /plugins/servlet/onlyoffice/doceditor?attachmentId=$attachment.id).

Confluence sends document to ONLYOFFICE Document storage service and receive a temporary link.

Confluence prepares a JSON object with the following properties:

  • fileUrl - the temporary link that ONLYOFFICE Document Server uses to download the document;
  • callbackUrl - the URL that ONLYOFFICE Document Server informs about status of the document editing;
  • docserviceApiUrl - the URL that the client needs to reply to ONLYOFFICE Document Server (provided by the files.docservice.url.api property);
  • key - the UUID to instruct ONLYOFFICE Document Server whether to download the document again or not;
  • fileName - the document Title (name).

Confluence 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 Confluence and the user begins editing.

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

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


Download the ONLYOFFICE Connector for Confluence here.