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
Vincent Massol 134.2 5 This distribution allows installing XWiki and every component needed for a production instance automatically.
Guillaume Fenollar 1.1 6
Vincent Massol 134.2 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.
Guillaume Fenollar 1.1 8
Jan-Paul Kleijn 217.2 9 == APT Configuration ==
Guillaume Fenollar 1.1 10
Thomas Mortagne 196.3 11 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 12
Thomas Mortagne 18.1 13 {{code language="bash"}}
Thomas Mortagne 209.1 14 sudo wget https://maven.xwiki.org/xwiki-keyring.gpg -O /usr/share/keyrings/xwiki-keyring.gpg
15 sudo wget "https://maven.xwiki.org/stable/xwiki-stable.list" -O /etc/apt/sources.list.d/xwiki-stable.list
Guillaume Fenollar 1.1 16 {{/code}}
17
Thomas Mortagne 44.1 18 {{info}}
19 Note that there is several repositories you can choose (as alternatives to the stable one you have in the previous example):
Thomas Mortagne 112.1 20
Jean-Sébastien Dennebouy 198.1 21 * [[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)
22 * [[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)
23 * [[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 24 {{/info}}
25
Guillaume Fenollar 1.1 26 Now you can update the packages database to read the data from this repository.
27
Thomas Mortagne 18.1 28 {{code language="bash"}}
29 sudo apt-get update
30 {{/code}}
31
Guillaume Fenollar 1.1 32 Now you can make a little search to see what this repo offers.
33
Thomas Mortagne 18.1 34 {{code language="bash"}}
Guillaume Fenollar 1.1 35 apt-cache search xwiki
36 {{/code}}
37
Thomas Mortagne 54.1 38 It shows the following packages (the exact list depends on the version the repository contains):
Guillaume Fenollar 2.1 39
Thomas Mortagne 111.1 40 * xwiki-common - XWiki, you can install this if you want to take care yourself of the database and application server
Thomas Mortagne 168.1 41 * xwiki-mariadb-common - XWiki MariaDB common package, you can install this if you want to take care yourself of the application server
Thomas Mortagne 103.1 42 * xwiki-mysql-common - XWiki MySQL common package, you can install this if you want to take care yourself of the application server
43 * xwiki-pgsql-common - XWiki PostgreSQL common package, you can install this if you want to take care yourself of the application server
Thomas Mortagne 109.1 44 * xwiki-tomcat8-common - XWiki Tomcat 8 common package, you can install this if you want to take care yourself of the database link
Joan 145.2 45 * 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 168.1 46 * xwiki-tomcat8-mariadb - XWiki Tomcat 8/MariaDB based package
47 * xwiki-tomcat9-mariadb - XWiki Tomcat 9/MariaDB based package
Thomas Mortagne 110.1 48 * xwiki-tomcat8-mysql - XWiki Tomcat 8/MySQL based package
Joan 145.2 49 * xwiki-tomcat9-mysql - XWiki Tomcat 9/MySQL based package
Thomas Mortagne 110.1 50 * xwiki-tomcat8-pgsql - XWiki Tomcat 8/PostgreSQL
Joan 145.2 51 * xwiki-tomcat9-pgsql - XWiki Tomcat 9/PostgreSQL
Thomas Mortagne 181.1 52 * xwiki-solr-all - An entry point package which a dependency on all the solr core required to setup a standalone version compatible with XWiki Standard
Thomas Mortagne 174.1 53 * xwiki-solr-core - A pre configured Solr core for the XWiki search feature
54 * xwiki-solr-events - A pre configured Solr core for the XWiki events/notifications storage
55 * xwiki-solr-ratings - A pre configured Solr core for the XWiki rating storage
Thomas Mortagne 103.1 56
Thomas Mortagne 154.1 57 Plus legacy packages from older versions of XWiki like xwiki-enterprise-* packages or for unsupported versions of Tomcat.
Thomas Mortagne 103.1 58
Craig Wright 117.1 59 {{error}}
Thomas Mortagne 207.1 60 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.)
Craig Wright 117.1 61 {{/error}}
62
Valdis Vitolins 42.1 63 {{info}}
64 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.
65 {{/info}}
Valdis Vitolins 41.1 66
Thomas Mortagne 134.1 67 {{warning}}
68 On Ubuntu you will need [[##universe## repository>>https://help.ubuntu.com/community/Repositories/CommandLine]] to install Tomcat packages. It's generally enabled by default.
69 {{/warning}}
70
Jan-Paul Kleijn 217.2 71 == Complete Installation ==
Guillaume Fenollar 1.1 72
Thomas Mortagne 64.1 73 {{warning}}
Thomas Mortagne 89.1 74 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.
Thomas Mortagne 64.1 75 {{/warning}}
76
Jan-Paul Kleijn 217.2 77 === Using MariaDB ===
Guillaume Fenollar 1.1 78
Thomas Mortagne 188.1 79 {{warning}}
Thomas Mortagne 199.1 80 Note that XWiki require at least MariaDB 10.2. If your Debian distribution provide an older version (like Debian Stretch/9) you can use the one from the repositories provided by the MariaDB project to get a more recent version on https://downloads.mariadb.org/mariadb/repositories/.
Thomas Mortagne 188.1 81 {{/warning}}
Thomas Mortagne 185.1 82
Thomas Mortagne 196.4 83 The following will install everything you need to run XWiki with MariaDB and Tomcat 9:
Guillaume Fenollar 1.2 84
Thomas Mortagne 18.1 85 {{code language="bash"}}
Thomas Mortagne 190.1 86 sudo apt-get install xwiki-tomcat9-mariadb
Thomas Mortagne 18.1 87 {{/code}}
88
Jan-Paul Kleijn 216.1 89 This package depends on xwiki-common, xwiki-tomcat9-common, xwiki-mariadb-common, mariadb-server and tomcat9. You might have to select a different version of Tomcat, depending on what's available in your system repository.
Guillaume Fenollar 1.2 90
Jan-Paul Kleijn 216.1 91 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 92
Simon Urli 217.1 93 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 94
Simon Urli 217.1 95 {{warning}}
96 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]]
97 {{/warning}}
98
Jan-Paul Kleijn 216.1 99 The installation ends with the start of the Tomcat daemon ("Starting Tomcat servlet engine tomcat9 [OK]") which is also setup to start automatically from boot.
Guillaume Fenollar 2.1 100
Jan-Paul Kleijn 217.2 101 === Using MySQL ===
Thomas Mortagne 169.1 102
Thomas Mortagne 187.1 103 {{warning}}
Jan-Paul Kleijn 216.1 104 Note that XWiki requires at least MySQL 5.7. This package also works with MariaDB (in which case you need at least MariaDB 10.2).
Thomas Mortagne 187.1 105 {{/warning}}
Thomas Mortagne 186.1 106
Thomas Mortagne 196.4 107 The following will install everything you need to run XWiki with MySQL and Tomcat 9:
Thomas Mortagne 169.1 108
109 {{code language="bash"}}
Thomas Mortagne 190.1 110 sudo apt-get install xwiki-tomcat9-mysql
Thomas Mortagne 169.1 111 {{/code}}
112
Jan-Paul Kleijn 216.1 113 This package depends on xwiki-common, xwiki-tomcat9-common, xwiki-mysql-common, mysql-server and tomcat9. You might have to select a different version of Tomcat, depending on what's available in your system repository.
Thomas Mortagne 169.1 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 MySQL database. Don't confuse it with the MySQL root password prompt that asks you for a root password (which is intented for the superuser). If you haven't already installed any MySQL databases and you are not familiar with it you should let DBconfig handle this.
Thomas Mortagne 169.1 116
Simon Urli 217.1 117 Afterwards DBconfig asks you for the MySQL root password for the "xwiki" MySQL user. This user will be used to connect to MySQL 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.
Thomas Mortagne 169.1 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
Jan-Paul Kleijn 216.1 123 The installation ends with the start of the Tomcat daemon ("Starting Tomcat servlet engine tomcat9 [OK]") which is also setup to start automatically from boot.
Thomas Mortagne 169.1 124
Jan-Paul Kleijn 217.2 125 === Using PostgreSQL ===
Guillaume Fenollar 4.1 126
Manuel Smeria 25.3 127 It's as simple as the MySQL installation, you only need to choose the right virtual package.
Guillaume Fenollar 4.1 128
Thomas Mortagne 18.1 129 {{code language="bash"}}
Thomas Mortagne 150.1 130 sudo apt-get install xwiki-tomcat9-pgsql
Thomas Mortagne 18.1 131 {{/code}}
132
Jan-Paul Kleijn 212.2 133 PostgreSQL is slightly different than MySQL in the handling of databases and in the manual configuration, but everything should work on the first try.
134
Jan-Paul Kleijn 217.2 135 === Starting up XWiki for the first time... ===
Jan-Paul Kleijn 212.2 136
Jan-Paul Kleijn 212.3 137 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 138
Jan-Paul Kleijn 216.1 139 {{warning}}
140 Note that your wiki is absolutely empty, like a WAR installation. Distribution Wizard will take care of the rest.
141 {{/warning}}
142
Jan-Paul Kleijn 217.2 143 == Security ==
Jan-Paul Kleijn 212.3 144
Jan-Paul Kleijn 217.2 145 === Security settings of XWiki ===
Jan-Paul Kleijn 212.3 146
Thomas Mortagne 45.1 147 1. (((
148 Open ##/etc/xwiki/xwiki.cfg## file and change lines:
Valdis Vitolins 43.1 149
150 {{code language="none"}}
151 ...
152 #-# Cookie encryption keys. You SHOULD replace these values with any random string,
153 #-# as long as the length is the same.
154 xwiki.authentication.validationKey=your1stkeyhere
155 xwiki.authentication.encryptionKey=your2ndkeyhere
156 ...
Thomas Mortagne 45.1 157 {{/code}}
158 )))
159 1. (((
160 If you need, add password to the built-in superadmin account, by changing line:
Valdis Vitolins 43.1 161
162 {{code language="none"}}
163 ...
164 #-# Enable to allow superadmin. It is disabled by default as this could be a
165 #-# security breach if it were set and you forgot about it. Should only be enabled
Jan-Paul Kleijn 217.2 166 #-# for recovering of XWiki when the rights are completely messed.
Valdis Vitolins 43.1 167 xwiki.superadminpassword=yourpassword
168 ...
Thomas Mortagne 45.1 169 {{/code}}
170 )))
Valdis Vitolins 43.1 171
Jan-Paul Kleijn 217.2 172 == Performance ==
Guillaume Fenollar 11.1 173
Jan-Paul Kleijn 217.2 174 === Tomcat ===
175
Vincent Massol 167.2 176 You can find [[various generic advices and troubleshooting related to Tomcat>>Documentation.AdminGuide.Installation.InstallationWAR.InstallationTomcat.WebHome]].
Thomas Mortagne 142.1 177
Thomas Mortagne 78.1 178 === Java Version ===
179
Vincent Massol 105.3 180 Make sure Tomcat is executed with the right [[Java version>>platform:AdminGuide.Installation||anchor="HHardwareandSoftwarerequirements"]].
Thomas Mortagne 78.1 181
Thomas Mortagne 172.1 182 This is usually indicated in the file ##/etc/default/tomcat9## (or ##/etc/default/tomcat8## for Tomcat 8, etc).
Thomas Mortagne 78.1 183
184 === Memory ===
185
Vincent Massol 119.2 186 The default Tomcat memory setup is too low for XWiki's needs.
Guillaume Fenollar 11.1 187
Thomas Mortagne 172.1 188 You can change it in the file ##/etc/default/tomcat9## (or ##/etc/default/tomcat8## for Tomcat 8, etc).
Guillaume Fenollar 11.1 189
Thomas Mortagne 71.1 190 Modify the property ##JAVA_OPTS##. For example:
Thomas Mortagne 18.1 191
Thomas Steinbach 25.1 192 {{code language="none"}}
Thomas Mortagne 94.1 193 JAVA_OPTS="-Djava.awt.headless=true -Xmx1024m"
Thomas Steinbach 25.1 194 {{/code}}
Thomas Mortagne 18.1 195
Thomas Mortagne 194.1 196 You should [[check the Memory settings we recommend>>Documentation.AdminGuide.Performances||anchor="HMemory"]].
Guillaume Fenollar 11.1 197
Thomas Mortagne 139.1 198 === /dev/urandom ===
199
Thomas Mortagne 144.1 200 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:
Thomas Mortagne 139.1 201
Thomas Mortagne 172.1 202 * edit ##/etc/default/tomcat9## file and add
Thomas Mortagne 139.1 203
Thomas Mortagne 140.1 204 {{code language="bash"}}
Thomas Mortagne 143.1 205 JAVA_OPTS="${JAVA_OPTS} -Djava.security.egd=file:/dev/./urandom"
Thomas Mortagne 140.1 206 {{/code}}
207
Jan-Paul Kleijn 217.2 208 == Concluding Step ==
Thomas Mortagne 50.1 209
Vincent Massol 114.2 210 {{include reference="Documentation.AdminGuide.Installation.InstallationConcludingSteps.WebHome"/}}
Thomas Mortagne 50.1 211
Jan-Paul Kleijn 217.2 212 == Uninstallation ==
Guillaume Fenollar 4.1 213
Guillaume Fenollar 10.1 214 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:
215
Thomas Mortagne 27.1 216 {{code language="bash"}}
Thomas Mortagne 103.1 217 sudo apt-get --purge remove xwiki-common
Thomas Mortagne 27.1 218 {{/code}}
219
Thomas Mortagne 95.1 220 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 221
Manuel Smeria 25.3 222 {{code language="bash"}}
Thomas Mortagne 96.1 223 sudo apt-get --purge autoremove
Manuel Smeria 25.3 224 {{/code}}
Guillaume Fenollar 10.1 225
Jan-Paul Kleijn 219.1 226 == Troubleshooting ==
Thomas Mortagne 77.1 227
Jan-Paul Kleijn 220.1 228 === Log file location ===
Jan-Paul Kleijn 217.2 229
230 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 Tomcat 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 Tomcat versions.
231
232 **Tomcat8**
233
234 {{code language="none"}}
235 /var/log/tomcat8/Catalina.[date].log
236 {{/code}}
237
238 **Tomcat9**
239
240 {{code language="none"}}
241 /var/log/tomcat9/Catalina.[date].log
242 {{/code}}
243
Thomas Mortagne 162.1 244 You can find a generic Troubleshooting section on [[https://www.xwiki.org/xwiki/bin/view/Documentation/AdminGuide/Installation/#HTroubleshooting]].
245
Jan-Paul Kleijn 217.2 246 === No package can be found for Java ===
Thomas Mortagne 196.3 247
Thomas Mortagne 208.1 248 XWiki require at least Java 8 since XWiki 8.1 and Java 11 since XWiki 14.0, **OpenJDK 11** (the recommended version) will be automatically installed as dependency on recent distributions.
Thomas Mortagne 196.3 249
Thomas Mortagne 211.1 250 If your Debian based distribution does not provide any package for the Java version you need you can try with:
Thomas Mortagne 196.3 251
Thomas Mortagne 211.1 252 * Adoptium provides a Debian repository to install Temurin (OpenJDK), see https://adoptium.net/installation/linux/#_eclipse_temurin_package_names
Thomas Mortagne 196.3 253
Jan-Paul Kleijn 217.2 254 === I get an error when using the chart macro ===
Thomas Mortagne 77.1 255
Thomas Mortagne 191.1 256 The chart macro doesn't appear to be working with a clean install with the openjdk 8 Debian package (openjdk 11, which is the recommended version, does not seems to be affected). It gives an error:
Thomas Mortagne 77.1 257
Thomas Mortagne 162.1 258 > Failed to execute the [chart] macro. Cause: [Could not initialize class org.jfree.chart.JFreeChart].
Thomas Mortagne 126.1 259
Thomas Mortagne 205.1 260 In some Debian/Ubuntu versions a broken accessibility option is enabled by default on Java 8 and it's what is causing this error. See https://jira.xwiki.org/browse/XWIKI-16993 and https://bugs.launchpad.net/ubuntu/+source/openjdk-6/+bug/935296 for more details.
Thomas Mortagne 126.1 261
Thomas Mortagne 162.1 262 To disable it go to ##/etc/java-8-openjdk/accessibility.properties## (or another path depending on your version of Java) and comment the line:
263
264 {{code language="properties"}}
Thomas Mortagne 166.1 265 # assistive_technologies=org.GNOME.Accessibility.AtkWrapper
Thomas Mortagne 128.1 266 {{/code}}
267
Jan-Paul Kleijn 217.2 268 === Tomcat ===
Thomas Mortagne 128.1 269
Thomas Mortagne 196.1 270 See [[Tomcat Installation>>Documentation.AdminGuide.Installation.InstallationWAR.InstallationTomcat||anchor="HTroubleshooting"]] for generic Tomcat related issues.
Thomas Mortagne 162.1 271
Jan-Paul Kleijn 217.2 272 === MySQL ===
Thomas Mortagne 77.1 273
Thomas Mortagne 195.1 274 See [[MySQL Installation>>Documentation.AdminGuide.Installation.InstallationWAR.InstallationMySQL||anchor="HTroubleshooting"]] for generic MySQL related issues.
Thomas Mortagne 77.1 275
Jan-Paul Kleijn 217.2 276 === PostgreSQL ===
Thomas Mortagne 77.1 277
Thomas Mortagne 193.1 278 See [[PostgreSQL Installation>>Documentation.AdminGuide.Installation.InstallationWAR.InstallationPostgreSQL||anchor="HTroubleshooting"]] for generic PostgreSQL related issues.
Thomas Mortagne 77.1 279
Jan-Paul Kleijn 217.2 280 == Other useful info ==
Thomas Mortagne 77.1 281
Jan-Paul Kleijn 217.2 282 === XWiki as root webapp (short URLs) ===
Thomas Mortagne 77.1 283
Jan-Paul Kleijn 221.3 284 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 285
Jan-Paul Kleijn 217.2 286 ==== For Tomcat 9 ====
Vincent Massol 200.2 287
Thomas Mortagne 77.1 288 {{warning}}
Thomas Mortagne 167.1 289 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 290 {{/warning}}
291
Thomas Mortagne 167.1 292 * Rename file ##/etc/tomcat9/Catalina/localhost/xwiki.xml## into ##/etc/tomcat9/Catalina/localhost/ROOT.xml##
293 * 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 294 {{code language="xml"}}
Thomas Mortagne 167.1 295 <Context path="/xwiki" docBase="/usr/lib/xwiki"
296 containerSciFilter="org.apache.tomcat.websocket.server.WsSci|org.apache.jasper.servlet.JasperInitializer">
Thomas Mortagne 77.1 297 {{/code}}
298
299 to
300
301 {{code language="xml"}}
Vincent Massol 212.1 302 <Context path="" docBase="/usr/lib/xwiki"
Thomas Mortagne 167.1 303 containerSciFilter="org.apache.tomcat.websocket.server.WsSci|org.apache.jasper.servlet.JasperInitializer">
Thomas Mortagne 77.1 304 {{/code}}
305 )))
306 * Edit file ##/etc/xwiki/xwiki.cfg## and uncomment {{code language="properties"}}xwiki.webapppath={{/code}}
Jan-Paul Kleijn 221.2 307 * Restart Tomcat 9.
Thomas Mortagne 77.1 308
Jan-Paul Kleijn 217.2 309 === Integrate with LibreOffice ===
Thomas Mortagne 77.1 310
Thomas Mortagne 97.1 311 Install libreoffice with {{code language="none"}}sudo apt-get install libreoffice{{/code}}.
Thomas Mortagne 77.1 312
313 And setup XWiki to automatically start and access libreoffice in ##/etc/xwiki/xwiki.properties##:
314
315 {{code language="properties"}}
316 openoffice.autoStart=true
317 openoffice.homePath=/usr/lib/libreoffice/
318 {{/code}}
319
320 See [[Office Importer Application>>extensions:Extension.Office Importer Application]] for more details.
321
Jan-Paul Kleijn 217.2 322 === Standalone Solr setup ===
Thomas Mortagne 159.1 323
Thomas Mortagne 205.1 324 Take a look at [[Solr documentation>>https://solr.apache.org/guide/8_8/taking-solr-to-production.html]] to install it.
Thomas Mortagne 159.1 325
Thomas Mortagne 200.1 326 Then you will need to add the XWiki schema configuration: you should install the package ##xwiki-solr-all## to automatically register the Solr cores needed by XWiki Standard in the Solr server (provided the standard setup was used).
Thomas Mortagne 159.1 327
Jan-Paul Kleijn 217.2 328 == Overview of the important files ==
Guillaume Fenollar 4.1 329
Manuel Smeria 25.3 330 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 331
Jan-Paul Kleijn 217.2 332 === XWiki ===
Guillaume Fenollar 4.1 333
Thomas Mortagne 152.1 334 The configuration: **/etc/xwiki/**
Guillaume Fenollar 4.1 335
Thomas Mortagne 156.1 336 * hibernate.cfg.xml //Hibernate configuration, helping to configure the database resources//
Thomas Mortagne 152.1 337 * xwiki.cfg
Thomas Mortagne 98.1 338 * xwiki.properties
Thomas Mortagne 184.1 339 * xwiki-tomcat9-systemd.conf // Injected trough ##/etc/systemd/system/tomcat9.service.d/xwiki-tomcat-systemd.conf##// in the tomcat9 service configuration
340 * xwiki-tomcat<version> // The Tomcat integration linked from ##/etc/tomcat<version>/Catalina/localhost##//
Thomas Mortagne 98.1 341
Thomas Mortagne 153.1 342 The permanent directory: **/var/lib/xwiki/data**
Guillaume Fenollar 4.1 343
Thomas Mortagne 153.1 344 The home directory: **/usr/lib/xwiki/**
345
Thomas Mortagne 98.1 346 * META-INF
347 * resources
348 * skins
349 * templates
350 * WEB-INF
351 ** hibernate.cfg.xml -> /etc/xwiki/hibernate.cfg.xml
352 ** xwiki.cfg -> /etc/xwiki/xwiki.cfg
353 ** xwiki.properties -> /etc/xwiki/xwiki.properties
354
Jan-Paul Kleijn 217.2 355 === Tomcat ===
Guillaume Fenollar 4.1 356
Thomas Mortagne 99.1 357 **/etc/tomcat##<version>##/**
Guillaume Fenollar 4.1 358
Thomas Mortagne 99.1 359 * context.xml
360 * logging.properties
361 * server.xml
362 * tomcat-users.xml
363 * web.xml
364
Guillaume Fenollar 12.1 365 **/etc/default/**
Guillaume Fenollar 4.1 366
Thomas Mortagne 99.1 367 * tomcat##<version>## //This file helps configuring the Tomcat daemon. Every change needs a restart to be effective//
368
369 **/var/lib/tomcat##<version>##/**
Guillaume Fenollar 4.1 370
Thomas Mortagne 99.1 371 * common
372 * conf -> /etc/tomcat##<version>##
Jean-Sébastien Dennebouy 198.1 373 * logs -> ../../log/tomcat##<version>     //Note that starting Debian 10 and Ubuntu 18.04 systemd service log is used//##
Thomas Mortagne 99.1 374 * server
375 * shared
376 * webapps
377
378 **/var/log/tomcat##<version>##/**
379
380 * catalina.out //First logging file. Check this one if you're experiencing troubles with Tomcat/XWiki.//
Paul Libbrecht 106.1 381 * localhost.<date>.log // "Container Log file": Start of each filter and failures thereof are listed.//
Thomas Mortagne 99.1 382
Jan-Paul Kleijn 217.2 383 === MySQL ===
Guillaume Fenollar 4.1 384
385 **/etc/mysql/**
386
Thomas Mortagne 99.1 387 * debian.cnf
388 * my.cnf //Database configuration. Max_allowed_packet is the parameter you need to change to improve upload data size.// permitted.
389
Guillaume Fenollar 4.1 390 **/var/lib/mysql/**
391
Thomas Mortagne 99.1 392 * mysql
393 * xwiki //This is the xwiki database. You may want to backup this directory from time to time.//
394
Guillaume Fenollar 4.1 395 **/var/log/**
396
Thomas Mortagne 99.1 397 * syslog
398 * mysql
399 ** error.log
400
Jan-Paul Kleijn 217.2 401 === PostgreSQL ===
Guillaume Fenollar 4.1 402
403 **/etc/postgresql/**
404
Thomas Mortagne 99.1 405 * ##<version>##
406 ** main
407 *** postgresql.conf
408 *** pg_hba.conf
409
410 **/var/lib/postgresql/##<version>##/main/**
411
412 * base

Get Connected