Wiki source code of Connect to an Internal Office Server
Last modified by Eleni Cojocariu on 2026/03/19 08:46
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | Configuring the server internally means that XWiki will manage and start the LibreOffice or OpenOffice server automatically. To configure your wiki to work with an office server ([[LibreOffice>>http://www.libreoffice.org/]] or [[OpenOffice>>http://www.openoffice.org/]]): | ||
| 2 | |||
| 3 | 1. Install [[LibreOffice>>http://www.libreoffice.org/]] or [[OpenOffice>>http://www.openoffice.org/]]. | ||
| 4 | 1. Navigate to the ##xwiki/WEB-INF/## and open the file ##xwiki.properties## with a text editor. | ||
| 5 | 1. Search for the "Settings for the OpenOffice server instance consumed by the OfficeImporter component". The content looks like this:((( | ||
| 6 | {{code language="properties"}} | ||
| 7 | #-# [Since 1.9M2] | ||
| 8 | #-# Type of the openoffice server instance used by officeimporter component. | ||
| 9 | #-# 0 - Internally managed server instance. (Default) | ||
| 10 | #-# 1 - Externally managed (local) server instance. | ||
| 11 | # openoffice.serverType = 0 | ||
| 12 | |||
| 13 | #-# [Since 12.1RC1] | ||
| 14 | #-# Port numbers used for connecting to the openoffice server instance. | ||
| 15 | #-# For an internally managed server instance, it will create the process for all ports. | ||
| 16 | #-# For an externally managed server instance, only the first server port is taken into account. | ||
| 17 | # openoffice.serverPorts = 8100,8101 | ||
| 18 | |||
| 19 | #-# [Since 1.9M2] | ||
| 20 | #-# If the openoffice server should be started / connected upon XE start. | ||
| 21 | #-# Default value is false | ||
| 22 | # openoffice.autoStart = false | ||
| 23 | |||
| 24 | #-# [Since 1.8RC3] | ||
| 25 | #-# Path to openoffice installation (serverType:0 only). | ||
| 26 | #-# If no path is provided, a default value will be calculated based on the operating environment. | ||
| 27 | # openoffice.homePath = /opt/openoffice.org3/ | ||
| 28 | |||
| 29 | #-# [Since 1.8RC3] | ||
| 30 | #-# Path to openoffice execution profile (serverType:0 only). | ||
| 31 | #-# If no path is provided, a default value will be calculated based on the operating environment. | ||
| 32 | # openoffice.profilePath = /home/user/.openoffice.org/3 | ||
| 33 | |||
| 34 | #-# [Since 1.8RC3] | ||
| 35 | #-# Maximum number of simultaneous conversion tasks to be handled by a single openoffice process (serverType:0 only). | ||
| 36 | #-# Default value is 50 | ||
| 37 | # openoffice.maxTasksPerProcess = 50 | ||
| 38 | |||
| 39 | #-# [Since 1.8RC3] | ||
| 40 | #-# Timeout for conversion tasks (in milliseconds) (serverType:0 only). | ||
| 41 | #-# Default value is 60 seconds | ||
| 42 | # openoffice.taskExecutionTimeout = 60000 | ||
| 43 | |||
| 44 | #-# [Since 16.8.0] | ||
| 45 | #-# [Since 16.4.4] | ||
| 46 | #-# [Since 15.10.13] | ||
| 47 | #-# The output image format to use when importing an office presentation in XWiki. | ||
| 48 | # officeimporter.presentation.imageFormat = jpg | ||
| 49 | |||
| 50 | #-# [Since 16.8.0] | ||
| 51 | #-# [Since 16.4.4] | ||
| 52 | #-# [Since 15.10.13] | ||
| 53 | #-# Quality of the output image when importing an office presentation: the quality value is between 0 and 100. | ||
| 54 | #-# Be aware that this option overrides any filter configuration provided in custom-document-formats.json for html | ||
| 55 | #-# presentations. Also this configuration is ignored if the image format is png. | ||
| 56 | # officeimporter.presentation.quality = 95 | ||
| 57 | |||
| 58 | #-# [Since 16.8.0] | ||
| 59 | #-# [Since 16.4.4] | ||
| 60 | #-# [Since 15.10.13] | ||
| 61 | #-# Width of the output image when importing an office presentation: the value is given in pixel. | ||
| 62 | # officeimporter.presentation.slideWidth = 1920 | ||
| 63 | {{/code}} | ||
| 64 | ))) | ||
| 65 | 1. Set ##openoffice.autoStart=true## and uncomment the line by deleting the # at the beginning of the line. | ||
| 66 | 1. Specify the path of the office suite and uncomment the line. The path is similar format to this one for the ##homePath## variable: ##openoffice.homePath=C:\Program Files (x86) | ||
| 67 | LibreOffice 5##. Some default install paths on different operating systems:((( | ||
| 68 | * **Microsoft Windows XP/Vista/7**: | ||
| 69 | |||
| 70 | Example for OpenOffice 3 (32-bit): | ||
| 71 | |||
| 72 | {{code language="none"}} | ||
| 73 | openoffice.profilePath=C:/Users/{user}/AppData/Roaming/openOffice.org/3 | ||
| 74 | openoffice.homePath=C:/Program Files/OpenOffice.org 3 | ||
| 75 | {{/code}} | ||
| 76 | |||
| 77 | Example for LibreOffice 3.4 (32-bit): | ||
| 78 | |||
| 79 | {{code language="none"}} | ||
| 80 | openoffice.profilePath=C:/Users/{user}/AppData/Roaming/LibreOffice/3 | ||
| 81 | openoffice.homePath=C:/Program Files/LibreOffice 3.4 | ||
| 82 | {{/code}} | ||
| 83 | |||
| 84 | Example for OpenOffice 3 (64-bit): | ||
| 85 | |||
| 86 | {{code language="none"}} | ||
| 87 | openoffice.profilePath=C:/Users/{user}/AppData/Roaming/openOffice.org/3 | ||
| 88 | openoffice.homePath=C:/Program Files (x86)/OpenOffice.org 3 | ||
| 89 | {{/code}} | ||
| 90 | |||
| 91 | Example for LibreOffice 3.4 (64-bit): | ||
| 92 | |||
| 93 | {{code language="none"}} | ||
| 94 | openoffice.profilePath=C:/Users/{user}/AppData/Roaming/LibreOffice/3 | ||
| 95 | openoffice.homePath=C:/Program Files (x86)/LibreOffice 3.4 | ||
| 96 | {{/code}} | ||
| 97 | |||
| 98 | * **Linux** | ||
| 99 | ** **Ubuntu Linux (10.04)**:((( | ||
| 100 | {{code language="none"}} | ||
| 101 | openoffice.homePath=/usr/lib/openoffice/ | ||
| 102 | {{/code}} | ||
| 103 | ))) | ||
| 104 | ** **Ubuntu Linux (11.10)**:((( | ||
| 105 | {{code language="none"}} | ||
| 106 | openoffice.homePath=/usr/lib/libreoffice/ | ||
| 107 | {{/code}} | ||
| 108 | ))) | ||
| 109 | * **Fedora**:((( | ||
| 110 | See the [[Guide for Fedora>>extensions:Extension.Office Importer Application Linux]]. | ||
| 111 | ))) | ||
| 112 | * **Mac OSX**:((( | ||
| 113 | Example for LibreOffice: | ||
| 114 | |||
| 115 | {{code language="none"}} | ||
| 116 | openoffice.homePath=/Applications/LibreOffice.app/Contents | ||
| 117 | {{/code}} | ||
| 118 | ))) | ||
| 119 | ))) | ||
| 120 | 1. Save the changes. | ||
| 121 | 1. Restart the server of XWiki. | ||
| 122 | 1. Verify the server is running by going to [[Administer the Wiki>>documentation.xs.admin.base.content-organization.administer-wiki.WebHome]] and then selecting "Content", "Office Server" from the dropdown.((( | ||
| 123 | {{image reference="office-server-internally.png" size="large" alt="The Office Importer admin UI"/}} | ||
| 124 | ))) | ||
| 125 | 1. Once the OpenOffice server is running and connected, you can use the Office Importer to [[Import Office Documents into Wiki Pages>>documentation.xs.user.base.page.create-page.import-office-documents.WebHome]], convert office documents (e.g., .docx, .xlsx) to XWiki format, and to [[export Pages in ODT or RTF formats>>documentation.xs.user.exports.export-page.export-odt-rtf.WebHome]]. |
