Wiki source code of Jetty Installation

Last modified by Eleni Cojocariu on 2026/05/22 20:34

Show last authors
1 There are several ways to run XWiki on Jetty:
2
3 * [[Installing a Standalone (Demo) Distribution>>documentation.xs.admin.installation.methods.install-standalone-demo-distribution.WebHome]]. which bundles Jetty and provide an all-in-one zip, ready to use.
4 * Using the official [[Jetty docker image>>https://hub.docker.com/_/jetty]].
5 * [[Downloading and installing>>https://www.eclipse.org/jetty/download.html]] Jetty manually on your server.
6
7 If you go with the last 2 options, make sure to:
8
9 * Pick a [[supported version of Jetty>>dev:Community.SupportStrategy.ServletContainerSupportStrategy.WebHome]].
10 * Follow the Jetty setup defined in the {{scm path="xwiki-platform-tools/xwiki-platform-tool-jetty/xwiki-platform-tool-jetty-resources/src/main/resources/jetty/modules/xwiki.mod"}}##xwiki.mod##{{/scm}} file used for the demo packaging. Note that the default setup used in the Jetty Docker image should work fine out of the box.
11
12 = Docker =
13
14 * Extract the [[XWiki WAR>>xwiki:Main.Download]] into a directory named ##xwiki##. Let's call this directory ##[XWIKI_HOME]##.
15 * Setup a permanent directory on your local machine and let's call it ##[XWIKI_PERMDIR]##
16 * Run the Jetty Docker image, for example: {{code language="none"}}docker run -v [XWIKI_HOME]:/var/lib/jetty/webapps/xwiki -v [XWIKI_PERMDIR]:/var/lib/jetty/xwiki-data -p 8080:8080 jetty:12-jre21 -Dxwiki.data.dir=/var/lib/jetty/xwiki-data{{/code}}
17 ** Note that you won't need the ##-Dxwiki.data.dir=/var/lib/jetty/xwiki-data## part if you have edited ##[XWIKI_HOME]/WEB-INF/xwiki.properties## and set the ##environment.permanentDirectory## to point to ##/var/lib/jetty/xwiki-data##. The system property just overrides whatever is defined in ##environment.permanentDirectory##.
18 ** Also note that you'll need a database set up too. If you want to quickly test it, you can simply copy the the HSQLDB JAR into ##WEB-INF/lib##.
19 ** You'll need to specify what environment to execute in.
20 {{code language="none"}}docker run ... jetty:12 --module=--module=ee10-apache-jsp,ee10-deploy,ee10-websocket-jakarta{{/code}}
21
22 = Manual =
23
24 See [[Configure Jetty>>documentation.xs.admin.installation.methods.install-xwiki-war.configure-servlet-container.configure-jetty.WebHome]].
25
26 = Troubleshooting =
27
28 == Unable to parse form content ==
29
30 See [[Unable to Parse Form Content in Jetty>>documentation.xs.admin.installation.methods.install-xwiki-war.configure-servlet-container.configure-jetty.unable-parse-form-content-jetty.WebHome]].

Get Connected