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

Get Connected