Revision as of 16:30, 24 June 2016 by Stx12 (talk | contribs)


This is the Open-Xchange implementation of the Document Converter API. While the API is open, the implementation is not licensed under GPL. It maintains the running instances of readerengines, which are headless OpenOffice instances. This behavior can be configured through configuration file. The Document Converter is only available via a valid Open-Xchange license key.

See Readerengine installation instructions for details on the setup of the underlying readerengine.

For a more detailed guide explaining different installation variants visit the Installation Guide

This information is valid from 7.8.2

Update Documentconverter from earlier versions to 7.8.2

For a successful update to 7.8.2 some manual adjustments are necessary on the middleware node(s) as well as on the documentconverter node(s) after the package upgrade. For a single node deployment both sections have to be adhered to.

Further details are available from the Installation Guide.

OX Documentconverter Service

After an upgrade the new package open-xchange-documentconverter-server replaces open-xchange-documentconverter-webservice. If open-xchange-documentconverter-server is not automatically installed (e.g. in a single node deployment) it has to be be added manually.

Changes to the configuration file need to be applied to the new one. For versions up to (including) 7.8.1 it was located at


Starting with 7.8.2 it's new home is


Note: If the file is moved from the old to the new location with all items the path settings in 'com.openexchange.documentconverter.blacklistFile' and 'com.openexchange.documentconverter.whitelistFile' have to be changed.

Futhermore logging needs to be configured separately from the middleware setting. A logback.xml file dedicated to the document converter process can be found at


Most notable changes are the listening ports (http 8008, https 8011 and JMX 9998) which have to be different from those reserved for the middleware. Apache and monitoring configurations have to be adapted accordingly.

Note: Don't forget to enable / (re)start open-xchange-documentconverter-server.service in addition to the OX App Suite middleware.

OX App Suite Middleware (aka Backend or Documentconverter Client)

The property pointing to the documentconverter service has to be adjusted. It is now mandatory to set this entry – not only in the remote documentconverter setup but also if the documentconverter runs locally. The property used changed from



/opt/open-xchange/etc/ com.openexchange.documentconverter.client.remoteDocumentConverterUrl=

For a single-node deployment this reads (in one line)

com.openexchange.documentconverter.client.remoteDocumentConverterUrl = http://localhost:8008/documentconverterws

Note: If the logging configuration has been changed for documentconverter entries the logger needs a small change. The new class is name="com.openexchange.documentconverter"

The Document Converter is installed according to the following instructions.

Install on OX App Suite

Debian GNU/Linux 10.0

Add the following entry to /etc/apt/sources.list.d/open-xchange.list if not already present:

deb /

and run

$ apt-get update
$ apt-get install open-xchange-documentconverter

Debian GNU/Linux 11.0

Add the following entry to /etc/apt/sources.list.d/open-xchange.list if not already present:

deb /

and run

$ apt-get update
$ apt-get install open-xchange-documentconverter