Skip to Content

Wiki source code of Tomcat Installation

Last modified by Thomas Mortagne on 2025/02/18
Hide last authors
Dmitry Bakbardin 13.4 1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
Vincent Massol 11.1 4
Vincent Massol 5.2 5 = Installation Steps =
vmassol 1.1 6
Thomas Mortagne 61.1 7 * Download and install [[Tomcat 8+>>http://tomcat.apache.org/]]. There are plenty of ways to install Tomcat, refer to the Tomcat site for more information. Let's call ##TOMCAT_HOME## the directory where it's installed.(((
8 {{warning}}
Thomas Mortagne 99.1 9 * Tomcat 10 move to jakarta.* package naming means that it's impossible to use it with a version of XWiki lower than 17.0.0. It also means that XWiki 17.0.0 only works with at least Tomcat 10.
Vincent Massol 84.4 10 * Tomcat 9.0.70 has some bugs that make it fail with XWiki. See:
Vincent Massol 84.7 11 ** -- https://jira.xwiki.org/browse/XWIKI-20470 -- (A Tomcat regression now fixed in Tomcat 9.0.71+)
Thomas Mortagne 61.1 12 {{/warning}}
13 )))
Thomas Mortagne 85.1 14 * Make sure you [[give enough memory to Java>>Documentation.AdminGuide.InstallationTomcat#HOutOfMemoryError]] since by default Tomcat is not configured with enough memory for XWiki.
Thomas Mortagne 38.1 15 * Extract the [[XWiki WAR>>xwiki:Main.Download]] into a directory named ##xwiki## in ##TOMCAT_HOME/webapps/##
Thomas Mortagne 85.1 16 * Open ##TOMCAT_HOME/webapps/xwiki/WEB-INF/xwiki.properties## files and [[configure a permanent directory>>Documentation.AdminGuide.Configuration#HConfiguringDirectories]]
Vincent Massol 36.3 17 * Start Tomcat
Simon Urli 48.1 18 * When Tomcat has opened go to your wiki by accessing [[http:~~/~~/localhost:8080/xwiki/bin/view/Main/>>http://localhost:8080/xwiki/bin/view/Main/]]
Vincent Massol 36.2 19 * NOTE - if you have issues with maximum cache size - In your ##$CATALINA_BASE/conf/context.xml## add the following content before ##</Context>##:(((
Jan-Paul Kleijn 75.1 20 {{code language="none"}}
逸恒 吴 57.1 21 <Resources cachingAllowed="true" cacheMaxSize="100000" ></Resources>
Vincent Massol 36.2 22 {{/code}}
23 )))
vmassol 1.4 24
Vincent Massol 11.1 25 == Activate headless mode ==
mawoki 10.1 26
27 If you're operating XWiki on a Linux server with no X11 libraries installed you have to enable headless mode for your Tomcat installation. Sometimes this is also needed on Windows platforms. Typical exceptions are:
28
Vincent Massol 24.6 29 * ##Exception: Could not initialize class sun.awt.X11.XToolkit##
30 * ##java.lang.InternalError: Can't connect to X11 window server using 'localhost:10.0' as the value of the DISPLAY variable##
Christian 84.1 31 * ##Error number 0 in 11: Uncaught exception##
32 * ##java.lang.NoClassDefFoundError: Could not initialize class java.awt.GraphicsEnvironment$LocalGE##
33
Vincent Massol 24.6 34 * On Linux create a file ##///TOMCAT_HOME///bin/setenv.sh## and insert the following code:(((
Jan-Paul Kleijn 75.1 35 {{code language="none"}}
Vincent Massol 24.6 36 #!/bin/sh
37 export JAVA_OPTS="${JAVA_OPTS} -Djava.awt.headless=true"
Vincent Massol 24.7 38 {{/code}}
Vincent Massol 24.6 39 )))
40 * On Windows create a file ##///TOMCAT_HOME///bin/setenv.bat## and insert the following code:(((
Jan-Paul Kleijn 75.1 41 {{code language="none"}}
chuck_liu 27.1 42 set JAVA_OPTS=%JAVA_OPTS% -Djava.awt.headless=true
43 {{/code}}
Vincent Massol 24.6 44 )))
Manuel Smeria 16.2 45 * When running as a Windows service the ##setenv.bat## is not working. See registry ##HKEY_LOCAL_MACHINE\SOFTWARE\Apache Software Foundation\Procrun 2.0\//FOOBAR//\Parameters\Java## for similar settings.
mawoki 9.1 46
Vincent Massol 11.1 47 == Optional configuration ==
mawoki 9.1 48
Jan-Paul Kleijn 71.1 49 * To enable gzip compression the connector property in the ##server.xml## file needs to be modified. The location of the ##server.xml## file is found at:
50 - On Linux: ##/etc/tomcat[version]/server.xml##
Jan-Paul Kleijn 74.1 51 - On Windows: ##//TOMCAT_HOME///conf/server.xml##(((
52 {{code language="none"}}
53 <Connector port="8080"
54 ...
55 compression="on"
56 compressionMinSize="2048"
57 compressibleMimeType="text/html,text/xml,text/css,text/javascript,application/x-javascript">
58 </Connector>
59 {{/code}}
Jan-Paul Kleijn 73.1 60 )))
Jan-Paul Kleijn 71.1 61 * To modify the port on which Tomcat will run, search in ##server.xml## for all instances of {{code}}8080{{/code}} (in Linux this can also be {{code}}8180{{/code}}) and replace this with the port value you wish to use.
62 * It is possible to setup a Tomcat Java Server as a UNIX Daemon - JSVC. Just follow [[these instructions>>http://www.malisphoto.com/tips/tomcatonosx.html?#Anchor-JSVC||rel="noopener noreferrer" target="new"]].
Jan-Paul Kleijn 78.3 63 The only reason to make Tomcat a daemon is to make it runnable on port 80, which can be replaced by using a proxy server (such as NginX or Apache) on port 80 and then forwarding to Tomcat on port 8080.
mawoki 9.1 64
HoaniCross 19.1 65 == Policy configuration ==
66
Vincent Massol 24.6 67 For those who activate the security manager for Tomcat, add this portion of code to the end of your ##conf/catalina.policy## file from your Tomcat installation. You can adapt the code for the available installations of OpenOffice/LibreOffice on your server and for different databases :
HoaniCross 19.1 68
Jan-Paul Kleijn 75.1 69 {{code language="none"}}
HoaniCross 19.1 70 grant codeBase "file:${catalina.base}/webapps/xwiki/WEB-INF/lib/-" {
71 // for mySQL connection
72 permission java.net.SocketPermission "127.0.0.1:3306", "connect,resolve";
73
74 // XWiki must have access to all properties in read/write
75 permission java.util.PropertyPermission "*", "read, write";
76
77 // Generic detected permissions
78 permission java.lang.reflect.ReflectPermission "suppressAccessChecks";
79 permission java.lang.RuntimePermission "createClassLoader";
80 permission java.lang.RuntimePermission "setContextClassLoader";
81 permission java.lang.RuntimePermission "accessClassInPackage.org.apache.catalina.loader";
82 permission java.lang.RuntimePermission "accessDeclaredMembers";
83 permission java.lang.RuntimePermission "getenv.ProgramFiles";
84 permission java.lang.RuntimePermission "getenv.APPDATA";
85 permission java.lang.RuntimePermission "accessClassInPackage.sun.reflect";
86 permission java.lang.RuntimePermission "getClassLoader";
87 permission java.lang.RuntimePermission "accessClassInPackage.org.apache.catalina.connector";
HoaniCross 20.1 88 permission java.lang.RuntimePermission "accessClassInPackage.org.apache.tomcat.util.threads";
HoaniCross 19.1 89 permission java.lang.RuntimePermission "reflectionFactoryAccess";
90 permission java.lang.RuntimePermission "accessClassInPackage.com.sun.jmx.interceptor";
91 permission java.lang.RuntimePermission "accessClassInPackage.com.sun.jmx.mbeanserver";
92 permission java.lang.RuntimePermission "modifyThread";
93 permission java.lang.RuntimePermission "getProtectionDomain";
94
95 // JAXB permissions
96 permission javax.xml.bind.JAXBPermission "setDatatypeConverter";
97
98 // Serialization related permissions
99 permission java.io.SerializablePermission "allowSerializationReflection";
100 permission java.io.SerializablePermission "creator";
101 permission java.io.SerializablePermission "enableSubclassImplementation";
102
103 // Internal resources access permissions
104 permission java.io.FilePermission "synonyms.txt", "read";
105 permission java.io.FilePermission "lang/synonyms_en.txt", "read";
106 permission java.io.FilePermission "quartz.properties", "read";
107 permission java.io.FilePermission "/templates/-", "read";
108 permission java.io.FilePermission "/skins/-", "read";
109 permission java.io.FilePermission "/resources/-", "read";
110
111 // MBean related permissions
112 permission javax.management.MBeanServerPermission "createMBeanServer";
113 permission javax.management.MBeanPermission "*", "registerMBean";
114 permission javax.management.MBeanPermission "*", "unregisterMBean";
115 permission javax.management.MBeanTrustPermission "register";
116 permission javax.management.MBeanPermission "-#-[-]", "queryNames";
117 permission javax.management.MBeanServerPermission "findMBeanServer";
118
119 // LibreOffice/OpenOffice related permissions
120 permission java.io.FilePermission "/opt/openoffice.org3/program/soffice.bin", "read";
121 permission java.io.FilePermission "/opt/libreoffice/program/soffice.bin", "read";
122 permission java.io.FilePermission "/usr/lib/openoffice/program/soffice.bin", "read";
123 permission java.io.FilePermission "/usr/lib/libreoffice/program/soffice.bin", "read";
124
125 // Allow file storage directory reading - for directory and everything underneath
126 // This is dependent on the setting of environment.permanentDirectory in xwiki.properties
127 permission java.io.FilePermission "${catalina.base}${file.separator}xwikidata${file.separator}", "read,write,delete";
128 permission java.io.FilePermission "${catalina.base}${file.separator}xwikidata${file.separator}-", "read,write,delete";
129
130 // Allow file storage directory reading - temporary directory and everything underneath
131 // This is dependent on the setting of environment.temporaryDirectory in xwiki.properties.
132 permission java.io.FilePermission "${catalina.base}${file.separator}temp${file.separator}", "read,write,delete";
133 permission java.io.FilePermission "${catalina.base}${file.separator}temp${file.separator}-", "read,write,delete";
134 };
135 {{/code}}
136
Vincent Massol 54.1 137 Please note that this policy configuration file has been tested on CentOS 5.9 with Sun JDK 1.7.0u21 on Tomcat 7.0.40 with XWiki 5.0.1 installed.
HoaniCross 19.1 138
Thomas Mortagne 93.1 139 == HTTP reverse proxy ==
Dmitry Bakbardin 13.4 140
Thomas Mortagne 92.1 141 For a [[variety of reasons>>https://en.wikipedia.org/wiki/Reverse_proxy||rel="__blank"]], it is not ideal to allow users to connect directly to tomcat. So it's generally recommended to put an HTTP reverse proxy such as Apache HTTP Server or Nginx in front of it.
Thomas Mortagne 89.1 142
Thomas Mortagne 93.1 143 === Using Apache HTTP Server ===
Thomas Mortagne 89.1 144
Thomas Mortagne 97.1 145 For setup example with Apache HTTP Server, in production : [[Documentation.AdminGuide.Installation.ApacheHTTPD]].
Thomas Mortagne 89.1 146
Thomas Mortagne 93.1 147 === Using Nginx ===
Thomas Mortagne 89.1 148
Thomas Mortagne 91.1 149 Another popular choice for a reverse-proxy web server is [[Nginx>>http://wiki.nginx.org/Main||rel="__blank"]]. These instructions will walk through a very basic deployment of nginx acting as a reverse-proxy for the tomcat XWiki application.
Dmitry Bakbardin 13.4 150
Craig Wright 30.1 151 After a typical XWiki installation XWiki will be running on ##http:~/~/localhost:8080/xwiki##. Ultimately we will want to access XWiki via ##http:~/~/mydomain.com## on a standard http (80) or https (443) port. To accomplish this for unsecure http traffic, the following basic config file gets us started.
Dmitry Bakbardin 13.4 152
Thomas Mortagne 93.1 153 ==== Http (unsecure) ====
Craig Wright 30.1 154
Manuel Smeria 16.2 155 * create this file ##/etc/nginx/conf.d/tomcat.conf##
Christian 84.1 156 * put the following code inside:(((
157 {{code language="none"}}
158 server {
Dmitry Bakbardin 14.1 159 listen 80;
160 server_name mydomain.com;
Dmitry Bakbardin 13.4 161
Craig Wright 30.1 162 # Normally root should not be accessed, however, root should not serve files that might compromise the security of your server.
163 root /var/www/html;
164
Ludovic Dubost 62.1 165 # Configuration to avoid Request Entity too large error 413
166 client_max_body_size 0;
167
Dmitry Bakbardin 14.1 168 location / {
Craig Wright 30.1 169 # All "root" requests will have /xwiki appended AND redirected to mydomain.com
Dmitry Bakbardin 14.1 170 rewrite ^ $scheme://$server_name/xwiki$request_uri? permanent;
171 }
Dmitry Bakbardin 13.4 172
Dmitry Bakbardin 14.1 173 location ^~ /xwiki {
chuck_liu 27.1 174 # If path starts with /xwiki - then redirect to backend: XWiki application in Tomcat
175 # Read more about proxy_pass: http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_pass
176 proxy_pass http://localhost:8080;
Jesse Bright 28.3 177 proxy_set_header X-Real-IP $remote_addr;
178 proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
179 proxy_set_header Host $http_host;
180 proxy_set_header X-Forwarded-Proto $scheme;
Dmitry Bakbardin 14.1 181 }
Christian 84.1 182 }
183 {{/code}}
Jan-Paul Kleijn 82.1 184 )))
Dmitry Bakbardin 14.1 185 * restart nginx
186
chuck_liu 27.1 187 Now all ##http:~/~/mydomain.com/*## requests will lead to the XWiki application. Please note that these settings are basic. For more flexible solutions please refer to [[the Nginx documentation>>http://wiki.nginx.org/Main||rel="__blank"]].
Dmitry Bakbardin 14.1 188
Thomas Mortagne 93.1 189 ==== Https (secure) ====
Craig Wright 30.1 190
191 There are many guides on how to create a secure configuration of nginx. To get started:
192
193 * [[Strong SSL Security on nginx>>https://raymii.org/s/tutorials/Strong_SSL_Security_On_nginx.html||rel="__blank"]]
194 * [[How To Secure Nginx With LetsEncrypt on Ubuntu 16.04>>https://www.digitalocean.com/community/tutorials/how-to-secure-nginx-with-let-s-encrypt-on-ubuntu-16-04||rel="__blank"]]
195
Craig Wright 31.1 196 The following config assumes you are using LetsEncrypt and that your XWiki is hosted on ##http:~/~/localhost:8080/##. This config will redirect all unsecure requests to https:~/~/ and set the correct proxy headers for a secure nginx+tomcat setup.
Craig Wright 30.1 197
Jan-Paul Kleijn 78.1 198 First, you will need to add the following config to tomcat's ##server.xml##. The first line should already be in the file, I include it to give you something to search for (that line is located on line 108 in the Ubuntu 16.04 tomcat8 package). This will help tomcat find your proxy headers.
Craig Wright 30.1 199
200 (((
Jan-Paul Kleijn 75.1 201 {{code language="none"}}
Craig Wright 30.1 202 <Engine name="Catalina" defaultHost="localhost">
203 <Valve className="org.apache.catalina.valves.RemoteIpValve"
204 internalProxies="127\.0\.[0-1]\.1"
205 remoteIpHeader="x-forwarded-for"
206 requestAttributesEnabled="true"
207 protocolHeader="x-forwarded-proto"
逸恒 吴 57.1 208 protocolHeaderHttpsValue="https"></Valve>
Craig Wright 30.1 209 {{/code}}
210 )))
211
212 Next, add the following nginx config file to your nginx config folder, replacing ##wiki.yourdomain.com## with your actual domain info:
213
214 (((
Jan-Paul Kleijn 75.1 215 {{code language="none"}}
Craig Wright 30.1 216 server {
217 listen 80;
218 server_name wiki.yourdomain.com;
219
220 location ~ /.well-known {
221 allow all;
222 }
223
224 rewrite ^ https://$server_name$request_uri? permanent;
225
226 access_log /var/log/nginx-xwiki/access.log;
227 error_log /var/log/nginx-xwiki/error.log;
228
229 }
230
231 server {
232 listen 443;
233 server_name wiki.yourdomain.com;
234
235 root /var/www/html;
236
Ludovic Dubost 62.1 237 # Configuration to avoid Request Entity too large error 413
238 client_max_body_size 0;
239
Craig Wright 30.1 240 ssl on;
241 ssl_certificate /etc/letsencrypt/live/wiki.yourdomain.com/fullchain.pem;
242 ssl_certificate_key /etc/letsencrypt/live/wiki.yourdomain.com/privkey.pem;
243
244 access_log /var/log/nginx-xwiki/access_ssl.log;
245 error_log /var/log/nginx-xwiki/error_ssl.log;
246
247 location / {
248 proxy_set_header Host $http_host;
249 proxy_set_header X-Real-IP $remote_addr;
250 proxy_set_header X-Forward-For $proxy_add_x_forwarded_for;
251 proxy_set_header X-Forwarded-Proto $scheme;
252 proxy_set_header X-Scheme $scheme;
253 proxy_redirect off;
254 if (!-f $request_filename) {
255 proxy_pass http://127.0.0.1:8080;
256 break;
257 }
258 }
259
260 location ~ /.well-known {
261 allow all;
262 }
263 }
264 {{/code}}
265 )))
266
267 For more background on this config, see the discussion on this ticket: [[XWIKI-13963>>http://jira.xwiki.org/browse/XWIKI-13963||rel="__blank"]].
268
Thomas Mortagne 93.1 269 ==== Proxying and tunnels ====
Paul Libbrecht 51.1 270
271 This proxy methods brings remote connections to local connection. This is complementary to SSH-tunneling which is easily done on port 8080 and can be used to test development servers.
272
Jan-Paul Kleijn 76.1 273 For example, if you are running an XWiki on port 80 on your laptop while running the NGinx (or Apache) on a server where it is accessible as ##https://wiki.yourdomain.com##, you can make your XWiki acessible with this URL:##
Paul Libbrecht 51.1 274
275 * First make sure that the port 8080 is not in use: You can proof this with ##{{{ssh server wget -O - https://127.0.0.1:8080/}}}## which should display the error message //Connection refused//. If not, something is running there and it should be stopped.
276 * You can then create the tunnel with the following ##ssh -R8080:127.0.0.1:8080 server##. This tells the server that incoming ("R"emote) connections on port 8080 on the server are to be tunnelled to the local (laptop) port 8080. This method has the advantage that the laptop (typically using a dynamic address) invokes the SSH where as a proxy configured on the server to proxy to the laptop would need to know the address of the laptop.
277
Jan-Paul Kleijn 67.1 278 = Recommendations =
Thomas Mortagne 65.1 279
Jan-Paul Kleijn 67.1 280 == Default encoding ==
Thomas Mortagne 65.1 281
Thomas Mortagne 66.1 282 XWiki strives to not be impacted by the default encoding, but it's still possible to have bugs or simply mistakes in extensions or tools used by XWiki (database connectors, etc.) so it's highly recommended to make sure Tomcat is started with utf8 as default encoding. If you use a Linux package of Tomcat this is generally set by default, but it might not always be the case. For that, make sure you have ##-Dfile.encoding=utf8## in the Java command line which starts Tomcat.
Thomas Mortagne 65.1 283
Vincent Massol 12.1 284 = Troubleshooting =
Vincent Massol 1.16 285
Vincent Massol 5.2 286 == Out Of Memory Error ==
Vincent Massol 1.16 287
Vincent Massol 64.2 288 === General Memory Settings ===
289
Thomas Mortagne 96.1 290 When you run XWiki in Tomcat with the default settings, you'll probably get an ##Out Of Memory## error (##java.lang.OutOfMemoryError: Java heap space## or ##java.lang.OutOfMemoryError: PermGen space##) since the default Tomcat memory settings are not enough for [[XWiki Memory Requirements>>Documentation.AdminGuide.Performances#HMemory]]. You'll need to allocate more memory to the JVM.
Vincent Massol 1.16 291
Thomas Mortagne 85.1 292 One easy solution to configure Tomcat's memory is to create a ##setenv.sh## file (or ##setenv.bat## on Windows) in ##[TOMCAT_HOME]/bin/## (where ##[TOMCAT_HOME]## is where you've installed Tomcat) and inside this file add the following (adjust the memory values according to the [[XWiki Memory Requirements>>Documentation.AdminGuide.Performances#HMemory]]). For example:
Sergiu Dumitriu 17.1 293
294 {{code language="none"}}
Vincent Massol 24.8 295 CATALINA_OPTS="-Xmx1024m -XX:MaxPermSize=192m"
Sergiu Dumitriu 17.1 296 {{/code}}
297
Thomas Mortagne 96.1 298 On most Linux distributions, this can also be achieved in ##/etc/default/tomcat//X//##, ##/etc/tomcat//X///tomcat//X//.conf## or ##/etc/conf.d/tomcat//X//.conf## (where //X// is the version of Tomcat installed).
Sergiu Dumitriu 17.1 299
Vincent Massol 22.1 300 On Windows, if you are running Tomcat as a service then defining ##CATALINA_OPTS## will not help. There is an utility provided in the ##bin## folder of your Tomcat installation (for example for Tomcat 5.x on Windows it's called tomcat5w.exe). It's a GUI tool which can be used to set various options including the heap size.
301
Thomas Mortagne 93.1 302 === NullPointerExceptions in catalina.log during startup on Ubuntu 23.x ===
303
Thomas Mortagne 96.1 304 Tomcat 9.0.70 has [[a very serious regression>>https://bz.apache.org/bugzilla/show_bug.cgi?id=66388]]. Unfortunately this is the version Ubuntu chose to put in its repository so you will be impacted with Ubuntu 23.04 and 23.10 at time of writing.
Thomas Mortagne 93.1 305
306 A possible workaround is to use the tomcat9 package coming for Ubuntu jammy (22.04) repository (9.0.58).
307
Vincent Massol 64.2 308 === Max number of threads ===
309
Rainer Stransky 64.1 310 On some Debian 10 installations there can be a limitation of the max number of threads for services started with ##systemd## (and ##tomcat9## is such a service), what can force problems with OOM Errors: ##Out Of Memory## error (##java.lang.OutOfMemoryError: unable to create native thread##)
Rainer Stransky 63.1 311
Rainer Stransky 64.1 312 If you have such messages in the ##catalina.out## check your default limitations of the ##systemd## with the command
Rainer Stransky 63.1 313
Jan-Paul Kleijn 76.1 314 {{code language="none"}}
Rainer Stransky 63.1 315 > systemctl show --property DefaultTasksMax
316 {{/code}}
317
318 For XWiki a value of about 100 is too low. Depending on the number of parallel users and sub wikis, this value should be larger. A value of about 512 should be sufficient.
319
320 Changing the parameter ##DefaultTasksMax## in ##/etc/systemd/system.conf## to a larger value, restarting the ##system-daemon## and ##tomcat9##, should solve the problem.
321
Jan-Paul Kleijn 76.1 322 {{code language="none"}}
Rainer Stransky 63.1 323 > systemctl daemon-reload
324 > systemctl restart tomcat9
325 {{/code}}
326
327 If the problem is not fixed with these changes, check the number of currently used threads by tomcat9 with the command
328
Jan-Paul Kleijn 76.1 329 {{code language="none"}}
Rainer Stransky 63.1 330 > ps -elfT | grep tomcat9| wc -l
331 {{/code}}
332
333 If the value is very near to the configured ##DefaultTasksMax##, you can try to increase it to an appropriate value.
334
Vincent Massol 5.2 335 == Java Security Manager ==
Vincent Massol 1.16 336
Thomas Mortagne 85.1 337 By default Tomcat is configured to have the Java Security Manager turned on. See the [[sample policy file>>Documentation.AdminGuide.InstallationWAR#HInstallandconfigureaServletContainer]] for more details.
Vincent Massol 1.16 338
Manuel Smeria 16.2 339 If you want to turn off the Java Security Manager for Tomcat, edit the Tomcat startup script. You might also want to check your ##/etc/init.d/tomcat## file or ##/etc/default/tomcat5.5##. You should see the following code:
dkBrazz 5.1 340
Jan-Paul Kleijn 76.1 341 {{code language="none"}}
Vincent Massol 1.16 342 # Use the Java security manager? (yes/no)
343 TOMCAT5_SECURITY=
dkBrazz 5.1 344 {{/code}}
Vincent Massol 1.16 345
Vincent Massol 5.2 346 Set it to ##no## to turn off the Security Manager.
Vincent Massol 11.1 347
Vincent Massol 44.1 348 == Allowing "/" and "\" in page names ==
Vincent Massol 11.1 349
Vincent Massol 44.1 350 Tomcat completely freaks out when there's a ##%2F## or ##%5C## in URLs and it's not something that can be changed in XWiki. See [[this note>>http://tomcat.apache.org/security-6.html#Fixed_in_Apache_Tomcat_6.0.10]] for more information.
Vincent Massol 11.1 351
Vincent Massol 50.2 352 You can configure Tomcat to allow "/", by setting the ##org.apache.tomcat.util.buf.UDecoder.ALLOW_ENCODED_SLASH## system property to ##true##, as in:
Vincent Massol 11.1 353
Jan-Paul Kleijn 76.1 354 {{code language="none"}}
Vincent Massol 50.1 355 -Dorg.apache.tomcat.util.buf.UDecoder.ALLOW_ENCODED_SLASH=true
Vincent Massol 11.1 356 {{/code}}
Vincent Massol 12.1 357
Vincent Massol 50.1 358 And by setting the ##org.apache.catalina.connector.CoyoteAdapter.ALLOW_BACKSLASH## system property to ##true## to allow "\", as in:
Vincent Massol 25.1 359
Jan-Paul Kleijn 76.1 360 {{code language="none"}}
Vincent Massol 50.1 361 -Dorg.apache.catalina.connector.CoyoteAdapter.ALLOW_BACKSLASH=true
Vincent Massol 44.1 362 {{/code}}
363
Vincent Massol 50.1 364 To have both properties permanently enabled on your Tomcat instance, add the lines below to your ##CATALINA_OPTS## environment variable. How to achieve this depends on your operating system, Tomcat distribution and single/multi-instance setup.
Vincent Massol 44.1 365
Jan-Paul Kleijn 76.1 366 {{code language="none"}}
Vincent Massol 50.1 367 -Dorg.apache.tomcat.util.buf.UDecoder.ALLOW_ENCODED_SLASH=true
Vincent Massol 44.1 368 -Dorg.apache.catalina.connector.CoyoteAdapter.ALLOW_BACKSLASH=true
369 {{/code}}
370
Vincent Massol 56.2 371 === Apache front-end server ===
Ludovic Dubost 56.1 372
Vincent Massol 56.2 373 Note that if you're using the Apache web server as a front-end, you also need to [[configure Apache to allow encoded / and \>>https://httpd.apache.org/docs/current/mod/core.html#allowencodedslashes]] (##AllowEncodedSlashes NoDecode##) and also make sure to use ##nocanon## on the [[ProxyPass line used>>https://httpd.apache.org/docs/2.4/mod/mod_proxy.html]].
Vincent Massol 44.1 374
Vincent Massol 21.1 375 == NotSerializableException ==
376
377 If you get the following:
378
Jan-Paul Kleijn 76.1 379 {{code language="none"}}
Vincent Massol 21.1 380 SEVERE: IOException while loading persisted sessions: java.io.WriteAbortedException: writing aborted; java.io.NotSerializableException: org.xwiki.model.internal.reference.LocalStringEntityReferenceSerializer
381 java.io.WriteAbortedException: writing aborted; java.io.NotSerializableException: org.xwiki.model.internal.reference.LocalStringEntityReferenceSerializer
Gabriela Anechitoaei 34.1 382 at java.io.ObjectInputStream.readObject0(Unknown Source)
383 at java.io.ObjectInputStream.defaultReadFields(Unknown Source)
Vincent Massol 21.1 384 {{/code}}
385
386 This means that on startup Tomcat tries to load saved Sessions and fails to do so. In this case it fails because some non-serializable object was put in the Servlet Session. To work around the issue [[you can tell Tomcat to not save sessions>>http://dev-answers.blogspot.fr/2007/03/how-to-turn-off-tomcat-session.html]].
387
Vincent Massol 12.1 388 == SEVERE: Error listenerStart ==
389
Vincent Massol 54.2 390 If you get this error in your Tomcat logs then you'll need to enable finer-grained logging configuration to see what's the problem. This involves copying the following content in a ##WEB-INF/classes/logging.properties## file:
Vincent Massol 12.1 391
Jan-Paul Kleijn 76.1 392 {{code language="none"}}
Vincent Massol 12.1 393 org.apache.catalina.core.ContainerBase.[Catalina].level = INFO
394 org.apache.catalina.core.ContainerBase.[Catalina].handlers = java.util.logging.ConsoleHandler
395 {{/code}}
Simon Urli 46.1 396
397 == Parameter count exceeded allowed maximum ==
398
Vincent Massol 46.2 399 If you get an error such as the following it means you reached the limit of parameters you can send in a form.
Simon Urli 46.1 400
Jan-Paul Kleijn 76.1 401 {{code language="none"}}
Simon Urli 46.1 402 java.lang.IllegalStateException: Parameter count exceeded allowed maximum: 512
403 {{/code}}
404
Vincent Massol 46.2 405 You can set the value you want by setting the following in your Tomcat ##server.xml## file:
Simon Urli 46.1 406
Jan-Paul Kleijn 76.1 407 {{code language="none"}}
逸恒 吴 57.1 408 <Connector port=... maxParameterCount="10000" ></Connector>
Vincent Massol 46.2 409 {{/code}}
Vincent Massol 54.1 410
Vincent Massol 59.1 411 == ThreadLocal Errors ==
Vincent Massol 58.1 412
Vincent Massol 60.1 413 When you stop XWiki you may see the following type of errors in the Tomcat logs. This is a [[known limitation of XWiki in cleaning up some ThreadLocal variables>>https://jira.xwiki.org/browse/XWIKI-9055]]. To be safe, we recommend that you stop XWiki by stopping Tomcat (i.e. stopping the Tomcat JVM). This ensures that there won't be any memory leak related to these ThreadLocal variables. If you use the Tomcat Manager to stop the XWiki webapp (by undeploying it), then we recommend to not do that and instead to stop Tomcat and restart it.
Vincent Massol 58.1 414
415 {{code language="none"}}
416 SEVERE [Thread-794] org.apache.catalina.loader.WebappClassLoaderBase.checkThreadLocalMapForLeaks The web application [...] created a ThreadLocal with key of type [java.lang.ThreadLocal] (value [java.lang.ThreadLocal@1125fc78]) and a value of type [...] (value [...]) but failed to remove it when the web application was stopped. Threads are going to be renewed over time to try and avoid a probable memory leak.
417 {{/code}}
418
Vincent Massol 98.1 419 == Request header is too large ==
420
421 If you happen to see the navigation tree of XWiki failing to load (or some LiveData failing to load), and you have something like the following in the XWiki logs:
422
423 {{code language="none"}}
424 java.lang.IllegalArgumentException: Request header is too large
425 org.apache.coyote.http11.Http11InputBuffer.fill(Http11InputBuffer.java:785)
426 org.apache.coyote.http11.Http11InputBuffer.parseHeader(Http11InputBuffer.java:940)
427 org.apache.coyote.http11.Http11InputBuffer.parseHeaders(Http11InputBuffer.java:607)
428 org.apache.coyote.http11.Http11Processor.service(Http11Processor.java:525)
429 org.apache.coyote.AbstractProcessorLight.process(AbstractProcessorLight.java:65)
430 org.apache.coyote.AbstractProtocol$ConnectionHandler.process(AbstractProtocol.java:818)
431 org.apache.tomcat.util.net.NioEndpoint$SocketProcessor.doRun(NioEndpoint.java:1626)
432 org.apache.tomcat.util.net.SocketProcessorBase.run(SocketProcessorBase.java:49)
433 java.base/java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1128)
434 java.base/java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:628)
435 org.apache.tomcat.util.threads.TaskThread$WrappingRunnable.run(TaskThread.java:61)
436 java.base/java.lang.Thread.run(Thread.java:834)
437 {{/code}}
438
439 This could be caused by a large number of cookies.
440
441 To fix it, you'll need to [[increase the ##maxHttpHeaderSize## value for Tomcat (default is 8192)>>https://tomcat.apache.org/tomcat-9.0-doc/config/http.html]].
442
Vincent Massol 54.1 443 = Old Instructions =
444
445 Note that [[Tomat 7 is no longer supported>>dev:Community.SupportStrategy.ServletContainerSupportStrategy.WebHome]].
446
447 {{error}}
448 The Tomcat project has brought a change in the [[way they handle ##RequestDispatcher##>>https://bz.apache.org/bugzilla/show_bug.cgi?id=59317]] which has caused [[regressions in XWiki>>https://jira.xwiki.org/browse/XWIKI-13556]] for some versions of Tomcat. Thus you should **not** use the following Tomcat versions:
449
450 * >= 9.0.0.M5 and < 9.0.0.M10 for the 9.0.x branch (fixed in 9.0.0.M10)
451 * >= 8.5.1 and < 8.5.5 for the 8.5.x branch (fixed in 8.5.5)
452 * >= 8.0.34 and < 8.0.37 for the 8.0.x branch (fixed in 8.0.37)
453 * >= 7.0.70 and < 7.0.71 for the 7.0.x branch (fixed in 7.0.71)
454
455 There is an important Classloader related bug in 8.0.32 which makes impossible to use the code macro or write Python scripts so you should avoid this version if possible. See https://bz.apache.org/bugzilla/show_bug.cgi?id=58999.
456 {{/error}}
457
458 * XWiki 12.0+ requires a Tomcat version >= 8 since it requires Servlet 3.1+
459 * Older versions of XWiki require a Tomcat version >= 7 since it requires Servlet 3.0+
Jan-Paul Kleijn 77.1 460 * Tomcat 7 is not using URF-8 by default. Edit the ##conf/server.xml## file to set the UTF-8 encoding:(((
Jan-Paul Kleijn 76.1 461 {{code language="none"}}
462 <Connector port="8080"
463 ...
464 URIEncoding="UTF-8">
465 </Connector>
Vincent Massol 54.1 466 {{/code}}
467 )))

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected