Version 151.1 by Thomas Mortagne on 2019/11/25
Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
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 = APT Configuration =
10
11 First, you have to configure your package manager in order to use xwiki's repository. This can be done simply, using this command:
12
13 {{code language="bash"}}
14 wget -q "https://maven.xwiki.org/public.gpg" -O- | sudo apt-key add -
15 sudo wget "https://maven.xwiki.org/stable/xwiki-stable.list" -P /etc/apt/sources.list.d/
16 {{/code}}
17
18 {{info}}
19 Note that there is several repositories you can choose (as alternatives to the stable one you have in the previous example):
20
21 * [[https://maven.xwiki.org/releases/xwiki-releases.list]]: all released versions including milestones and release candidates (beta)
22 * [[https://maven.xwiki.org/stable/xwiki-stable.list]]: all released versions excluding milestones and release candidates (stable)
23 * [[https://maven.xwiki.org/lts/xwiki-lts.list]]: the current "long term support" branch versions as defined in [[Support page>>xwiki:Main.Support]]
24 {{/info}}
25
26 Now you can update the packages database to read the data from this repository.
27
28 {{code language="bash"}}
29 sudo apt-get update
30 {{/code}}
31
32 {{info}}
33 I'll assume you're using APT tools. You can use Aptitude as well.
34 {{/info}}
35
36 Now you can make a little search to see what this repo offers.
37
38 {{code language="bash"}}
39 apt-cache search xwiki
40 {{/code}}
41
42 It shows the following packages (the exact list depends on the version the repository contains):
43
44 * xwiki-common - XWiki, you can install this if you want to take care yourself of the database and application server
45 * xwiki-mysql-common - XWiki MySQL common package, you can install this if you want to take care yourself of the application server
46 * xwiki-pgsql-common - XWiki PostgreSQL common package, you can install this if you want to take care yourself of the application server
47 * xwiki-tomcat7-common - XWiki Tomcat 7 common package, you can install this if you want to take care yourself of the database link
48 * xwiki-tomcat8-common - XWiki Tomcat 8 common package, you can install this if you want to take care yourself of the database link
49 * xwiki-tomcat9-common - XWiki Tomcat 9 common package, you can install this if you want to take care yourself of the database link
50 * xwiki-tomcat7-mysql - XWiki Tomcat 7/MySQL based package
51 * xwiki-tomcat8-mysql - XWiki Tomcat 8/MySQL based package
52 * xwiki-tomcat9-mysql - XWiki Tomcat 9/MySQL based package
53 * xwiki-tomcat7-pgsql - XWiki Tomcat 7/PostgreSQL
54 * xwiki-tomcat8-pgsql - XWiki Tomcat 8/PostgreSQL
55 * xwiki-tomcat9-pgsql - XWiki Tomcat 9/PostgreSQL
56 * xwiki-solr-data - A pre configured Solr core to be used to setup a standalone instance of Solr for XWiki
57
58 Plus legacy packages from older versions of XWiki like xwiki-enterprise-* packages.
59
60 {{error}}
61 xwiki-enterprise-* packages were deprecated as of 9.4. Installations requiring those packages will appear to have stopped updating at version 9.4. Install the corresponding xwiki-* package to update to the latest version. (For example, if you were relying on the xwiki-enterprise-tomcat8-mysql package, you will now need to install the xwiki-tomcat8-mysql package.)
62 {{/error}}
63
64 {{info}}
65 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.
66 {{/info}}
67
68 {{warning}}
69 On Ubuntu you will need [[##universe## repository>>https://help.ubuntu.com/community/Repositories/CommandLine]] to install Tomcat packages. It's generally enabled by default.
70 {{/warning}}
71
72 = Java 8 =
73
74 XWiki require Java 8 since XWiki 8.1, **OpenJDK 8** will be automatically installed as dependency on recent distributions.
75
76 {{warning}}
77 In some cases Java 11 might be installed and activated by default. If you have both Java version (8 and 11) in your distribution, you can modify ##/etc/default/tomcat8## to point to a java8 JAVA_HOME
78 {{/warning}}
79
80 For some older distributions the problem is that Ubuntu and Debian did not bothered put OpenJDK 8 on older but still supported distributions default repositories (for example Ubuntu 14.04 or Debian Wheezy/Jessie). For those you will have to make sure there is some repository with it so that Java 8 is installed as a package so that XWiki find it as dependency.
81
82 Also if you have several versions of Java installed you might need to explicitly tell Tomcat which one to use after the install. See [[Tomcat Usability section>>||anchor="HJavaVersion"]].
83
84 Here is a few helpers for specific distributions:
85
86 == Ubuntu 14.04 (Trusty Tahr), Debian < 9 ==
87
88 * AdoptOpenJDK provide a Debian repository to install OpenJDK, see https://adoptopenjdk.net/installation.html#linux-pkg
89
90 = Complete Installation =
91
92 {{warning}}
93 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.
94 {{/warning}}
95
96 == Using MySQL ==
97
98 You only have to run this command to install all the interesting components.
99
100 {{code language="bash"}}
101 sudo apt-get install xwiki-tomcat9-mysql
102 {{/code}}
103
104 This package depends on xwiki-common, xwiki-tomcat9-common, xwiki-mysql-common, mysql-server, tomcat9 and libmysql-java. You might have to select a different version of Tomcat depending on what's available in your system repository.
105
106 During the installation, you may have some questions from dbconfig, in charge of the configuration of the database. Don't confuse it with the MySQL root password prompt, which beg you to put a password for the superuser.
107 DBconfig prompt is about the configuration of xwiki and mysql. If you haven't any mysql already installed and you aren't familiar with it, you should let dbconfig handle this.
108
109 DBconfig is then asking you for the mysql root password (you may have entered before). Then, you can choose the password for the "xwiki" mysql user. This user will be used to connect from XWiki application. Choose it wisely, but you don't have to pay a lot of attention to it, because after that, dbconfig is configuring XWiki automatically with these credentials.
110
111 The installation now ends, with the automatic start of tomcat daemon ("Starting Tomcat servlet engine tomcat9 [OK]").
112
113 {{warning}}
114 Note that your wiki is absolutely empty, like a WAR installation. Distribution Wizard will take care of the rest.
115 {{/warning}}
116
117 == Using PostgreSQL ==
118
119 It's as simple as the MySQL installation, you only need to choose the right virtual package.
120
121 {{code language="bash"}}
122 sudo apt-get install xwiki-tomcat9-pgsql
123 {{/code}}
124
125 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##
126
127 PostgreSQL is slightly different than MySQL in the handling of databases and in the manual configuration, but everything should work on the first try.
128
129 == Security settings ==
130
131 1. (((
132 Open ##/etc/xwiki/xwiki.cfg## file and change lines:
133
134 {{code language="none"}}
135 ...
136 #-# Cookie encryption keys. You SHOULD replace these values with any random string,
137 #-# as long as the length is the same.
138 xwiki.authentication.validationKey=your1stkeyhere
139 xwiki.authentication.encryptionKey=your2ndkeyhere
140 ...
141 {{/code}}
142 )))
143 1. (((
144 If you need, add password to the built-in superadmin account, by changing line:
145
146 {{code language="none"}}
147 ...
148 #-# Enable to allow superadmin. It is disabled by default as this could be a
149 #-# security breach if it were set and you forgot about it. Should only be enabled
150 #-# for recovering the Wiki when the rights are completely messed.
151 xwiki.superadminpassword=yourpassword
152 ...
153 {{/code}}
154 )))
155
156 == Tomcat Usability ==
157
158 You can find various generic advices and troubleshooting related to Tomcat on https://www.xwiki.org/xwiki/bin/view/Documentation/AdminGuide/Installation/InstallationWAR/InstallationTomcat/.
159
160 === Java Version ===
161
162 Make sure Tomcat is executed with the right [[Java version>>platform:AdminGuide.Installation||anchor="HHardwareandSoftwarerequirements"]].
163
164 This is usually indicated in the file ##/etc/default/tomcat8## (or ##/etc/default/tomcat7## for Tomcat 7, etc).
165
166 === Memory ===
167
168 The default Tomcat memory setup is too low for XWiki's needs.
169
170 You can change it in the file ##/etc/default/tomcat8## (or ##/etc/default/tomcat7## for Tomcat 7, etc).
171
172 Modify the property ##JAVA_OPTS##. For example:
173
174 {{code language="none"}}
175 JAVA_OPTS="-Djava.awt.headless=true -Xmx1024m"
176 {{/code}}
177
178 You should [[check the Memory settings we recommend>>platform:AdminGuide.Performances||anchor="HMemory"]].
179
180 === /dev/urandom ===
181
182 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:
183
184 * edit ##/etc/default/tomcat8## file and add
185
186 {{code language="bash"}}
187 JAVA_OPTS="${JAVA_OPTS} -Djava.security.egd=file:/dev/./urandom"
188 {{/code}}
189
190 = Concluding Step =
191
192 {{include reference="Documentation.AdminGuide.Installation.InstallationConcludingSteps.WebHome"/}}
193
194 = Uninstallation =
195
196 If you want to remove XWiki from your system, you only have to uninstall the package you've installed at the beginning of this documentation. For example:
197
198 {{code language="bash"}}
199 sudo apt-get --purge remove xwiki-common
200 {{/code}}
201
202 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
203
204 {{code language="bash"}}
205 sudo apt-get --purge autoremove
206 {{/code}}
207
208 = Troubleshooting =
209
210 == Tomcat ==
211
212 See [[Tomcat Installation>>platform:AdminGuide.InstallationTomcat||anchor="HTroubleshooting"]] for generic Tomcat related issues.
213
214 === Ubuntu 16.04 (Xenial Xerus) ===
215
216 At time of writing the version of Tomcat provide by Ubuntu 16.04 repository has a serious classloader related bug which makes impossible to use code macro or write Python scripts in XWiki. See https://bugs.launchpad.net/ubuntu/+source/tomcat8/+bug/1644144 and https://forum.xwiki.org/t/code-macro-requirements/909/20 for some more detailed explanations and workarounds.
217
218 {{code language="bash"}}
219 sudo add-apt-repository ppa:nacc/tomcat8v2
220 sudo apt-get update
221 sudo apt-get install tomcat8=8.0.32-1ubuntu1.3~ppa2
222 sudo apt-get install tomcat8-common=8.0.32-1ubuntu1.3~ppa2
223 sudo apt-get install libtomcat8-java=8.0.32-1ubuntu1.3~ppa2
224 sudo service tomcat8 restart
225 {{/code}}
226
227 Don't hesitate to click on "This bug affects me" on launchpad page if it's still not fixed, might help speeding up things...
228
229 == MySQL ==
230
231 See [[MySQL Installation>>platform:AdminGuide.InstallationMySQL||anchor="HTroubleshooting"]] for generic MySQL related issues.
232
233 == PostgreSQL ==
234
235 See [[PostgreSQL Installation>>platform:AdminGuide.InstallationPostgreSQL||anchor="HTroubleshooting"]] for generic PostgreSQL related issues.
236
237 === Bad version of PostgreSQL driver on Debian Wheezy ===
238
239 The version of the PostgreSQL driver on Debian Wheezy is the 9.1 (at least when writing those lines) which does not work well with XWiki. You will have to upgrade it.
240
241 The latest JDBC postgres driver is available at https://jdbc.postgresql.org/download.html , at the time of this writing, the latest version is postgresql-9.4-1201.jdbc41.jar (which works fine with xwiki), you need to download the driver to your server, a good place is where the other drivers are: /usr/share/java, then remove the symlink postgresql-jdbc4.jar and replace it by one to the new driver:
242
243 {{code}}
244 wget -O /usr/share/java/postgresql-9.4-1201.jdbc41.jar https://jdbc.postgresql.org/download/postgresql-9.4-1201.jdbc41.jar
245 rm /usr/share/java/postgresql-jdbc4.jar
246 ln -s /usr/share/java/postgresql-9.4-1201.jdbc41.jar /usr/share/java/postgresql-jdbc4.jar
247 {{/code}}
248
249 Restart tomcat and you will not have any issue with the JDBC driver.
250
251 == XWiki won't start and I get Solr related error(s) in the log ==
252
253 There is no automatic migration of Solr schema and it changes from time to time. The simplest fix in such case is usually to stop Tomcat, delete the folder ##/var/lib/xwiki/data/solr## and restart Tomcat. XWiki will automatically create a new one and start indexing the wiki.
254
255 {{code language="bash"}}
256 sudo /etc/init.d/tomcat8 stop
257 rm -rf /var/lib/xwiki/data/solr
258 sudo /etc/init.d/tomcat8 start
259 {{/code}}
260
261 = Other useful info =
262
263 == XWiki as root webapp (short URLs) ==
264
265 {{warning}}
266 When doing it make sure to check after upgrade if all is OK in /etc/tomcat8/Catalina/localhost folder (xwiki.xml might be restored).
267 {{/warning}}
268
269 * Rename file ##/etc/tomcat7/Catalina/localhost/xwiki.xml## into ##/etc/tomcat8/Catalina/localhost/ROOT.xml##
270 * Edit file ##/etc/xwiki/xwiki-tomcat8.xml## (or ##/etc/xwiki/xwiki-tomcat7.xml## depending on your tomcat version) and modify ##Context## XML element path from ##/xwiki## to ##/## as in moving from(((
271 {{code language="xml"}}
272 <Context path="/xwiki" docBase="/usr/lib/xwiki" privileged="true" allowLinking="true" crossContext="true">
273 <!-- make symlinks work in Tomcat -->
274 <Resources className="org.apache.naming.resources.FileDirContext" allowLinking="true" />
275 </Context>
276 {{/code}}
277
278 to
279
280 {{code language="xml"}}
281 <Context path="/" docBase="/usr/lib/xwiki" privileged="true" allowLinking="true" crossContext="true">
282 <!-- make symlinks work in Tomcat -->
283 <Resources className="org.apache.naming.resources.FileDirContext" allowLinking="true" />
284 </Context>
285 {{/code}}
286 )))
287 * Edit file ##/etc/xwiki/xwiki.cfg## and uncomment {{code language="properties"}}xwiki.webapppath={{/code}}
288
289 Note that this is only the part of Short URL which is specific to the Debian setup, for the rest you will have to look at [[the generic documentation>>doc:Documentation.AdminGuide.ShortURLs.WebHome]].
290
291 == Integrate with LibreOffice ==
292
293 Install libreoffice with {{code language="none"}}sudo apt-get install libreoffice{{/code}}.
294
295 And setup XWiki to automatically start and access libreoffice in ##/etc/xwiki/xwiki.properties##:
296
297 {{code language="properties"}}
298 openoffice.autoStart=true
299 openoffice.homePath=/usr/lib/libreoffice/
300 {{/code}}
301
302 See [[Office Importer Application>>extensions:Extension.Office Importer Application]] for more details.
303
304 = Overview of the important files =
305
306 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.
307
308 == XWiki ==
309
310 **/etc/xwiki/**
311
312 * hibernate.cfg.xml //Hibernate configuration, helping to configure the database resources//
313 * xwiki.cfg
314 * xwiki.properties
315
316 **/usr/lib/xwiki/**
317
318 * META-INF
319 * resources
320 * skins
321 * templates
322 * WEB-INF
323 ** hibernate.cfg.xml -> /etc/xwiki/hibernate.cfg.xml
324 ** xwiki.cfg -> /etc/xwiki/xwiki.cfg
325 ** xwiki.properties -> /etc/xwiki/xwiki.properties
326
327 == Tomcat ==
328
329 **/etc/tomcat##<version>##/**
330
331 * context.xml
332 * logging.properties
333 * server.xml
334 * tomcat-users.xml
335 * web.xml
336
337 **/etc/default/**
338
339 * tomcat##<version>## //This file helps configuring the Tomcat daemon. Every change needs a restart to be effective//
340
341 **/etc/init.d/**
342
343 * tomcat##<version>## //Daemon start/stop script//
344
345 **/var/lib/tomcat##<version>##/**
346
347 * common
348 * conf -> /etc/tomcat##<version>##
349 * logs -> ../../log/tomcat##<version>##
350 * server
351 * shared
352 * webapps
353
354 **/var/log/tomcat##<version>##/**
355
356 * catalina.out //First logging file. Check this one if you're experiencing troubles with Tomcat/XWiki.//
357 * localhost.<date>.log // "Container Log file": Start of each filter and failures thereof are listed.//
358
359 == MySQL ==
360
361 **/etc/mysql/**
362
363 * debian.cnf
364 * my.cnf //Database configuration. Max_allowed_packet is the parameter you need to change to improve upload data size.// permitted.
365
366 **/var/lib/mysql/**
367
368 * mysql
369 * xwiki //This is the xwiki database. You may want to backup this directory from time to time.//
370
371 **/var/log/**
372
373 * syslog
374 * mysql
375 ** error.log
376
377 == PostgreSQL ==
378
379 **/etc/postgresql/**
380
381 * ##<version>##
382 ** main
383 *** postgresql.conf
384 *** pg_hba.conf
385
386 **/var/lib/postgresql/##<version>##/main/**
387
388 * 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