Last modified by Thomas Mortagne on 2025/06/11

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
Vincent Massol 258.2 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 (unstable).
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]]: all released Cycle LTS versions.
Thomas Mortagne 260.1 32 * [[https:~~/~~/maven.xwiki.org/lts/xwiki-lts-latest.list>>https://maven.xwiki.org/recommended/xwiki-lts-latest.list]]: latest LTS versions (can be the Cycle LTS or the Intermediate LTS versions if they higher).
Vincent Massol 258.2 33
34 Check out the the [[Support page>>xwiki:Main.Support]] for more information on the various branches we support.
Thomas Mortagne 44.1 35 {{/info}}
36
Guillaume Fenollar 1.1 37 Now you can update the packages database to read the data from this repository.
38
Thomas Mortagne 18.1 39 {{code language="bash"}}
40 sudo apt-get update
41 {{/code}}
42
Guillaume Fenollar 1.1 43 Now you can make a little search to see what this repo offers.
44
Thomas Mortagne 18.1 45 {{code language="bash"}}
Guillaume Fenollar 1.1 46 apt-cache search xwiki
47 {{/code}}
48
Thomas Mortagne 227.2 49 * Common packages not tied to any application server or database
50 ** ##xwiki-common## - XWiki, you can install this if you want to take care yourself of the database and application server
51 ** ##xwiki-mariadb-common## - XWiki MariaDB common package, you can install this if you want to take care yourself of the application server
52 ** ##xwiki-mysql-common## - XWiki MySQL common package, you can install this if you want to take care yourself of the application server
53 ** ##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 54
Thomas Mortagne 249.1 55 * Packages based on a customized Jetty packaged for XWiki
Thomas Mortagne 227.2 56 ** ##xwiki-xjetty-common## - XWiki Jetty common package, you can install this if you want to take care yourself of the database link
57 ** ##xwiki-xjetty-mariadb## - XWiki Jetty/MariaDB based package
58 ** ##xwiki-xjetty-mysql## - XWiki Jetty/MySQL based package
59 ** ##xwiki-xjetty-pgsql## - XWiki Jetty/PostgreSQL
Thomas Mortagne 103.1 60
Thomas Mortagne 230.1 61 * Packages based on the standard Tomcat package
Thomas Mortagne 227.2 62 ** ##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 63 ** ##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 64 ** ##xwiki-tomcat9-mariadb## - XWiki Tomcat 9/MariaDB based package
Thomas Mortagne 247.1 65 ** ##xwiki-tomcat10-mariadb## - XWiki Tomcat 10/MariaDB based package
Thomas Mortagne 227.2 66 ** ##xwiki-tomcat9-mysql## - XWiki Tomcat 9/MySQL based package
Thomas Mortagne 247.1 67 ** ##xwiki-tomcat10-mysql## - XWiki Tomcat 10/MySQL based package
Thomas Mortagne 227.2 68 ** ##xwiki-tomcat9-pgsql## - XWiki Tomcat 9/PostgreSQL
Thomas Mortagne 247.1 69 ** ##xwiki-tomcat10-pgsql## - XWiki Tomcat 10/PostgreSQL
Thomas Mortagne 103.1 70
Thomas Mortagne 234.1 71 * Not really XWiki itself but Solr cores needed when you want to use a standalone Solr instance with XWiki
72 ** ##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
73 ** ##xwiki-solr9-search## - A pre configured Solr 9 core for the XWiki search feature
74 ** ##xwiki-solr9-events## - A pre configured Solr 9 core for the XWiki events/notifications storage
75 ** ##xwiki-solr9-ratings## - A pre configured Solr 9 core for the XWiki rating storage
76 ** ##xwiki-solr9-extension_index## - A pre configured Solr 9 core for the XWiki extensions index
Thomas Mortagne 227.2 77
78 Plus legacy packages from older versions of XWiki like ##xwiki-enterprise-*## packages or for unsupported versions of Tomcat.
79
Valdis Vitolins 42.1 80 {{info}}
81 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.
82 {{/info}}
Valdis Vitolins 41.1 83
Thomas Mortagne 134.1 84 {{warning}}
85 On Ubuntu you will need [[##universe## repository>>https://help.ubuntu.com/community/Repositories/CommandLine]] to install Tomcat packages. It's generally enabled by default.
86 {{/warning}}
87
Jan-Paul Kleijn 217.2 88 == Complete Installation ==
Guillaume Fenollar 1.1 89
Thomas Mortagne 64.1 90 {{warning}}
Thomas Mortagne 252.3 91 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 92 {{/warning}}
93
Jan-Paul Kleijn 217.2 94 === Using MariaDB ===
Guillaume Fenollar 1.1 95
Thomas Mortagne 188.1 96 {{warning}}
Thomas Mortagne 227.2 97 Note that XWiki requires at least MariaDB 10.2.
Thomas Mortagne 188.1 98 {{/warning}}
Thomas Mortagne 185.1 99
Thomas Mortagne 227.2 100 Xjetty:
Guillaume Fenollar 1.2 101
Thomas Mortagne 18.1 102 {{code language="bash"}}
Thomas Mortagne 232.1 103 sudo apt install xwiki-xjetty-mariadb
Thomas Mortagne 227.2 104 {{/code}}
105
Thomas Mortagne 248.1 106 Tomcat 10:
107
108 {{code language="bash"}}
109 sudo apt install xwiki-tomcat10-mariadb
110 {{/code}}
111
Thomas Mortagne 247.1 112 Tomcat 9:
Thomas Mortagne 227.2 113
114 {{code language="bash"}}
Thomas Mortagne 232.1 115 sudo apt install xwiki-tomcat9-mariadb
Thomas Mortagne 18.1 116 {{/code}}
117
Jan-Paul Kleijn 216.1 118 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 119
Simon Urli 217.1 120 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 121
Simon Urli 217.1 122 {{warning}}
123 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]]
124 {{/warning}}
125
Thomas Mortagne 227.2 126 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 127
Jan-Paul Kleijn 217.2 128 === Using MySQL ===
Thomas Mortagne 169.1 129
Thomas Mortagne 187.1 130 {{warning}}
Thomas Mortagne 247.1 131 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 132 {{/warning}}
Thomas Mortagne 186.1 133
Thomas Mortagne 227.2 134 Xjetty:
Thomas Mortagne 169.1 135
136 {{code language="bash"}}
Thomas Mortagne 232.1 137 sudo apt install xwiki-xjetty-mysql
Thomas Mortagne 169.1 138 {{/code}}
139
Thomas Mortagne 248.1 140 Tomcat 10:
141
142 {{code language="bash"}}
143 sudo apt install xwiki-tomcat10-mysql
144 {{/code}}
145
Thomas Mortagne 247.1 146 Tomcat 9:
Thomas Mortagne 169.1 147
Thomas Mortagne 227.2 148 {{code language="bash"}}
Thomas Mortagne 232.1 149 sudo apt install xwiki-tomcat9-mysql
Thomas Mortagne 227.2 150 {{/code}}
Thomas Mortagne 169.1 151
Thomas Mortagne 227.12 152 Everything else is similar to what is described in the [[the MariaDB section>>||anchor="#HUsingMariaDB"]].
Thomas Mortagne 169.1 153
Jan-Paul Kleijn 217.2 154 === Using PostgreSQL ===
Guillaume Fenollar 4.1 155
Manuel Smeria 25.3 156 It's as simple as the MySQL installation, you only need to choose the right virtual package.
Guillaume Fenollar 4.1 157
Thomas Mortagne 227.2 158 Xjetty:
159
Thomas Mortagne 18.1 160 {{code language="bash"}}
Thomas Mortagne 232.1 161 sudo apt install xwiki-xjetty-pgsql
Thomas Mortagne 227.2 162 {{/code}}
163
Thomas Mortagne 248.1 164 Tomcat 10:
165
166 {{code language="bash"}}
167 sudo apt install xwiki-tomcat10-pgsql
168 {{/code}}
169
Thomas Mortagne 247.1 170 Tomcat 9:
Thomas Mortagne 227.2 171
172 {{code language="bash"}}
Thomas Mortagne 232.1 173 sudo apt install xwiki-tomcat9-pgsql
Thomas Mortagne 18.1 174 {{/code}}
175
Thomas Mortagne 227.12 176 Everything else is similar to what is described in the [[the MariaDB section>>||anchor="#HUsingMariaDB"]].
Jan-Paul Kleijn 212.2 177
Jan-Paul Kleijn 217.2 178 === Starting up XWiki for the first time... ===
Jan-Paul Kleijn 212.2 179
Jan-Paul Kleijn 212.3 180 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 181
Jan-Paul Kleijn 216.1 182 {{warning}}
183 Note that your wiki is absolutely empty, like a WAR installation. Distribution Wizard will take care of the rest.
184 {{/warning}}
185
Jan-Paul Kleijn 217.2 186 == Performance ==
Guillaume Fenollar 11.1 187
Thomas Mortagne 227.13 188 === XWiki ===
189
190 You can find various [[various generic advices and troubleshooting related to XWiki>>Documentation.AdminGuide.Performances]].
191
Jan-Paul Kleijn 217.2 192 === Tomcat ===
193
Vincent Massol 167.2 194 You can find [[various generic advices and troubleshooting related to Tomcat>>Documentation.AdminGuide.Installation.InstallationWAR.InstallationTomcat.WebHome]].
Thomas Mortagne 142.1 195
Thomas Mortagne 227.13 196 ==== Java Version ====
Thomas Mortagne 78.1 197
Thomas Mortagne 227.1 198 Make sure Tomcat is executed with the right [[Java version>>Documentation.AdminGuide.Installation||anchor="HHardwareandSoftwarerequirements"]].
Thomas Mortagne 78.1 199
Thomas Mortagne 251.1 200 This is usually indicated in the file ##/etc/default/tomcat10## (or ##/etc/default/tomcat9## for Tomcat 9, etc).
Thomas Mortagne 78.1 201
Thomas Mortagne 227.13 202 ==== Memory ====
Thomas Mortagne 78.1 203
Vincent Massol 119.2 204 The default Tomcat memory setup is too low for XWiki's needs.
Guillaume Fenollar 11.1 205
Thomas Mortagne 251.1 206 You can change it in the file ##/etc/default/tomcat10## (or ##/etc/default/tomcat9## for Tomcat 10, etc).
Guillaume Fenollar 11.1 207
Thomas Mortagne 71.1 208 Modify the property ##JAVA_OPTS##. For example:
Thomas Mortagne 18.1 209
Thomas Steinbach 25.1 210 {{code language="none"}}
Thomas Mortagne 94.1 211 JAVA_OPTS="-Djava.awt.headless=true -Xmx1024m"
Thomas Steinbach 25.1 212 {{/code}}
Thomas Mortagne 18.1 213
Thomas Mortagne 194.1 214 You should [[check the Memory settings we recommend>>Documentation.AdminGuide.Performances||anchor="HMemory"]].
Guillaume Fenollar 11.1 215
Jan-Paul Kleijn 217.2 216 == Concluding Step ==
Thomas Mortagne 50.1 217
Vincent Massol 114.2 218 {{include reference="Documentation.AdminGuide.Installation.InstallationConcludingSteps.WebHome"/}}
Thomas Mortagne 50.1 219
Thomas Mortagne 250.2 220 == Upgrading ==
221
Thomas Mortagne 252.1 222 === Update the packages index ===
Thomas Mortagne 250.2 223
Thomas Mortagne 250.3 224 {{code language="bash"}}
225 sudo apt update
226 {{/code}}
227
promasu 258.1 228 === [Optional] Uninstall conflicting version of tomcat packages ===
Thomas Mortagne 254.1 229
promasu 258.1 230 In the case of the ##tomcat## based packages, if you are moving from one version of Tomcat to another (which is generally needed when XWiki increase its [[minimum supported version>>Documentation.AdminGuide.Installation.InstallationWAR.InstallationTomcat||anchor="HInstallationSteps"]]), you may need to first uninstall the previous version. This is because two different versions of Tomcat cannot run at the same time by default.
Thomas Mortagne 254.1 231
Thomas Mortagne 255.1 232 Of course, you can skip this step if you are not using the Tomcat based package, not changing the version of Tomcat, or if you configured Tomcat specifically to allow having several versions running at the same time.
Thomas Mortagne 254.1 233
Thomas Mortagne 256.1 234 * Stop the running instance of tomcat ({{warning}}change the version to match the previous version of Tomcat you are upgrading from{{/warning}}):
Thomas Mortagne 254.1 235
236 {{code language="bash"}}
237 sudo systemctl stop tomcat9
238 {{/code}}
239
Thomas Mortagne 255.1 240 * Uninstall Tomcat (which will also uninstall the xwiki packages which rely on this version of Tomcat):
Thomas Mortagne 254.1 241
242 {{code language="bash"}}
243 sudo apt remove tomcat9
244 {{/code}}
245
Thomas Mortagne 256.4 246 * Then you will need to install the new package ({{warning}}modify the package name to match the version of Tomcat you are upgrading to, and the database you were already using{{/warning}}):
Thomas Mortagne 255.1 247
248 {{code language="bash"}}
249 sudo apt install xwiki-tomcat10-mariadb
250 {{/code}}
251
Thomas Mortagne 252.1 252 === Upgrade the packages ===
Thomas Mortagne 250.3 253
254 {{code language="bash"}}
255 sudo apt upgrade
256 {{/code}}
257
258 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).
259
Thomas Mortagne 250.10 260 {{warning}}
Thomas Mortagne 250.3 261 Sometimes (especially in case of new cycle), apt upgrade might report that it refuse to upgrade some xwiki packages.
262
263 This is generally the sign that either:
promasu 258.1 264
265 * 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.
266 * 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 267 {{/warning}}
Thomas Mortagne 250.3 268
Thomas Mortagne 252.1 269 === Upgrade the pages ===
Thomas Mortagne 250.3 270
Thomas Mortagne 250.7 271 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 272
Jan-Paul Kleijn 217.2 273 == Uninstallation ==
Guillaume Fenollar 4.1 274
Thomas Mortagne 242.1 275 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 276
Thomas Mortagne 27.1 277 {{code language="bash"}}
Thomas Mortagne 103.1 278 sudo apt-get --purge remove xwiki-common
Thomas Mortagne 27.1 279 {{/code}}
280
Thomas Mortagne 95.1 281 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 282
Manuel Smeria 25.3 283 {{code language="bash"}}
Thomas Mortagne 96.1 284 sudo apt-get --purge autoremove
Manuel Smeria 25.3 285 {{/code}}
Guillaume Fenollar 10.1 286
Jan-Paul Kleijn 219.1 287 == Troubleshooting ==
Thomas Mortagne 77.1 288
Jan-Paul Kleijn 220.1 289 === Log file location ===
Jan-Paul Kleijn 217.2 290
Thomas Mortagne 227.13 291 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 292
Thomas Mortagne 227.13 293 ==== XJetty ====
Jan-Paul Kleijn 217.2 294
295 {{code language="none"}}
Thomas Mortagne 227.13 296 /var/log/xwiki/[date].jetty.log
297 {{/code}}
298
Thomas Mortagne 252.1 299 ==== Tomcat ====
Thomas Mortagne 227.13 300
Thomas Mortagne 252.1 301 There are several possibilities depending on the distribution and Tomcat version:
Jan-Paul Kleijn 217.2 302
303 {{code language="none"}}
Thomas Mortagne 252.1 304 /var/log/tomcat10/catalina.out
305 /var/log/tomcat10/catalina.[date].log
Thomas Mortagne 241.1 306 /var/log/tomcat9/catalina.out
Jan-Paul Kleijn 217.2 307 /var/log/tomcat9/Catalina.[date].log
308 {{/code}}
309
Thomas Mortagne 162.1 310 You can find a generic Troubleshooting section on [[https://www.xwiki.org/xwiki/bin/view/Documentation/AdminGuide/Installation/#HTroubleshooting]].
311
Jan-Paul Kleijn 217.2 312 === No package can be found for Java ===
Thomas Mortagne 196.3 313
Thomas Mortagne 252.1 314 XWiki require at least Java 17 since XWiki 16.0.
Thomas Mortagne 196.3 315
Thomas Mortagne 211.1 316 If your Debian based distribution does not provide any package for the Java version you need you can try with:
Thomas Mortagne 196.3 317
Thomas Mortagne 227.13 318 * 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 319
Jan-Paul Kleijn 217.2 320 === Tomcat ===
Thomas Mortagne 128.1 321
Thomas Mortagne 196.1 322 See [[Tomcat Installation>>Documentation.AdminGuide.Installation.InstallationWAR.InstallationTomcat||anchor="HTroubleshooting"]] for generic Tomcat related issues.
Thomas Mortagne 162.1 323
Jan-Paul Kleijn 217.2 324 === MySQL ===
Thomas Mortagne 77.1 325
Thomas Mortagne 195.1 326 See [[MySQL Installation>>Documentation.AdminGuide.Installation.InstallationWAR.InstallationMySQL||anchor="HTroubleshooting"]] for generic MySQL related issues.
Thomas Mortagne 77.1 327
Jan-Paul Kleijn 217.2 328 === PostgreSQL ===
Thomas Mortagne 77.1 329
Thomas Mortagne 193.1 330 See [[PostgreSQL Installation>>Documentation.AdminGuide.Installation.InstallationWAR.InstallationPostgreSQL||anchor="HTroubleshooting"]] for generic PostgreSQL related issues.
Thomas Mortagne 77.1 331
Jan-Paul Kleijn 217.2 332 == Other useful info ==
Thomas Mortagne 77.1 333
Jan-Paul Kleijn 217.2 334 === XWiki as root webapp (short URLs) ===
Thomas Mortagne 77.1 335
Jan-Paul Kleijn 221.3 336 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 337
Jan-Paul Kleijn 217.2 338 ==== For Tomcat 9 ====
Vincent Massol 200.2 339
Thomas Mortagne 77.1 340 {{warning}}
Thomas Mortagne 167.1 341 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 342 {{/warning}}
343
Thomas Mortagne 167.1 344 * Rename file ##/etc/tomcat9/Catalina/localhost/xwiki.xml## into ##/etc/tomcat9/Catalina/localhost/ROOT.xml##
345 * 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 346 {{code language="xml"}}
Thomas Mortagne 167.1 347 <Context path="/xwiki" docBase="/usr/lib/xwiki"
348 containerSciFilter="org.apache.tomcat.websocket.server.WsSci|org.apache.jasper.servlet.JasperInitializer">
Thomas Mortagne 77.1 349 {{/code}}
350
351 to
352
353 {{code language="xml"}}
Vincent Massol 212.1 354 <Context path="" docBase="/usr/lib/xwiki"
Thomas Mortagne 167.1 355 containerSciFilter="org.apache.tomcat.websocket.server.WsSci|org.apache.jasper.servlet.JasperInitializer">
Thomas Mortagne 77.1 356 {{/code}}
357 )))
358 * Edit file ##/etc/xwiki/xwiki.cfg## and uncomment {{code language="properties"}}xwiki.webapppath={{/code}}
Jan-Paul Kleijn 221.2 359 * Restart Tomcat 9.
Thomas Mortagne 77.1 360
promasu 245.1 361 ==== For Jetty ====
362
363 {{version since="16.7.0"}}
364 You have to modify the ##xjetty-web.xml## file
365
366 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.
367
368 {{code language="xml"}}
369 <Set name="contextPath">/</Set>
370 {{/code}}
371 {{/version}}
promasu 258.1 372 {{version since="17.0.0"}}
373 You have to modify the ##jetty-web.xml## file
promasu 245.1 374
promasu 258.1 375 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/jetty-web.xml## and add the following directive.
376
377 {{code language="xml"}}
378 <Set name="contextPath">/</Set>
379 {{/code}}
380 {{/version}}
381
Jan-Paul Kleijn 217.2 382 === Integrate with LibreOffice ===
Thomas Mortagne 77.1 383
Thomas Mortagne 97.1 384 Install libreoffice with {{code language="none"}}sudo apt-get install libreoffice{{/code}}.
Thomas Mortagne 77.1 385
386 And setup XWiki to automatically start and access libreoffice in ##/etc/xwiki/xwiki.properties##:
387
388 {{code language="properties"}}
389 openoffice.autoStart=true
390 openoffice.homePath=/usr/lib/libreoffice/
391 {{/code}}
392
393 See [[Office Importer Application>>extensions:Extension.Office Importer Application]] for more details.
394
Jan-Paul Kleijn 217.2 395 === Standalone Solr setup ===
Thomas Mortagne 159.1 396
Thomas Mortagne 240.1 397 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 398
Thomas Mortagne 240.1 399 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 400
Thomas Mortagne 243.1 401 === Access a file from XWiki ===
402
403 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.
404
Jan-Paul Kleijn 217.2 405 == Overview of the important files ==
Guillaume Fenollar 4.1 406
Manuel Smeria 25.3 407 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 408
Jan-Paul Kleijn 217.2 409 === XWiki ===
Guillaume Fenollar 4.1 410
Thomas Mortagne 152.1 411 The configuration: **/etc/xwiki/**
Guillaume Fenollar 4.1 412
Thomas Mortagne 156.1 413 * hibernate.cfg.xml //Hibernate configuration, helping to configure the database resources//
Thomas Mortagne 152.1 414 * xwiki.cfg
Thomas Mortagne 98.1 415 * xwiki.properties
Thomas Mortagne 184.1 416 * xwiki-tomcat9-systemd.conf // Injected trough ##/etc/systemd/system/tomcat9.service.d/xwiki-tomcat-systemd.conf##// in the tomcat9 service configuration
417 * xwiki-tomcat<version> // The Tomcat integration linked from ##/etc/tomcat<version>/Catalina/localhost##//
Thomas Mortagne 98.1 418
Thomas Mortagne 153.1 419 The permanent directory: **/var/lib/xwiki/data**
Guillaume Fenollar 4.1 420
Thomas Mortagne 153.1 421 The home directory: **/usr/lib/xwiki/**
422
Thomas Mortagne 98.1 423 * META-INF
424 * resources
425 * skins
426 * templates
427 * WEB-INF
428 ** hibernate.cfg.xml -> /etc/xwiki/hibernate.cfg.xml
429 ** xwiki.cfg -> /etc/xwiki/xwiki.cfg
430 ** xwiki.properties -> /etc/xwiki/xwiki.properties
431
Thomas Mortagne 227.13 432 === XJetty ===
433
434 **/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
435
Jan-Paul Kleijn 217.2 436 === Tomcat ===
Guillaume Fenollar 4.1 437
Thomas Mortagne 99.1 438 **/etc/tomcat##<version>##/**
Guillaume Fenollar 4.1 439
Thomas Mortagne 99.1 440 * context.xml
441 * logging.properties
442 * server.xml
443 * tomcat-users.xml
444 * web.xml
445
Guillaume Fenollar 12.1 446 **/etc/default/**
Guillaume Fenollar 4.1 447
Thomas Mortagne 99.1 448 * tomcat##<version>## //This file helps configuring the Tomcat daemon. Every change needs a restart to be effective//
449
450 **/var/lib/tomcat##<version>##/**
Guillaume Fenollar 4.1 451
Thomas Mortagne 99.1 452 * common
453 * conf -> /etc/tomcat##<version>##
Jean-Sébastien Dennebouy 198.1 454 * logs -> ../../log/tomcat##<version>     //Note that starting Debian 10 and Ubuntu 18.04 systemd service log is used//##
Thomas Mortagne 99.1 455 * server
456 * shared
457 * webapps
458
459 **/var/log/tomcat##<version>##/**
460
461 * catalina.out //First logging file. Check this one if you're experiencing troubles with Tomcat/XWiki.//
Paul Libbrecht 106.1 462 * localhost.<date>.log // "Container Log file": Start of each filter and failures thereof are listed.//
Thomas Mortagne 99.1 463
Thomas Mortagne 228.1 464 === MariaDB/MySQL ===
Guillaume Fenollar 4.1 465
466 **/etc/mysql/**
467
Thomas Mortagne 99.1 468 * debian.cnf
469 * my.cnf //Database configuration. Max_allowed_packet is the parameter you need to change to improve upload data size.// permitted.
470
Guillaume Fenollar 4.1 471 **/var/lib/mysql/**
472
Thomas Mortagne 99.1 473 * mysql
474 * xwiki //This is the xwiki database. You may want to backup this directory from time to time.//
475
Guillaume Fenollar 4.1 476 **/var/log/**
477
Thomas Mortagne 99.1 478 * syslog
479 * mysql
480 ** error.log
481
Jan-Paul Kleijn 217.2 482 === PostgreSQL ===
Guillaume Fenollar 4.1 483
484 **/etc/postgresql/**
485
Thomas Mortagne 99.1 486 * ##<version>##
487 ** main
488 *** postgresql.conf
489 *** pg_hba.conf
490
491 **/var/lib/postgresql/##<version>##/main/**
492
493 * base

Get Connected