Wiki source code of Office Server Properties
Last modified by Eleni Cojocariu-testing account on 2026/08/21 17:04
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | The office server that converts documents for the [[Office Importer>>extensions:Extension.Office Importer Application.WebHome]] and produces the [[ODT and RTF exports>>documentation.xs.user.exports.export-page.export-odt-rtf.WebHome]] is configured in ##xwiki/WEB-INF/xwiki.properties##, in the section "Settings for the OpenOffice server instance consumed by the OfficeImporter component". Every property there ships commented out, showing its default value, so a property only takes effect once its line is uncommented. The ##openoffice.## prefix is historical: the same properties configure a LibreOffice installation. | ||
| 2 | |||
| 3 | |=Property|=Default|=Description | ||
| 4 | |##openoffice.serverType##|##0##|##0## for a server XWiki starts and stops itself, see [[Connect to an Internal Office Server>>documentation.xs.admin.exports.office-server-properties.connect-internal-office-server.WebHome]]. ##1## for a server you start yourself, see [[Connect to an External Office Server>>documentation.xs.admin.exports.office-server-properties.connect-external-office-server.WebHome]]. Any other value leaves the office server unusable, reporting the state "Invalid Configuration". | ||
| 5 | |##openoffice.serverPorts##|##8100,8101##|The ports used to reach the office server. An internally managed server starts one office process per port; an externally managed one is only reached on the first port of the list. | ||
| 6 | |##openoffice.autoStart##|##false##|##true## to have XWiki start, or connect to, the office server when it starts up, instead of leaving that to the "Office Server" administration section. | ||
| 7 | |##openoffice.homePath##|the installation XWiki detects|The directory the office suite is installed in. Set it to the installation directory itself, not to its ##program## subdirectory. Used by an internally managed server only. | ||
| 8 | |##openoffice.profilePath##|the profile the office suite computes|The office user profile directory the server runs with. Used by an internally managed server only. | ||
| 9 | |##openoffice.maxTasksPerProcess##|##50##|The number of conversions one office process handles before it is recycled. Used by an internally managed server only. | ||
| 10 | |##openoffice.taskExecutionTimeout##|##60000##|The time, in milliseconds, a single conversion may take before it is abandoned. Used by an internally managed server only. | ||
| 11 | |##officeimporter.presentation.imageFormat##|##jpg##|The image format the slides of an imported presentation are converted to. | ||
| 12 | |##officeimporter.presentation.quality##|##95##|The quality of those images, from ##0## to ##100##. It overrides any filter configured for HTML presentations in ##custom-document-formats.json##, and it is ignored when the image format is ##png##. | ||
| 13 | |##officeimporter.presentation.slideWidth##|##1920##|The width, in pixels, of those images. | ||
| 14 | |||
| 15 | When ##openoffice.homePath## is left unset, XWiki reads the ##XWIKI_OFFICE_HOME## environment variable, and falls back to detecting the installation itself. | ||
| 16 | |||
| 17 | {{id name="office-paths"/}} | ||
| 18 | |||
| 19 | == Typical Office Installation Directories == | ||
| 20 | |||
| 21 | |=Operating system|=##openoffice.homePath##|=##openoffice.profilePath## | ||
| 22 | |Linux|##/usr/lib/libreoffice##|##/home/{user}/.config/libreoffice/4## | ||
| 23 | |Microsoft Windows|##C:/Program Files/LibreOffice##|##C:/Users/{user}/AppData/Roaming/LibreOffice/4## | ||
| 24 | |macOS|##/Applications/LibreOffice.app/Contents##|##/Users/{user}/Library/Application Support/LibreOffice/4## | ||
| 25 | |||
| 26 | On Fedora, see the [[Office Importer installation notes>>extensions:Extension.Office Importer Application Linux]]. |
