Last modified by Thomas Mortagne on 2025/02/14

Hide last authors
Guillaume Fenollar 11.1 1 {{box cssClass="floatinginfobox" title="**Contents**"}}
Jan-Paul Kleijn 221.1 2 {{toc start="2"/}}
Guillaume Fenollar 11.1 3 {{/box}}
4
Thomas Mortagne 225.1 5 This distribution allows installing XWiki and every component needed for a production instance automatically.
6
7 This method works for all Debian-based linux distribution. Feel free to use [[the User Forum>>dev:Community.Discuss]] to report issues, or discuss about it.
8
Thomas Mortagne 247.1 9 {{warning}}
10 Before XWiki 17, a critical dependency of the XWiki Tomcat Debian packages was **tomcat9**. Unfortunately Debian decided to remove the ##tomcat9## package to keep only ##tomcat10## starting with Debian 12 (bookworm) and Ubuntu 24.04. The current alternatives are:
Simon Urli 244.1 11
Thomas Mortagne 238.1 12 * use the xjetty based packages instead
Thomas Mortagne 247.1 13 * upgrade to XWiki 17+
Thomas Mortagne 238.1 14 * use an [[alternative non Debian specific install method>>xwiki:Documentation.AdminGuide.Installation||anchor="HInstallationMethods"]].
Thomas Mortagne 247.1 15 {{/warning}}
Thomas Mortagne 223.2 16
Jan-Paul Kleijn 217.2 17 == APT Configuration ==
Guillaume Fenollar 1.1 18
Thomas Mortagne 196.3 19 First, you have to configure your package manager in order to use XWiki's repository. This can be done simply, using this command:
Guillaume Fenollar 1.1 20
Thomas Mortagne 18.1 21 {{code language="bash"}}
Thomas Mortagne 209.1 22 sudo wget https://maven.xwiki.org/xwiki-keyring.gpg -O /usr/share/keyrings/xwiki-keyring.gpg
23 sudo wget "https://maven.xwiki.org/stable/xwiki-stable.list" -O /etc/apt/sources.list.d/xwiki-stable.list
Guillaume Fenollar 1.1 24 {{/code}}
25
Thomas Mortagne 44.1 26 {{info}}
Thomas Mortagne 250.1 27 Note that there are several repositories you can choose (as alternatives to the stable one you have in the previous example):
Thomas Mortagne 112.1 28
Jean-Sébastien Dennebouy 198.1 29 * [[https:~~/~~/maven.xwiki.org/releases/xwiki-releases.list>>https://maven.xwiki.org/releases/xwiki-releases.list]]: all released versions including milestones and release candidates (beta)
30 * [[https:~~/~~/maven.xwiki.org/stable/xwiki-stable.list>>https://maven.xwiki.org/stable/xwiki-stable.list]]: all released versions excluding milestones and release candidates (stable)
31 * [[https:~~/~~/maven.xwiki.org/lts/xwiki-lts.list>>https://maven.xwiki.org/lts/xwiki-lts.list]]: the current "long term support" branch versions as defined in [[Support page>>xwiki:Main.Support]]
Thomas Mortagne 44.1 32 {{/info}}
33
Guillaume Fenollar 1.1 34 Now you can update the packages database to read the data from this repository.
35
Thomas Mortagne 18.1 36 {{code language="bash"}}
37 sudo apt-get update
38 {{/code}}
39
Guillaume Fenollar 1.1 40 Now you can make a little search to see what this repo offers.
41
Thomas Mortagne 18.1 42 {{code language="bash"}}
Guillaume Fenollar 1.1 43 apt-cache search xwiki
44 {{/code}}
45
Thomas Mortagne 227.2 46 * Common packages not tied to any application server or database
47 ** ##xwiki-common## - XWiki, you can install this if you want to take care yourself of the database and application server
48 ** ##xwiki-mariadb-common## - XWiki MariaDB common package, you can install this if you want to take care yourself of the application server
49 ** ##xwiki-mysql-common## - XWiki MySQL common package, you can install this if you want to take care yourself of the application server
50 ** ##xwiki-pgsql-common## - XWiki PostgreSQL common package, you can install this if you want to take care yourself of the application server
Guillaume Fenollar 2.1 51
Thomas Mortagne 249.1 52 * Packages based on a customized Jetty packaged for XWiki
Thomas Mortagne 227.2 53 ** ##xwiki-xjetty-common## - XWiki Jetty common package, you can install this if you want to take care yourself of the database link
54 ** ##xwiki-xjetty-mariadb## - XWiki Jetty/MariaDB based package
55 ** ##xwiki-xjetty-mysql## - XWiki Jetty/MySQL based package
56 ** ##xwiki-xjetty-pgsql## - XWiki Jetty/PostgreSQL
Thomas Mortagne 103.1 57
Thomas Mortagne 230.1 58 * Packages based on the standard Tomcat package
Thomas Mortagne 227.2 59 ** ##xwiki-tomcat9-common## - XWiki Tomcat 9 common package, you can install this if you want to take care yourself of the database link
Thomas Mortagne 247.1 60 ** ##xwiki-tomcat10-common## - XWiki Tomcat 10 common package, you can install this if you want to take care yourself of the database link
Thomas Mortagne 227.2 61 ** ##xwiki-tomcat9-mariadb## - XWiki Tomcat 9/MariaDB based package
Thomas Mortagne 247.1 62 ** ##xwiki-tomcat10-mariadb## - XWiki Tomcat 10/MariaDB based package
Thomas Mortagne 227.2 63 ** ##xwiki-tomcat9-mysql## - XWiki Tomcat 9/MySQL based package
Thomas Mortagne 247.1 64 ** ##xwiki-tomcat10-mysql## - XWiki Tomcat 10/MySQL based package
Thomas Mortagne 227.2 65 ** ##xwiki-tomcat9-pgsql## - XWiki Tomcat 9/PostgreSQL
Thomas Mortagne 247.1 66 ** ##xwiki-tomcat10-pgsql## - XWiki Tomcat 10/PostgreSQL
Thomas Mortagne 103.1 67
Thomas Mortagne 234.1 68 * Not really XWiki itself but Solr cores needed when you want to use a standalone Solr instance with XWiki
69 ** ##xwiki-solr9-all## - An entry point package with dependencies on all the Solr 9 cores required to setup a standalone version compatible with XWiki Standard
70 ** ##xwiki-solr9-search## - A pre configured Solr 9 core for the XWiki search feature
71 ** ##xwiki-solr9-events## - A pre configured Solr 9 core for the XWiki events/notifications storage
72 ** ##xwiki-solr9-ratings## - A pre configured Solr 9 core for the XWiki rating storage
73 ** ##xwiki-solr9-extension_index## - A pre configured Solr 9 core for the XWiki extensions index
Thomas Mortagne 227.2 74
75 Plus legacy packages from older versions of XWiki like ##xwiki-enterprise-*## packages or for unsupported versions of Tomcat.
76
Valdis Vitolins 42.1 77 {{info}}
78 According to selection, package manager will install all necessary dependencies (application server, database, Java runtime). If you haven't installed these packages before, package manager can ask additional info from you.
79 {{/info}}
Valdis Vitolins 41.1 80
Thomas Mortagne 134.1 81 {{warning}}
82 On Ubuntu you will need [[##universe## repository>>https://help.ubuntu.com/community/Repositories/CommandLine]] to install Tomcat packages. It's generally enabled by default.
83 {{/warning}}
84
Jan-Paul Kleijn 217.2 85 == Complete Installation ==
Guillaume Fenollar 1.1 86
Thomas Mortagne 64.1 87 {{warning}}
Thomas Mortagne 252.3 88 Most Debian distributions provide a Tomcat package with a pretty low Memory setting by default (128MB) and this need to be increased for XWiki to fully work. See [[Tomcat Memory section>>||anchor="HMemory"]] for more details.
Thomas Mortagne 64.1 89 {{/warning}}
90
Jan-Paul Kleijn 217.2 91 === Using MariaDB ===
Guillaume Fenollar 1.1 92
Thomas Mortagne 188.1 93 {{warning}}
Thomas Mortagne 227.2 94 Note that XWiki requires at least MariaDB 10.2.
Thomas Mortagne 188.1 95 {{/warning}}
Thomas Mortagne 185.1 96
Thomas Mortagne 227.2 97 Xjetty:
Guillaume Fenollar 1.2 98
Thomas Mortagne 18.1 99 {{code language="bash"}}
Thomas Mortagne 232.1 100 sudo apt install xwiki-xjetty-mariadb
Thomas Mortagne 227.2 101 {{/code}}
102
Thomas Mortagne 248.1 103 Tomcat 10:
104
105 {{code language="bash"}}
106 sudo apt install xwiki-tomcat10-mariadb
107 {{/code}}
108
Thomas Mortagne 247.1 109 Tomcat 9:
Thomas Mortagne 227.2 110
111 {{code language="bash"}}
Thomas Mortagne 232.1 112 sudo apt install xwiki-tomcat9-mariadb
Thomas Mortagne 18.1 113 {{/code}}
114
Jan-Paul Kleijn 216.1 115 During the installation you may get some questions from DBconfig, which is in charge of the configuration of XWiki with the MariaDB database. Don't confuse it with the MariaDB root password prompt that asks you for a root password (which is intented for the superuser). If you haven't already installed any MariaDB databases and you are not familiar with it you should let DBconfig handle this.
Guillaume Fenollar 3.1 116
Simon Urli 217.1 117 Afterwards DBconfig asks you for the MariaDB root password for the "xwiki" MariaDB user. This user will be used to connect to MariaDB from the XWiki application. You should choose the password wisely but you don't have to pay a lot of attention to it after that because DBconfig internally configures XWiki to start up with these credentials.
Guillaume Fenollar 1.2 118
Simon Urli 217.1 119 {{warning}}
120 The password should not contain any special characters, otherwise XWiki will fail to start. See [[https:~~/~~/jira.xwiki.org/browse/XWIKI-14406>>https://jira.xwiki.org/browse/XWIKI-14406]]
121 {{/warning}}
122
Thomas Mortagne 227.2 123 The installation ends with the start of the XWiki or Tomcat daemon which is also setup to start automatically from boot.
Guillaume Fenollar 2.1 124
Jan-Paul Kleijn 217.2 125 === Using MySQL ===
Thomas Mortagne 169.1 126
Thomas Mortagne 187.1 127 {{warning}}
Thomas Mortagne 247.1 128 Note that XWiki requires at least MySQL 5.7. It's not recommended to use this package if your "MySQL" server is in fact MariaDB, see [[the MariaDB section>>||anchor="#HUsingMariaDB"]].
Thomas Mortagne 187.1 129 {{/warning}}
Thomas Mortagne 186.1 130
Thomas Mortagne 227.2 131 Xjetty:
Thomas Mortagne 169.1 132
133 {{code language="bash"}}
Thomas Mortagne 232.1 134 sudo apt install xwiki-xjetty-mysql
Thomas Mortagne 169.1 135 {{/code}}
136
Thomas Mortagne 248.1 137 Tomcat 10:
138
139 {{code language="bash"}}
140 sudo apt install xwiki-tomcat10-mysql
141 {{/code}}
142
Thomas Mortagne 247.1 143 Tomcat 9:
Thomas Mortagne 169.1 144
Thomas Mortagne 227.2 145 {{code language="bash"}}
Thomas Mortagne 232.1 146 sudo apt install xwiki-tomcat9-mysql
Thomas Mortagne 227.2 147 {{/code}}
Thomas Mortagne 169.1 148
Thomas Mortagne 227.12 149 Everything else is similar to what is described in the [[the MariaDB section>>||anchor="#HUsingMariaDB"]].
Thomas Mortagne 169.1 150
Jan-Paul Kleijn 217.2 151 === Using PostgreSQL ===
Guillaume Fenollar 4.1 152
Manuel Smeria 25.3 153 It's as simple as the MySQL installation, you only need to choose the right virtual package.
Guillaume Fenollar 4.1 154
Thomas Mortagne 227.2 155 Xjetty:
156
Thomas Mortagne 18.1 157 {{code language="bash"}}
Thomas Mortagne 232.1 158 sudo apt install xwiki-xjetty-pgsql
Thomas Mortagne 227.2 159 {{/code}}
160
Thomas Mortagne 248.1 161 Tomcat 10:
162
163 {{code language="bash"}}
164 sudo apt install xwiki-tomcat10-pgsql
165 {{/code}}
166
Thomas Mortagne 247.1 167 Tomcat 9:
Thomas Mortagne 227.2 168
169 {{code language="bash"}}
Thomas Mortagne 232.1 170 sudo apt install xwiki-tomcat9-pgsql
Thomas Mortagne 18.1 171 {{/code}}
172
Thomas Mortagne 227.12 173 Everything else is similar to what is described in the [[the MariaDB section>>||anchor="#HUsingMariaDB"]].
Jan-Paul Kleijn 212.2 174
Jan-Paul Kleijn 217.2 175 === Starting up XWiki for the first time... ===
Jan-Paul Kleijn 212.2 176
Jan-Paul Kleijn 212.3 177 After you've made sure to update the memory settings (see below), you can now point your favorite browser to the following URL to use your wiki: ##[[http:~~/~~/localhost:8080/xwiki>>http://localhost:8080/xwiki]]##
Guillaume Fenollar 13.1 178
Jan-Paul Kleijn 216.1 179 {{warning}}
180 Note that your wiki is absolutely empty, like a WAR installation. Distribution Wizard will take care of the rest.
181 {{/warning}}
182
Jan-Paul Kleijn 217.2 183 == Performance ==
Guillaume Fenollar 11.1 184
Thomas Mortagne 227.13 185 === XWiki ===
186
187 You can find various [[various generic advices and troubleshooting related to XWiki>>Documentation.AdminGuide.Performances]].
188
Jan-Paul Kleijn 217.2 189 === Tomcat ===
190
Vincent Massol 167.2 191 You can find [[various generic advices and troubleshooting related to Tomcat>>Documentation.AdminGuide.Installation.InstallationWAR.InstallationTomcat.WebHome]].
Thomas Mortagne 142.1 192
Thomas Mortagne 227.13 193 ==== Java Version ====
Thomas Mortagne 78.1 194
Thomas Mortagne 227.1 195 Make sure Tomcat is executed with the right [[Java version>>Documentation.AdminGuide.Installation||anchor="HHardwareandSoftwarerequirements"]].
Thomas Mortagne 78.1 196
Thomas Mortagne 251.1 197 This is usually indicated in the file ##/etc/default/tomcat10## (or ##/etc/default/tomcat9## for Tomcat 9, etc).
Thomas Mortagne 78.1 198
Thomas Mortagne 227.13 199 ==== Memory ====
Thomas Mortagne 78.1 200
Vincent Massol 119.2 201 The default Tomcat memory setup is too low for XWiki's needs.
Guillaume Fenollar 11.1 202
Thomas Mortagne 251.1 203 You can change it in the file ##/etc/default/tomcat10## (or ##/etc/default/tomcat9## for Tomcat 10, etc).
Guillaume Fenollar 11.1 204
Thomas Mortagne 71.1 205 Modify the property ##JAVA_OPTS##. For example:
Thomas Mortagne 18.1 206
Thomas Steinbach 25.1 207 {{code language="none"}}
Thomas Mortagne 94.1 208 JAVA_OPTS="-Djava.awt.headless=true -Xmx1024m"
Thomas Steinbach 25.1 209 {{/code}}
Thomas Mortagne 18.1 210
Thomas Mortagne 194.1 211 You should [[check the Memory settings we recommend>>Documentation.AdminGuide.Performances||anchor="HMemory"]].
Guillaume Fenollar 11.1 212
Jan-Paul Kleijn 217.2 213 == Concluding Step ==
Thomas Mortagne 50.1 214
Vincent Massol 114.2 215 {{include reference="Documentation.AdminGuide.Installation.InstallationConcludingSteps.WebHome"/}}
Thomas Mortagne 50.1 216
Thomas Mortagne 250.2 217 == Upgrading ==
218
Thomas Mortagne 252.1 219 === Update the packages index ===
Thomas Mortagne 250.2 220
Thomas Mortagne 250.3 221 {{code language="bash"}}
222 sudo apt update
223 {{/code}}
224
Thomas Mortagne 252.1 225 === Upgrade the packages ===
Thomas Mortagne 250.3 226
227 {{code language="bash"}}
228 sudo apt upgrade
229 {{/code}}
230
231 This will upgrade all packages, not just XWiki. If you want to avoid all the other packages and only update XWiki, you can use {{code}}sudo apt install xwiki-tomcat9-mariadb{{/code}} (change ##xwiki-tomcat9-mariadb## for the top level package you installed if you installed something else).
232
Thomas Mortagne 250.10 233 {{warning}}
Thomas Mortagne 250.3 234 Sometimes (especially in case of new cycle), apt upgrade might report that it refuse to upgrade some xwiki packages.
235
236 This is generally the sign that either:
Thomas Mortagne 250.12 237 * A new dependency cannot be found: it generally means that XWiki starts requiring a more recent version of Java and the Debian repository you have don't have any implementation of this Java versions. See [[No package can be found for Java>>Documentation.AdminGuide.Installation.InstallationViaAPT||anchor="HNopackagecanbefoundforJava"]] for more details on how to resolve this situation.
238 * Some xwiki package name changed: this generally happen when XWiki stops supporting some version of Tomcat and you need to install a different ##xwiki-tomcat*## package (for example XWiki 17 does not support tomcat9 anymore and requires the ##tomcat10## package so xwiki packages for this version have been renamed to ##xwiki-tomcat10-mariadb## for example, if you used ##mariadb##).
Thomas Mortagne 250.10 239 {{/warning}}
Thomas Mortagne 250.3 240
Thomas Mortagne 252.1 241 === Upgrade the pages ===
Thomas Mortagne 250.3 242
Thomas Mortagne 250.7 243 Like in the case of the install, you still have to go through the Distribution Wizard. See more details on [[Upgrading the flavor>>Documentation.AdminGuide.Upgrade||anchor="HPart2Upgradingtheflavor"]].
Thomas Mortagne 250.3 244
Jan-Paul Kleijn 217.2 245 == Uninstallation ==
Guillaume Fenollar 4.1 246
Thomas Mortagne 242.1 247 If you want to remove XWiki from your system, you only have to uninstall the packages you've installed at the beginning of this documentation. For example:
Guillaume Fenollar 10.1 248
Thomas Mortagne 27.1 249 {{code language="bash"}}
Thomas Mortagne 103.1 250 sudo apt-get --purge remove xwiki-common
Thomas Mortagne 27.1 251 {{/code}}
252
Thomas Mortagne 95.1 253 Attention, these commands do not remove MySQL/PostgreSQL nor Tomcat from your system. To do so, if you don't use these applications for another purpose, you can make some cleaning with
Thomas Mortagne 27.1 254
Manuel Smeria 25.3 255 {{code language="bash"}}
Thomas Mortagne 96.1 256 sudo apt-get --purge autoremove
Manuel Smeria 25.3 257 {{/code}}
Guillaume Fenollar 10.1 258
Jan-Paul Kleijn 219.1 259 == Troubleshooting ==
Thomas Mortagne 77.1 260
Jan-Paul Kleijn 220.1 261 === Log file location ===
Jan-Paul Kleijn 217.2 262
Thomas Mortagne 227.13 263 This installation manual should guide you all the way to a fresh and clean XWiki platform. If on the other hand issues may arise, it is important to inspect the XWiki log file for any WARNING messages that may have been brought up. Below you can find the location of this log file for the respective application servers.
Jan-Paul Kleijn 217.2 264
Thomas Mortagne 227.13 265 ==== XJetty ====
Jan-Paul Kleijn 217.2 266
267 {{code language="none"}}
Thomas Mortagne 227.13 268 /var/log/xwiki/[date].jetty.log
269 {{/code}}
270
Thomas Mortagne 252.1 271 ==== Tomcat ====
Thomas Mortagne 227.13 272
Thomas Mortagne 252.1 273 There are several possibilities depending on the distribution and Tomcat version:
Jan-Paul Kleijn 217.2 274
275 {{code language="none"}}
Thomas Mortagne 252.1 276 /var/log/tomcat10/catalina.out
277 /var/log/tomcat10/catalina.[date].log
Thomas Mortagne 241.1 278 /var/log/tomcat9/catalina.out
Jan-Paul Kleijn 217.2 279 /var/log/tomcat9/Catalina.[date].log
280 {{/code}}
281
Thomas Mortagne 162.1 282 You can find a generic Troubleshooting section on [[https://www.xwiki.org/xwiki/bin/view/Documentation/AdminGuide/Installation/#HTroubleshooting]].
283
Jan-Paul Kleijn 217.2 284 === No package can be found for Java ===
Thomas Mortagne 196.3 285
Thomas Mortagne 252.1 286 XWiki require at least Java 17 since XWiki 16.0.
Thomas Mortagne 196.3 287
Thomas Mortagne 211.1 288 If your Debian based distribution does not provide any package for the Java version you need you can try with:
Thomas Mortagne 196.3 289
Thomas Mortagne 227.13 290 * Adoptium provides a Debian repository to install Temurin (OpenJDK), see https://adoptium.net/installation/linux/#_deb_installation_on_debian_or_ubuntu
Thomas Mortagne 196.3 291
Jan-Paul Kleijn 217.2 292 === Tomcat ===
Thomas Mortagne 128.1 293
Thomas Mortagne 196.1 294 See [[Tomcat Installation>>Documentation.AdminGuide.Installation.InstallationWAR.InstallationTomcat||anchor="HTroubleshooting"]] for generic Tomcat related issues.
Thomas Mortagne 162.1 295
Jan-Paul Kleijn 217.2 296 === MySQL ===
Thomas Mortagne 77.1 297
Thomas Mortagne 195.1 298 See [[MySQL Installation>>Documentation.AdminGuide.Installation.InstallationWAR.InstallationMySQL||anchor="HTroubleshooting"]] for generic MySQL related issues.
Thomas Mortagne 77.1 299
Jan-Paul Kleijn 217.2 300 === PostgreSQL ===
Thomas Mortagne 77.1 301
Thomas Mortagne 193.1 302 See [[PostgreSQL Installation>>Documentation.AdminGuide.Installation.InstallationWAR.InstallationPostgreSQL||anchor="HTroubleshooting"]] for generic PostgreSQL related issues.
Thomas Mortagne 77.1 303
Jan-Paul Kleijn 217.2 304 == Other useful info ==
Thomas Mortagne 77.1 305
Jan-Paul Kleijn 217.2 306 === XWiki as root webapp (short URLs) ===
Thomas Mortagne 77.1 307
Jan-Paul Kleijn 221.3 308 Note that this section is only the part of Short URL specific to the Debian setup. To fully configure the URL to your liking, see [[full documentation on short URLs>>doc:Documentation.AdminGuide.ShortURLs.WebHome]].
Vincent Massol 200.2 309
Jan-Paul Kleijn 217.2 310 ==== For Tomcat 9 ====
Vincent Massol 200.2 311
Thomas Mortagne 77.1 312 {{warning}}
Thomas Mortagne 167.1 313 When doing it make sure to check after upgrade if all is OK in /etc/tomcat9/Catalina/localhost folder (xwiki.xml might be restored).
Thomas Mortagne 77.1 314 {{/warning}}
315
Thomas Mortagne 167.1 316 * Rename file ##/etc/tomcat9/Catalina/localhost/xwiki.xml## into ##/etc/tomcat9/Catalina/localhost/ROOT.xml##
317 * Edit file ##/etc/xwiki/xwiki-tomcat9.xml## and modify ##Context## XML element path from ##/xwiki## to ##/## as in moving from(((
Jan-Paul Kleijn 223.1 318 {{code language="xml"}}
Thomas Mortagne 167.1 319 <Context path="/xwiki" docBase="/usr/lib/xwiki"
320 containerSciFilter="org.apache.tomcat.websocket.server.WsSci|org.apache.jasper.servlet.JasperInitializer">
Thomas Mortagne 77.1 321 {{/code}}
322
323 to
324
325 {{code language="xml"}}
Vincent Massol 212.1 326 <Context path="" docBase="/usr/lib/xwiki"
Thomas Mortagne 167.1 327 containerSciFilter="org.apache.tomcat.websocket.server.WsSci|org.apache.jasper.servlet.JasperInitializer">
Thomas Mortagne 77.1 328 {{/code}}
329 )))
330 * Edit file ##/etc/xwiki/xwiki.cfg## and uncomment {{code language="properties"}}xwiki.webapppath={{/code}}
Jan-Paul Kleijn 221.2 331 * Restart Tomcat 9.
Thomas Mortagne 77.1 332
promasu 245.1 333 ==== For Jetty ====
334
335 {{version since="16.7.0"}}
336 You have to modify the ##xjetty-web.xml## file
337
338 The WebAppContext from the xwiki-jetty configuration has to be modified so that Jetty actually serves the XWiki application from the root-path. For this you have to modify the ##/etc/xwiki/xjetty-web.xml## and add the following directive.
339
340 {{code language="xml"}}
341 <Set name="contextPath">/</Set>
342 {{/code}}
343 {{/version}}
344
Jan-Paul Kleijn 217.2 345 === Integrate with LibreOffice ===
Thomas Mortagne 77.1 346
Thomas Mortagne 97.1 347 Install libreoffice with {{code language="none"}}sudo apt-get install libreoffice{{/code}}.
Thomas Mortagne 77.1 348
349 And setup XWiki to automatically start and access libreoffice in ##/etc/xwiki/xwiki.properties##:
350
351 {{code language="properties"}}
352 openoffice.autoStart=true
353 openoffice.homePath=/usr/lib/libreoffice/
354 {{/code}}
355
356 See [[Office Importer Application>>extensions:Extension.Office Importer Application]] for more details.
357
Jan-Paul Kleijn 217.2 358 === Standalone Solr setup ===
Thomas Mortagne 159.1 359
Thomas Mortagne 240.1 360 Take a look at [[Solr documentation>>https://solr.apache.org/guide/solr/latest/deployment-guide/taking-solr-to-production.html]] to install Solr itself.
Thomas Mortagne 159.1 361
Thomas Mortagne 240.1 362 Then you will need to add the XWiki schema configuration: you should install the package ##xwiki-solr-all## for Solr 8 or {{version since="XWiki 16.2.0"}}##xwiki-solr9-all## for Solr 9{{/version}} to automatically register the Solr cores needed by XWiki Standard in the Solr server (provided the standard Solr setup was used).
Thomas Mortagne 159.1 363
Thomas Mortagne 243.1 364 === Access a file from XWiki ===
365
366 SystemD is configured to prevent XWiki from accessing an arbitrary file on the file system, even if the system user which runs XWiki would normally be allowed to access it. You can control this in the file ##/etc/systemd/system/tomcat9.service.d/xwiki-tomcat9-systemd.conf## when using ##xwiki-tomcat9-common## and ##/lib/systemd/system/xwiki.service## when using ##xwiki-xjetty-common## and by the default XWiki is allowed and write ##/var/lib/xwiki/data##. Note that once you modified one of those files, you will need to execute ##sudo systemctl daemon-reload## and restart the service.
367
Jan-Paul Kleijn 217.2 368 == Overview of the important files ==
Guillaume Fenollar 4.1 369
Manuel Smeria 25.3 370 Here is a list of a different tree. The point is to help you find useful files easily. This list is showing a few files and directories, to keep it simple and clear. The '->' is used to show a link to another file/directory.
Guillaume Fenollar 4.1 371
Jan-Paul Kleijn 217.2 372 === XWiki ===
Guillaume Fenollar 4.1 373
Thomas Mortagne 152.1 374 The configuration: **/etc/xwiki/**
Guillaume Fenollar 4.1 375
Thomas Mortagne 156.1 376 * hibernate.cfg.xml //Hibernate configuration, helping to configure the database resources//
Thomas Mortagne 152.1 377 * xwiki.cfg
Thomas Mortagne 98.1 378 * xwiki.properties
Thomas Mortagne 184.1 379 * xwiki-tomcat9-systemd.conf // Injected trough ##/etc/systemd/system/tomcat9.service.d/xwiki-tomcat-systemd.conf##// in the tomcat9 service configuration
380 * xwiki-tomcat<version> // The Tomcat integration linked from ##/etc/tomcat<version>/Catalina/localhost##//
Thomas Mortagne 98.1 381
Thomas Mortagne 153.1 382 The permanent directory: **/var/lib/xwiki/data**
Guillaume Fenollar 4.1 383
Thomas Mortagne 153.1 384 The home directory: **/usr/lib/xwiki/**
385
Thomas Mortagne 98.1 386 * META-INF
387 * resources
388 * skins
389 * templates
390 * WEB-INF
391 ** hibernate.cfg.xml -> /etc/xwiki/hibernate.cfg.xml
392 ** xwiki.cfg -> /etc/xwiki/xwiki.cfg
393 ** xwiki.properties -> /etc/xwiki/xwiki.properties
394
Thomas Mortagne 227.13 395 === XJetty ===
396
397 **/lib/systemd/system/xwiki.service** is the configuration in charge of controlling the ##xwiki## service, it's also where you can customize its java startup configuration
398
Jan-Paul Kleijn 217.2 399 === Tomcat ===
Guillaume Fenollar 4.1 400
Thomas Mortagne 99.1 401 **/etc/tomcat##<version>##/**
Guillaume Fenollar 4.1 402
Thomas Mortagne 99.1 403 * context.xml
404 * logging.properties
405 * server.xml
406 * tomcat-users.xml
407 * web.xml
408
Guillaume Fenollar 12.1 409 **/etc/default/**
Guillaume Fenollar 4.1 410
Thomas Mortagne 99.1 411 * tomcat##<version>## //This file helps configuring the Tomcat daemon. Every change needs a restart to be effective//
412
413 **/var/lib/tomcat##<version>##/**
Guillaume Fenollar 4.1 414
Thomas Mortagne 99.1 415 * common
416 * conf -> /etc/tomcat##<version>##
Jean-Sébastien Dennebouy 198.1 417 * logs -> ../../log/tomcat##<version>     //Note that starting Debian 10 and Ubuntu 18.04 systemd service log is used//##
Thomas Mortagne 99.1 418 * server
419 * shared
420 * webapps
421
422 **/var/log/tomcat##<version>##/**
423
424 * catalina.out //First logging file. Check this one if you're experiencing troubles with Tomcat/XWiki.//
Paul Libbrecht 106.1 425 * localhost.<date>.log // "Container Log file": Start of each filter and failures thereof are listed.//
Thomas Mortagne 99.1 426
Thomas Mortagne 228.1 427 === MariaDB/MySQL ===
Guillaume Fenollar 4.1 428
429 **/etc/mysql/**
430
Thomas Mortagne 99.1 431 * debian.cnf
432 * my.cnf //Database configuration. Max_allowed_packet is the parameter you need to change to improve upload data size.// permitted.
433
Guillaume Fenollar 4.1 434 **/var/lib/mysql/**
435
Thomas Mortagne 99.1 436 * mysql
437 * xwiki //This is the xwiki database. You may want to backup this directory from time to time.//
438
Guillaume Fenollar 4.1 439 **/var/log/**
440
Thomas Mortagne 99.1 441 * syslog
442 * mysql
443 ** error.log
444
Jan-Paul Kleijn 217.2 445 === PostgreSQL ===
Guillaume Fenollar 4.1 446
447 **/etc/postgresql/**
448
Thomas Mortagne 99.1 449 * ##<version>##
450 ** main
451 *** postgresql.conf
452 *** pg_hba.conf
453
454 **/var/lib/postgresql/##<version>##/main/**
455
456 * base

Get Connected