Skip to Content

Version 247.1 by Thomas Mortagne on 2025/01/22
Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc start="2"/}}
3 {{/box}}
4
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
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:
11
12 * use the xjetty based packages instead
13 * upgrade to XWiki 17+
14 * use an [[alternative non Debian specific install method>>xwiki:Documentation.AdminGuide.Installation||anchor="HInstallationMethods"]].
15 {{/warning}}
16
17 == APT Configuration ==
18
19 First, you have to configure your package manager in order to use XWiki's repository. This can be done simply, using this command:
20
21 {{code language="bash"}}
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
24 {{/code}}
25
26 {{info}}
27 Note that there is several repositories you can choose (as alternatives to the stable one you have in the previous example):
28
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]]
32 {{/info}}
33
34 Now you can update the packages database to read the data from this repository.
35
36 {{code language="bash"}}
37 sudo apt-get update
38 {{/code}}
39
40 Now you can make a little search to see what this repo offers.
41
42 {{code language="bash"}}
43 apt-cache search xwiki
44 {{/code}}
45
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
51
52 * {{version since="14.10.19, 15.5.4, 15.9"}} {{/version}}
53 Packages based on a customized Jetty optimized for XWiki
54 ** ##xwiki-xjetty-common## - XWiki Jetty common package, you can install this if you want to take care yourself of the database link
55 ** ##xwiki-xjetty-mariadb## - XWiki Jetty/MariaDB based package
56 ** ##xwiki-xjetty-mysql## - XWiki Jetty/MySQL based package
57 ** ##xwiki-xjetty-pgsql## - XWiki Jetty/PostgreSQL
58
59 * Packages based on the standard Tomcat package
60 ** ##xwiki-tomcat9-common## - XWiki Tomcat 9 common package, you can install this if you want to take care yourself of the database link
61 ** ##xwiki-tomcat10-common## - XWiki Tomcat 10 common package, you can install this if you want to take care yourself of the database link
62 ** ##xwiki-tomcat9-mariadb## - XWiki Tomcat 9/MariaDB based package
63 ** ##xwiki-tomcat10-mariadb## - XWiki Tomcat 10/MariaDB based package
64 ** ##xwiki-tomcat9-mysql## - XWiki Tomcat 9/MySQL based package
65 ** ##xwiki-tomcat10-mysql## - XWiki Tomcat 10/MySQL based package
66 ** ##xwiki-tomcat9-pgsql## - XWiki Tomcat 9/PostgreSQL
67 ** ##xwiki-tomcat10-pgsql## - XWiki Tomcat 10/PostgreSQL
68
69 * Not really XWiki itself but Solr cores needed when you want to use a standalone Solr instance with XWiki
70 ** ##xwiki-solr-all## - An entry point package with dependencies on all the Solr 8 cores required to setup a standalone version compatible with XWiki Standard
71 ** ##xwiki-solr-core## - A pre configured Solr 8 core for the XWiki search feature
72 ** ##xwiki-solr-events## - A pre configured Solr 8 core for the XWiki events/notifications storage
73 ** ##xwiki-solr-ratings## - A pre configured Solr 8 core for the XWiki rating storage
74 ** ##xwiki-solr-extension_index## - A pre configured Solr 8 core for the XWiki extensions index
75 ** ##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
76 ** ##xwiki-solr9-search## - A pre configured Solr 9 core for the XWiki search feature
77 ** ##xwiki-solr9-events## - A pre configured Solr 9 core for the XWiki events/notifications storage
78 ** ##xwiki-solr9-ratings## - A pre configured Solr 9 core for the XWiki rating storage
79 ** ##xwiki-solr9-extension_index## - A pre configured Solr 9 core for the XWiki extensions index
80
81 Plus legacy packages from older versions of XWiki like ##xwiki-enterprise-*## packages or for unsupported versions of Tomcat.
82
83 {{info}}
84 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.
85 {{/info}}
86
87 {{warning}}
88 On Ubuntu you will need [[##universe## repository>>https://help.ubuntu.com/community/Repositories/CommandLine]] to install Tomcat packages. It's generally enabled by default.
89 {{/warning}}
90
91 == Complete Installation ==
92
93 {{warning}}
94 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 Usability section>>||anchor="HTomcatUsability"]] for more details.
95 {{/warning}}
96
97 === Using MariaDB ===
98
99 {{warning}}
100 Note that XWiki requires at least MariaDB 10.2.
101 {{/warning}}
102
103 Xjetty:
104
105 {{code language="bash"}}
106 sudo apt install xwiki-xjetty-mariadb
107 {{/code}}
108
109 Tomcat 9:
110
111 {{code language="bash"}}
112 sudo apt install xwiki-tomcat9-mariadb
113 {{/code}}
114
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.
116
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.
118
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
123 The installation ends with the start of the XWiki or Tomcat daemon which is also setup to start automatically from boot.
124
125 === Using MySQL ===
126
127 {{warning}}
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"]].
129 {{/warning}}
130
131 Xjetty:
132
133 {{code language="bash"}}
134 sudo apt install xwiki-xjetty-mysql
135 {{/code}}
136
137 Tomcat 9:
138
139 {{code language="bash"}}
140 sudo apt install xwiki-tomcat9-mysql
141 {{/code}}
142
143 Everything else is similar to what is described in the [[the MariaDB section>>||anchor="#HUsingMariaDB"]].
144
145 === Using PostgreSQL ===
146
147 It's as simple as the MySQL installation, you only need to choose the right virtual package.
148
149 Xjetty:
150
151 {{code language="bash"}}
152 sudo apt install xwiki-xjetty-pgsql
153 {{/code}}
154
155 Tomcat 9:
156
157 {{code language="bash"}}
158 sudo apt install xwiki-tomcat9-pgsql
159 {{/code}}
160
161 Everything else is similar to what is described in the [[the MariaDB section>>||anchor="#HUsingMariaDB"]].
162
163 === Starting up XWiki for the first time... ===
164
165 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]]##
166
167 {{warning}}
168 Note that your wiki is absolutely empty, like a WAR installation. Distribution Wizard will take care of the rest.
169 {{/warning}}
170
171 == Performance ==
172
173 === XWiki ===
174
175 You can find various [[various generic advices and troubleshooting related to XWiki>>Documentation.AdminGuide.Performances]].
176
177 === Tomcat ===
178
179 You can find [[various generic advices and troubleshooting related to Tomcat>>Documentation.AdminGuide.Installation.InstallationWAR.InstallationTomcat.WebHome]].
180
181 ==== Java Version ====
182
183 Make sure Tomcat is executed with the right [[Java version>>Documentation.AdminGuide.Installation||anchor="HHardwareandSoftwarerequirements"]].
184
185 This is usually indicated in the file ##/etc/default/tomcat9## (or ##/etc/default/tomcat8## for Tomcat 8, etc).
186
187 ==== Memory ====
188
189 The default Tomcat memory setup is too low for XWiki's needs.
190
191 You can change it in the file ##/etc/default/tomcat9## (or ##/etc/default/tomcat8## for Tomcat 8, etc).
192
193 Modify the property ##JAVA_OPTS##. For example:
194
195 {{code language="none"}}
196 JAVA_OPTS="-Djava.awt.headless=true -Xmx1024m"
197 {{/code}}
198
199 You should [[check the Memory settings we recommend>>Documentation.AdminGuide.Performances||anchor="HMemory"]].
200
201 ==== /dev/urandom ====
202
203 In most Debian-based systems the default random implementation is ##/dev/random## which can be very slow. ##/dev/urandom## is much faster and it's fine for XWiki's needs so you should use it when possible:
204
205 * edit ##/etc/default/tomcat9## file and add
206
207 {{code language="bash"}}
208 JAVA_OPTS="${JAVA_OPTS} -Djava.security.egd=file:/dev/./urandom"
209 {{/code}}
210
211 == Concluding Step ==
212
213 {{include reference="Documentation.AdminGuide.Installation.InstallationConcludingSteps.WebHome"/}}
214
215 == Uninstallation ==
216
217 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:
218
219 {{code language="bash"}}
220 sudo apt-get --purge remove xwiki-common
221 {{/code}}
222
223 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
224
225 {{code language="bash"}}
226 sudo apt-get --purge autoremove
227 {{/code}}
228
229 == Troubleshooting ==
230
231 === Log file location ===
232
233 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.
234
235 ==== XJetty ====
236
237 {{code language="none"}}
238 /var/log/xwiki/[date].jetty.log
239 {{/code}}
240
241 ==== Tomcat9 ====
242
243 There are several possibilities depending on the distribution:
244
245 {{code language="none"}}
246 /var/log/tomcat9/catalina.out
247 /var/log/tomcat9/Catalina.[date].log
248 {{/code}}
249
250 You can find a generic Troubleshooting section on [[https://www.xwiki.org/xwiki/bin/view/Documentation/AdminGuide/Installation/#HTroubleshooting]].
251
252 === No package can be found for Java ===
253
254 XWiki require at least Java 8 since XWiki 8.1 and Java 11 since XWiki 14.0, **OpenJDK 17** (the recommended version) will be automatically installed as dependency on recent distributions.
255
256 If your Debian based distribution does not provide any package for the Java version you need you can try with:
257
258 * Adoptium provides a Debian repository to install Temurin (OpenJDK), see https://adoptium.net/installation/linux/#_deb_installation_on_debian_or_ubuntu
259
260 === Tomcat ===
261
262 See [[Tomcat Installation>>Documentation.AdminGuide.Installation.InstallationWAR.InstallationTomcat||anchor="HTroubleshooting"]] for generic Tomcat related issues.
263
264 === MySQL ===
265
266 See [[MySQL Installation>>Documentation.AdminGuide.Installation.InstallationWAR.InstallationMySQL||anchor="HTroubleshooting"]] for generic MySQL related issues.
267
268 === PostgreSQL ===
269
270 See [[PostgreSQL Installation>>Documentation.AdminGuide.Installation.InstallationWAR.InstallationPostgreSQL||anchor="HTroubleshooting"]] for generic PostgreSQL related issues.
271
272 == Other useful info ==
273
274 === XWiki as root webapp (short URLs) ===
275
276 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]].
277
278 ==== For Tomcat 9 ====
279
280 {{warning}}
281 When doing it make sure to check after upgrade if all is OK in /etc/tomcat9/Catalina/localhost folder (xwiki.xml might be restored).
282 {{/warning}}
283
284 * Rename file ##/etc/tomcat9/Catalina/localhost/xwiki.xml## into ##/etc/tomcat9/Catalina/localhost/ROOT.xml##
285 * Edit file ##/etc/xwiki/xwiki-tomcat9.xml## and modify ##Context## XML element path from ##/xwiki## to ##/## as in moving from(((
286 {{code language="xml"}}
287 <Context path="/xwiki" docBase="/usr/lib/xwiki"
288 containerSciFilter="org.apache.tomcat.websocket.server.WsSci|org.apache.jasper.servlet.JasperInitializer">
289 {{/code}}
290
291 to
292
293 {{code language="xml"}}
294 <Context path="" docBase="/usr/lib/xwiki"
295 containerSciFilter="org.apache.tomcat.websocket.server.WsSci|org.apache.jasper.servlet.JasperInitializer">
296 {{/code}}
297 )))
298 * Edit file ##/etc/xwiki/xwiki.cfg## and uncomment {{code language="properties"}}xwiki.webapppath={{/code}}
299 * Restart Tomcat 9.
300
301 ==== For Jetty ====
302
303 {{version since="16.7.0"}}
304 You have to modify the ##xjetty-web.xml## file
305
306 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.
307
308 {{code language="xml"}}
309 <Set name="contextPath">/</Set>
310 {{/code}}
311 {{/version}}
312
313 === Integrate with LibreOffice ===
314
315 Install libreoffice with {{code language="none"}}sudo apt-get install libreoffice{{/code}}.
316
317 And setup XWiki to automatically start and access libreoffice in ##/etc/xwiki/xwiki.properties##:
318
319 {{code language="properties"}}
320 openoffice.autoStart=true
321 openoffice.homePath=/usr/lib/libreoffice/
322 {{/code}}
323
324 See [[Office Importer Application>>extensions:Extension.Office Importer Application]] for more details.
325
326 === Standalone Solr setup ===
327
328 Take a look at [[Solr documentation>>https://solr.apache.org/guide/solr/latest/deployment-guide/taking-solr-to-production.html]] to install Solr itself.
329
330 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).
331
332 === Access a file from XWiki ===
333
334 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.
335
336 == Overview of the important files ==
337
338 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.
339
340 === XWiki ===
341
342 The configuration: **/etc/xwiki/**
343
344 * hibernate.cfg.xml //Hibernate configuration, helping to configure the database resources//
345 * xwiki.cfg
346 * xwiki.properties
347 * xwiki-tomcat9-systemd.conf // Injected trough ##/etc/systemd/system/tomcat9.service.d/xwiki-tomcat-systemd.conf##// in the tomcat9 service configuration
348 * xwiki-tomcat<version> // The Tomcat integration linked from ##/etc/tomcat<version>/Catalina/localhost##//
349
350 The permanent directory: **/var/lib/xwiki/data**
351
352 The home directory: **/usr/lib/xwiki/**
353
354 * META-INF
355 * resources
356 * skins
357 * templates
358 * WEB-INF
359 ** hibernate.cfg.xml -> /etc/xwiki/hibernate.cfg.xml
360 ** xwiki.cfg -> /etc/xwiki/xwiki.cfg
361 ** xwiki.properties -> /etc/xwiki/xwiki.properties
362
363 === XJetty ===
364
365 **/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
366
367 === Tomcat ===
368
369 **/etc/tomcat##<version>##/**
370
371 * context.xml
372 * logging.properties
373 * server.xml
374 * tomcat-users.xml
375 * web.xml
376
377 **/etc/default/**
378
379 * tomcat##<version>## //This file helps configuring the Tomcat daemon. Every change needs a restart to be effective//
380
381 **/var/lib/tomcat##<version>##/**
382
383 * common
384 * conf -> /etc/tomcat##<version>##
385 * logs -> ../../log/tomcat##<version>     //Note that starting Debian 10 and Ubuntu 18.04 systemd service log is used//##
386 * server
387 * shared
388 * webapps
389
390 **/var/log/tomcat##<version>##/**
391
392 * catalina.out //First logging file. Check this one if you're experiencing troubles with Tomcat/XWiki.//
393 * localhost.<date>.log // "Container Log file": Start of each filter and failures thereof are listed.//
394
395 === MariaDB/MySQL ===
396
397 **/etc/mysql/**
398
399 * debian.cnf
400 * my.cnf //Database configuration. Max_allowed_packet is the parameter you need to change to improve upload data size.// permitted.
401
402 **/var/lib/mysql/**
403
404 * mysql
405 * xwiki //This is the xwiki database. You may want to backup this directory from time to time.//
406
407 **/var/log/**
408
409 * syslog
410 * mysql
411 ** error.log
412
413 === PostgreSQL ===
414
415 **/etc/postgresql/**
416
417 * ##<version>##
418 ** main
419 *** postgresql.conf
420 *** pg_hba.conf
421
422 **/var/lib/postgresql/##<version>##/main/**
423
424 * base

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected