Wiki source code of Installation using Debian/Ubuntu (.DEB) packages
Last modified by Eleni Cojocariu on 2026/08/13 15:14
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
11.1 | 1 | {{box cssClass="floatinginfobox" title="**Contents**"}} |
 |
221.1 | 2 | {{toc start="2"/}} |
| |
11.1 | 3 | {{/box}} |
| 4 | |||
 |
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 | |||
| |
217.2 | 9 | == APT Configuration == |
| |
1.1 | 10 | |
| |
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: |
| |
1.1 | 12 | |
| |
18.1 | 13 | {{code language="bash"}} |
| |
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 | ||
| |
1.1 | 16 | {{/code}} |
| 17 | |||
| |
44.1 | 18 | {{info}} |
| |
250.1 | 19 | Note that there are several repositories you can choose (as alternatives to the stable one you have in the previous example): |
| |
112.1 | 20 | |
 |
258.2 | 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 (unstable). |
| 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]]: all released Cycle LTS versions. | ||
| |
260.1 | 24 | * [[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). |
| |
258.2 | 25 | |
| 26 | Check out the the [[Support page>>xwiki:Main.Support]] for more information on the various branches we support. | ||
| |
44.1 | 27 | {{/info}} |
| 28 | |||
| |
1.1 | 29 | Now you can update the packages database to read the data from this repository. |
| 30 | |||
| |
18.1 | 31 | {{code language="bash"}} |
| |
273.1 | 32 | sudo apt update |
| |
18.1 | 33 | {{/code}} |
| 34 | |||
| |
1.1 | 35 | Now you can make a little search to see what this repo offers. |
| 36 | |||
| |
18.1 | 37 | {{code language="bash"}} |
| |
274.1 | 38 | apt search xwiki |
| |
1.1 | 39 | {{/code}} |
| 40 | |||
| |
262.1 | 41 | * Common package not tied to any application server or database |
| |
227.2 | 42 | ** ##xwiki-common## - XWiki, you can install this if you want to take care yourself of the database and application server |
| |
262.1 | 43 | |
| 44 | * Common packages not tied to any application server | ||
| |
227.2 | 45 | ** ##xwiki-mariadb-common## - XWiki MariaDB common package, you can install this if you want to take care yourself of the application server |
| 46 | ** ##xwiki-mysql-common## - XWiki MySQL common package, you can install this if you want to take care yourself of the application server | ||
| 47 | ** ##xwiki-pgsql-common## - XWiki PostgreSQL common package, you can install this if you want to take care yourself of the application server | ||
| |
2.1 | 48 | |
| |
249.1 | 49 | * Packages based on a customized Jetty packaged for XWiki |
| |
227.2 | 50 | ** ##xwiki-xjetty-common## - XWiki Jetty common package, you can install this if you want to take care yourself of the database link |
| 51 | ** ##xwiki-xjetty-mariadb## - XWiki Jetty/MariaDB based package | ||
| 52 | ** ##xwiki-xjetty-mysql## - XWiki Jetty/MySQL based package | ||
| 53 | ** ##xwiki-xjetty-pgsql## - XWiki Jetty/PostgreSQL | ||
| |
103.1 | 54 | |
| |
269.1 | 55 | * Packages based on the standard Tomcat package (they do not include Tomcat, they depend on it so the pacjage you use generally depends on what version of Tomcat is available on your distribution's repositories) |
| |
247.1 | 56 | ** ##xwiki-tomcat10-common## - XWiki Tomcat 10 common package, you can install this if you want to take care yourself of the database link |
| 57 | ** ##xwiki-tomcat10-mariadb## - XWiki Tomcat 10/MariaDB based package | ||
| 58 | ** ##xwiki-tomcat10-mysql## - XWiki Tomcat 10/MySQL based package | ||
| 59 | ** ##xwiki-tomcat10-pgsql## - XWiki Tomcat 10/PostgreSQL | ||
| |
269.1 | 60 | ** ##xwiki-tomcat11-common## - XWiki Tomcat 11 common package, you can install this if you want to take care yourself of the database link |
| 61 | ** ##xwiki-tomcat11-mariadb## - XWiki Tomcat 11/MariaDB based package | ||
| 62 | ** ##xwiki-tomcat11-mysql## - XWiki Tomcat 11/MySQL based package | ||
| 63 | ** ##xwiki-tomcat11-pgsql## - XWiki Tomcat 11/PostgreSQL | ||
| |
103.1 | 64 | |
| |
234.1 | 65 | * Not really XWiki itself but Solr cores needed when you want to use a standalone Solr instance with XWiki |
| 66 | ** ##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 | ||
| 67 | ** ##xwiki-solr9-search## - A pre configured Solr 9 core for the XWiki search feature | ||
| 68 | ** ##xwiki-solr9-events## - A pre configured Solr 9 core for the XWiki events/notifications storage | ||
| 69 | ** ##xwiki-solr9-ratings## - A pre configured Solr 9 core for the XWiki rating storage | ||
| 70 | ** ##xwiki-solr9-extension_index## - A pre configured Solr 9 core for the XWiki extensions index | ||
| |
227.2 | 71 | |
| |
262.1 | 72 | Plus legacy packages from older versions of XWiki like ##xwiki-enterprise-*## packages or for now unsupported versions of Tomcat. |
| |
227.2 | 73 | |
| |
42.1 | 74 | {{info}} |
| 75 | 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. | ||
| 76 | {{/info}} | ||
| |
41.1 | 77 | |
| |
134.1 | 78 | {{warning}} |
| 79 | On Ubuntu you will need [[##universe## repository>>https://help.ubuntu.com/community/Repositories/CommandLine]] to install Tomcat packages. It's generally enabled by default. | ||
| 80 | {{/warning}} | ||
| 81 | |||
| |
217.2 | 82 | == Complete Installation == |
| |
1.1 | 83 | |
| |
64.1 | 84 | {{warning}} |
| |
252.3 | 85 | 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. |
| |
64.1 | 86 | {{/warning}} |
| 87 | |||
| |
217.2 | 88 | === Using MariaDB === |
| |
1.1 | 89 | |
| |
264.1 | 90 | {{warning}} |
| 91 | Note that XWiki requires at least MariaDB 10.2. | ||
| 92 | {{/warning}} | ||
| 93 | |||
| |
270.1 | 94 | Tomcat: |
| |
1.2 | 95 | |
| |
18.1 | 96 | {{code language="bash"}} |
| |
268.1 | 97 | sudo apt install xwiki-tomcat10-mariadb |
| |
227.2 | 98 | {{/code}} |
| 99 | |||
| |
268.1 | 100 | Xjetty: |
| 101 | |||
| |
248.1 | 102 | {{code language="bash"}} |
| |
268.1 | 103 | sudo apt install xwiki-xjetty-mariadb |
| |
248.1 | 104 | {{/code}} |
| 105 | |||
| |
216.1 | 106 | 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. |
| |
3.1 | 107 | |
 |
217.1 | 108 | 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. |
| |
1.2 | 109 | |
| |
217.1 | 110 | {{warning}} |
| 111 | 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]] | ||
| 112 | {{/warning}} | ||
| 113 | |||
| |
227.2 | 114 | The installation ends with the start of the XWiki or Tomcat daemon which is also setup to start automatically from boot. |
| |
2.1 | 115 | |
| |
217.2 | 116 | === Using MySQL === |
| |
169.1 | 117 | |
| |
187.1 | 118 | {{warning}} |
| |
247.1 | 119 | 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"]]. |
| |
187.1 | 120 | {{/warning}} |
| |
186.1 | 121 | |
| |
270.1 | 122 | Tomcat: |
| |
169.1 | 123 | |
| 124 | {{code language="bash"}} | ||
| |
268.1 | 125 | sudo apt install xwiki-tomcat10-mysql |
| |
169.1 | 126 | {{/code}} |
| 127 | |||
| |
268.1 | 128 | Xjetty: |
| 129 | |||
| |
248.1 | 130 | {{code language="bash"}} |
| |
268.1 | 131 | sudo apt install xwiki-xjetty-mysql |
| |
248.1 | 132 | {{/code}} |
| 133 | |||
| |
227.12 | 134 | Everything else is similar to what is described in the [[the MariaDB section>>||anchor="#HUsingMariaDB"]]. |
| |
169.1 | 135 | |
| |
217.2 | 136 | === Using PostgreSQL === |
| |
4.1 | 137 | |
 |
25.3 | 138 | It's as simple as the MySQL installation, you only need to choose the right virtual package. |
| |
4.1 | 139 | |
| |
270.1 | 140 | Tomcat: |
| |
227.2 | 141 | |
| |
18.1 | 142 | {{code language="bash"}} |
| |
268.1 | 143 | sudo apt install xwiki-tomcat10-pgsql |
| |
227.2 | 144 | {{/code}} |
| 145 | |||
| |
268.1 | 146 | Xjetty: |
| 147 | |||
| |
248.1 | 148 | {{code language="bash"}} |
| |
268.1 | 149 | sudo apt install xwiki-xjetty-pgsql |
| |
248.1 | 150 | {{/code}} |
| 151 | |||
| |
227.12 | 152 | Everything else is similar to what is described in the [[the MariaDB section>>||anchor="#HUsingMariaDB"]]. |
| |
212.2 | 153 | |
| |
217.2 | 154 | === Starting up XWiki for the first time... === |
| |
212.2 | 155 | |
| |
212.3 | 156 | 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]]## |
| |
13.1 | 157 | |
| |
216.1 | 158 | {{warning}} |
| 159 | Note that your wiki is absolutely empty, like a WAR installation. Distribution Wizard will take care of the rest. | ||
| 160 | {{/warning}} | ||
| 161 | |||
| |
217.2 | 162 | == Performance == |
| |
11.1 | 163 | |
| |
227.13 | 164 | === XWiki === |
| 165 | |||
| 166 | You can find various [[various generic advices and troubleshooting related to XWiki>>Documentation.AdminGuide.Performances]]. | ||
| 167 | |||
| |
217.2 | 168 | === Tomcat === |
| 169 | |||
 |
274.3 | 170 | You can find [[various generic advices and troubleshooting related to Tomcat>>documentation.xs.admin.installation.methods.install-xwiki-war.configure-servlet-container.configure-tomcat.WebHome]]. |
| |
142.1 | 171 | |
| |
227.13 | 172 | ==== Java Version ==== |
| |
78.1 | 173 | |
| |
264.2 | 174 | Make sure Tomcat is executed with the right [[Java version>>dev:Community.SupportStrategy.JavaSupportStrategy.WebHome]]. |
| |
78.1 | 175 | |
| |
270.1 | 176 | This is usually indicated in the file ##/etc/default/tomcat10## (or ##/etc/default/tomcat11## for Tomcat 11, etc). |
| |
78.1 | 177 | |
| |
227.13 | 178 | ==== Memory ==== |
| |
78.1 | 179 | |
| |
274.4 | 180 | See [[Java Memory for Tomcat>>documentation.xs.admin.installation.methods.install-xwiki-war.configure-servlet-container.configure-tomcat.java-memory.WebHome||anchor="HLinux-specificalternatives"]]. |
| |
11.1 | 181 | |
| |
217.2 | 182 | == Concluding Step == |
| |
50.1 | 183 | |
| |
114.2 | 184 | {{include reference="Documentation.AdminGuide.Installation.InstallationConcludingSteps.WebHome"/}} |
| |
50.1 | 185 | |
| |
250.2 | 186 | == Upgrading == |
| 187 | |||
| |
275.1 | 188 | {{id name="HUpgrading"/}} |
| |
250.2 | 189 | |
| |
275.1 | 190 | See [[Upgrade XWiki Installed from the Debian Packages>>documentation.xs.admin.upgrade.distribution.upgrade-debian-package.WebHome]]. |
| |
250.3 | 191 | |
| |
217.2 | 192 | == Uninstallation == |
| |
4.1 | 193 | |
| |
242.1 | 194 | 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: |
| |
10.1 | 195 | |
| |
27.1 | 196 | {{code language="bash"}} |
| |
103.1 | 197 | sudo apt-get --purge remove xwiki-common |
| |
27.1 | 198 | {{/code}} |
| 199 | |||
| |
95.1 | 200 | 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 |
| |
27.1 | 201 | |
| |
25.3 | 202 | {{code language="bash"}} |
| |
96.1 | 203 | sudo apt-get --purge autoremove |
| |
25.3 | 204 | {{/code}} |
| |
10.1 | 205 | |
| |
219.1 | 206 | == Troubleshooting == |
| |
77.1 | 207 | |
| |
272.1 | 208 | === No package can be found for Java === |
| 209 | |||
| 210 | XWiki require at least Java 17 since XWiki 16.0 and Java 21 since XWiki 18.0.0. | ||
| 211 | |||
| 212 | If your Debian based distribution does not provide any package for the Java version you need you can try with: | ||
| 213 | |||
| 214 | * Adoptium provides a Debian repository to install Temurin (OpenJDK), see https://adoptium.net/installation/linux/#_deb_installation_on_debian_or_ubuntu | ||
| 215 | |||
| 216 | === Tomcat === | ||
| 217 | |||
| |
274.3 | 218 | See [[Tomcat troubleshootings>>documentation.xs.admin.installation.methods.install-xwiki-war.configure-servlet-container.configure-tomcat.troubleshooting.WebHome]] for generic Tomcat related issues. |
| |
272.1 | 219 | |
| 220 | === MySQL === | ||
| 221 | |||
| 222 | See [[MySQL Installation>>Documentation.AdminGuide.Installation.InstallationWAR.InstallationMySQL||anchor="HTroubleshooting"]] for generic MySQL related issues. | ||
| 223 | |||
| 224 | === PostgreSQL === | ||
| 225 | |||
| 226 | See [[PostgreSQL Installation>>Documentation.AdminGuide.Installation.InstallationWAR.InstallationPostgreSQL||anchor="HTroubleshooting"]] for generic PostgreSQL related issues. | ||
| 227 | |||
| |
220.1 | 228 | === Log file location === |
| |
217.2 | 229 | |
| |
227.13 | 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 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. |
| |
217.2 | 231 | |
| |
227.13 | 232 | ==== XJetty ==== |
| |
217.2 | 233 | |
| 234 | {{code language="none"}} | ||
| |
227.13 | 235 | /var/log/xwiki/[date].jetty.log |
| 236 | {{/code}} | ||
| 237 | |||
| |
252.1 | 238 | ==== Tomcat ==== |
| |
227.13 | 239 | |
| |
252.1 | 240 | There are several possibilities depending on the distribution and Tomcat version: |
| |
217.2 | 241 | |
| 242 | {{code language="none"}} | ||
| |
252.1 | 243 | /var/log/tomcat10/catalina.out |
| 244 | /var/log/tomcat10/catalina.[date].log | ||
| |
217.2 | 245 | {{/code}} |
| 246 | |||
| |
264.2 | 247 | You can find a generic Troubleshooting section on [[Troubleshooting>>documentation.xs.admin.installation.troubleshooting.WebHome]]. |
| |
162.1 | 248 | |
| |
217.2 | 249 | == Other useful info == |
| |
77.1 | 250 | |
| |
217.2 | 251 | === XWiki as root webapp (short URLs) === |
| |
77.1 | 252 | |
| |
221.3 | 253 | 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]]. |
| |
200.2 | 254 | |
| |
270.1 | 255 | ==== For Tomcat 10+ ==== |
| |
200.2 | 256 | |
| |
77.1 | 257 | {{warning}} |
| |
266.1 | 258 | When doing it make sure to check after upgrade if all is OK in /etc/tomcat10/Catalina/localhost folder (xwiki.xml might be restored). |
| |
77.1 | 259 | {{/warning}} |
| 260 | |||
| |
266.1 | 261 | * Rename file ##/etc/tomcat10/Catalina/localhost/xwiki.xml## into ##/etc/tomcat10/Catalina/localhost/ROOT.xml## |
| 262 | * Edit file ##/etc/xwiki/xwiki-tomcat10.xml## and modify ##Context## XML element path from ##/xwiki## to ##/## as in moving from((( | ||
| |
223.1 | 263 | {{code language="xml"}} |
| |
167.1 | 264 | <Context path="/xwiki" docBase="/usr/lib/xwiki" |
| 265 | containerSciFilter="org.apache.tomcat.websocket.server.WsSci|org.apache.jasper.servlet.JasperInitializer"> | ||
| |
77.1 | 266 | {{/code}} |
| 267 | |||
| 268 | to | ||
| 269 | |||
| 270 | {{code language="xml"}} | ||
| |
212.1 | 271 | <Context path="" docBase="/usr/lib/xwiki" |
| |
167.1 | 272 | containerSciFilter="org.apache.tomcat.websocket.server.WsSci|org.apache.jasper.servlet.JasperInitializer"> |
| |
77.1 | 273 | {{/code}} |
| 274 | ))) | ||
| 275 | * Edit file ##/etc/xwiki/xwiki.cfg## and uncomment {{code language="properties"}}xwiki.webapppath={{/code}} | ||
| |
270.2 | 276 | * Restart Tomcat. |
| |
77.1 | 277 | |
| |
245.1 | 278 | ==== For Jetty ==== |
| 279 | |||
| 280 | {{version since="16.7.0"}} | ||
| 281 | You have to modify the ##xjetty-web.xml## file | ||
| 282 | |||
| 283 | 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. | ||
| 284 | |||
| 285 | {{code language="xml"}} | ||
| 286 | <Set name="contextPath">/</Set> | ||
| 287 | {{/code}} | ||
| 288 | {{/version}} | ||
| 289 | |||
| |
264.2 | 290 | You have to modify the ##xjetty-web.xml## file |
| |
258.1 | 291 | |
| |
264.2 | 292 | 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. |
| 293 | |||
| |
258.1 | 294 | {{code language="xml"}} |
| 295 | <Set name="contextPath">/</Set> | ||
| 296 | {{/code}} | ||
| 297 | |||
| |
272.1 | 298 | {{version since="17.0.0"}} |
| 299 | You have to modify the ##jetty-web.xml## file | ||
| |
264.2 | 300 | |
| 301 | 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. | ||
| 302 | |||
| 303 | {{code language="xml"}} | ||
| 304 | <Set name="contextPath">/</Set> | ||
| |
272.1 | 305 | {{/code}} |
| 306 | {{/version}} | ||
| |
264.2 | 307 | |
| 308 | (% data-xwikiorg-product="XWiki" data-xwikiorg-versions-range="3" data-xwikiorg-versions-since="17.0.0" %)You have to modify the ##jetty-web.xml## file | ||
| 309 | |||
| 310 | (% data-xwikiorg-product="XWiki" data-xwikiorg-versions-range="3" data-xwikiorg-versions-since="17.0.0" %)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. | ||
| 311 | |||
| 312 | (% data-xwikiorg-product="XWiki" data-xwikiorg-versions-range="3" data-xwikiorg-versions-since="17.0.0" %){{code language="xml"}}<Set name="contextPath">/</Set>{{/code}} | ||
| 313 | |||
| 314 | {{{<Set name="contextPath">/</Set>}}} | ||
| 315 | |||
| |
217.2 | 316 | === Integrate with LibreOffice === |
| |
77.1 | 317 | |
| |
97.1 | 318 | Install libreoffice with {{code language="none"}}sudo apt-get install libreoffice{{/code}}. |
| |
77.1 | 319 | |
| 320 | And setup XWiki to automatically start and access libreoffice in ##/etc/xwiki/xwiki.properties##: | ||
| 321 | |||
| 322 | {{code language="properties"}} | ||
| 323 | openoffice.autoStart=true | ||
| 324 | openoffice.homePath=/usr/lib/libreoffice/ | ||
| 325 | {{/code}} | ||
| 326 | |||
| 327 | See [[Office Importer Application>>extensions:Extension.Office Importer Application]] for more details. | ||
| 328 | |||
| |
217.2 | 329 | === Standalone Solr setup === |
| |
159.1 | 330 | |
| |
240.1 | 331 | Take a look at [[Solr documentation>>https://solr.apache.org/guide/solr/latest/deployment-guide/taking-solr-to-production.html]] to install Solr itself. |
| |
159.1 | 332 | |
| |
240.1 | 333 | 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). |
| |
159.1 | 334 | |
| |
243.1 | 335 | === Access a file from XWiki === |
| 336 | |||
| |
261.1 | 337 | 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: |
| |
264.2 | 338 | |
| |
261.1 | 339 | * ##/etc/systemd/system/tomcat10.service.d/xwiki-tomcat10-systemd.conf## when using a ##xwiki-tomcat10-*## package |
| 340 | * ##/lib/systemd/system/xwiki.service## when using a ##xwiki-xjetty-*## package | ||
| |
243.1 | 341 | |
| |
261.1 | 342 | By 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. |
| 343 | |||
| |
217.2 | 344 | == Overview of the important files == |
| |
4.1 | 345 | |
| |
25.3 | 346 | 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. |
| |
4.1 | 347 | |
| |
217.2 | 348 | === XWiki === |
| |
4.1 | 349 | |
| |
152.1 | 350 | The configuration: **/etc/xwiki/** |
| |
4.1 | 351 | |
| |
156.1 | 352 | * hibernate.cfg.xml //Hibernate configuration, helping to configure the database resources// |
| |
152.1 | 353 | * xwiki.cfg |
| |
98.1 | 354 | * xwiki.properties |
| |
266.1 | 355 | * xwiki-tomcat10-systemd.conf // Injected trough ##/etc/systemd/system/tomcat10.service.d/xwiki-tomcat-systemd.conf##// in the tomcat10 service configuration |
| |
184.1 | 356 | * xwiki-tomcat<version> // The Tomcat integration linked from ##/etc/tomcat<version>/Catalina/localhost##// |
| |
98.1 | 357 | |
| |
153.1 | 358 | The permanent directory: **/var/lib/xwiki/data** |
| |
4.1 | 359 | |
| |
153.1 | 360 | The home directory: **/usr/lib/xwiki/** |
| 361 | |||
| |
98.1 | 362 | * META-INF |
| 363 | * resources | ||
| 364 | * skins | ||
| 365 | * templates | ||
| 366 | * WEB-INF | ||
| 367 | ** hibernate.cfg.xml -> /etc/xwiki/hibernate.cfg.xml | ||
| 368 | ** xwiki.cfg -> /etc/xwiki/xwiki.cfg | ||
| 369 | ** xwiki.properties -> /etc/xwiki/xwiki.properties | ||
| 370 | |||
| |
227.13 | 371 | === XJetty === |
| 372 | |||
| 373 | **/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 | ||
| 374 | |||
| |
217.2 | 375 | === Tomcat === |
| |
4.1 | 376 | |
| |
99.1 | 377 | **/etc/tomcat##<version>##/** |
| |
4.1 | 378 | |
| |
99.1 | 379 | * context.xml |
| 380 | * logging.properties | ||
| 381 | * server.xml | ||
| 382 | * tomcat-users.xml | ||
| 383 | * web.xml | ||
| 384 | |||
| |
12.1 | 385 | **/etc/default/** |
| |
4.1 | 386 | |
| |
99.1 | 387 | * tomcat##<version>## //This file helps configuring the Tomcat daemon. Every change needs a restart to be effective// |
| 388 | |||
| 389 | **/var/lib/tomcat##<version>##/** | ||
| |
4.1 | 390 | |
| |
99.1 | 391 | * common |
| 392 | * conf -> /etc/tomcat##<version>## | ||
| |
198.1 | 393 | * logs -> ../../log/tomcat##<version> //Note that starting Debian 10 and Ubuntu 18.04 systemd service log is used//## |
| |
99.1 | 394 | * server |
| 395 | * shared | ||
| 396 | * webapps | ||
| 397 | |||
| 398 | **/var/log/tomcat##<version>##/** | ||
| 399 | |||
| 400 | * catalina.out //First logging file. Check this one if you're experiencing troubles with Tomcat/XWiki.// | ||
 |
106.1 | 401 | * localhost.<date>.log // "Container Log file": Start of each filter and failures thereof are listed.// |
| |
99.1 | 402 | |
| |
228.1 | 403 | === MariaDB/MySQL === |
| |
4.1 | 404 | |
| 405 | **/etc/mysql/** | ||
| 406 | |||
| |
99.1 | 407 | * debian.cnf |
| 408 | * my.cnf //Database configuration. Max_allowed_packet is the parameter you need to change to improve upload data size.// permitted. | ||
| 409 | |||
| |
4.1 | 410 | **/var/lib/mysql/** |
| 411 | |||
| |
99.1 | 412 | * mysql |
| 413 | * xwiki //This is the xwiki database. You may want to backup this directory from time to time.// | ||
| 414 | |||
| |
4.1 | 415 | **/var/log/** |
| 416 | |||
| |
99.1 | 417 | * syslog |
| 418 | * mysql | ||
| 419 | ** error.log | ||
| 420 | |||
| |
217.2 | 421 | === PostgreSQL === |
| |
4.1 | 422 | |
| 423 | **/etc/postgresql/** | ||
| 424 | |||
| |
99.1 | 425 | * ##<version>## |
| 426 | ** main | ||
| 427 | *** postgresql.conf | ||
| 428 | *** pg_hba.conf | ||
| 429 | |||
| 430 | **/var/lib/postgresql/##<version>##/main/** | ||
| 431 | |||
| 432 | * base |
