Wiki source code of Tomcat Installation

Version 80.1 by Jan-Paul Kleijn on 2023/01/07

Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 = Installation Steps =
6
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}}
9 * Using Tomcat 10 is not recommended right now since it moved to the incompatible Jakarta EE 9 API. See [[Apache Tomcat migration tool for Jakarta EE>>https://github.com/apache/tomcat-jakartaee-migration]] for mode details.
10 * Tomcat 9.0.70 has some bugs that make it fail with XWiki, please use version 9.0.69 instead (at the point of writing there's no version 9.0.71 version out). See:
11 ** https://jira.xwiki.org/browse/XWIKI-20470
12 ** https://jira.xwiki.org/browse/XWIKI-20476
13 {{/warning}}
14 )))
15 * Make sure you [[give enough memory to Java>>platform:AdminGuide.InstallationTomcat#HOutOfMemoryError]] since by default Tomcat is not configured with enough memory for XWiki.
16 * Extract the [[XWiki WAR>>xwiki:Main.Download]] into a directory named ##xwiki## in ##TOMCAT_HOME/webapps/##
17 * Open ##TOMCAT_HOME/webapps/xwiki/WEB-INF/xwiki.properties## files and [[configure a permanent directory>>platform:AdminGuide.Configuration#HConfiguringDirectories]]
18 * Start Tomcat
19 * When Tomcat has opened go to your wiki by accessing [[http:~~/~~/localhost:8080/xwiki/bin/view/Main/>>http://localhost:8080/xwiki/bin/view/Main/]]
20 * NOTE - if you have issues with maximum cache size - In your ##$CATALINA_BASE/conf/context.xml## add the following content before ##</Context>##:(((
21 {{code language="none"}}
22 <Resources cachingAllowed="true" cacheMaxSize="100000" ></Resources>
23 {{/code}}
24 )))
25
26 == Activate headless mode ==
27
28 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:
29
30 * ##Exception: Could not initialize class sun.awt.X11.XToolkit##
31 * ##java.lang.InternalError: Can't connect to X11 window server using 'localhost:10.0' as the value of the DISPLAY variable##
32
33 * On Linux create a file ##///TOMCAT_HOME///bin/setenv.sh## and insert the following code:(((
34 {{code language="none"}}
35 #!/bin/sh
36 export JAVA_OPTS="${JAVA_OPTS} -Djava.awt.headless=true"
37 {{/code}}
38 )))
39 * On Windows create a file ##///TOMCAT_HOME///bin/setenv.bat## and insert the following code:(((
40 {{code language="none"}}
41 set JAVA_OPTS=%JAVA_OPTS% -Djava.awt.headless=true
42 {{/code}}
43 )))
44 * 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.
45
46 == Optional configuration ==
47
48 * 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:
49 - On Linux: ##/etc/tomcat[version]/server.xml##
50 - On Windows: ##//TOMCAT_HOME///conf/server.xml##(((
51 {{code language="none"}}
52 <Connector port="8080"
53 ...
54 compression="on"
55 compressionMinSize="2048"
56 compressibleMimeType="text/html,text/xml,text/css,text/javascript,application/x-javascript">
57 </Connector>
58 {{/code}}
59 )))
60 * 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.
61 * 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"]].
62 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.
63
64 == Policy configuration ==
65
66 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 :
67
68 {{code language="none"}}
69 grant codeBase "file:${catalina.base}/webapps/xwiki/WEB-INF/lib/-" {
70 // for mySQL connection
71 permission java.net.SocketPermission "127.0.0.1:3306", "connect,resolve";
72
73 // XWiki must have access to all properties in read/write
74 permission java.util.PropertyPermission "*", "read, write";
75
76 // Generic detected permissions
77 permission java.lang.reflect.ReflectPermission "suppressAccessChecks";
78 permission java.lang.RuntimePermission "createClassLoader";
79 permission java.lang.RuntimePermission "setContextClassLoader";
80 permission java.lang.RuntimePermission "accessClassInPackage.org.apache.catalina.loader";
81 permission java.lang.RuntimePermission "accessDeclaredMembers";
82 permission java.lang.RuntimePermission "getenv.ProgramFiles";
83 permission java.lang.RuntimePermission "getenv.APPDATA";
84 permission java.lang.RuntimePermission "accessClassInPackage.sun.reflect";
85 permission java.lang.RuntimePermission "getClassLoader";
86 permission java.lang.RuntimePermission "accessClassInPackage.org.apache.catalina.connector";
87 permission java.lang.RuntimePermission "accessClassInPackage.org.apache.tomcat.util.threads";
88 permission java.lang.RuntimePermission "reflectionFactoryAccess";
89 permission java.lang.RuntimePermission "accessClassInPackage.com.sun.jmx.interceptor";
90 permission java.lang.RuntimePermission "accessClassInPackage.com.sun.jmx.mbeanserver";
91 permission java.lang.RuntimePermission "modifyThread";
92 permission java.lang.RuntimePermission "getProtectionDomain";
93
94 // JAXB permissions
95 permission javax.xml.bind.JAXBPermission "setDatatypeConverter";
96
97 // Serialization related permissions
98 permission java.io.SerializablePermission "allowSerializationReflection";
99 permission java.io.SerializablePermission "creator";
100 permission java.io.SerializablePermission "enableSubclassImplementation";
101
102 // Internal resources access permissions
103 permission java.io.FilePermission "synonyms.txt", "read";
104 permission java.io.FilePermission "lang/synonyms_en.txt", "read";
105 permission java.io.FilePermission "quartz.properties", "read";
106 permission java.io.FilePermission "/templates/-", "read";
107 permission java.io.FilePermission "/skins/-", "read";
108 permission java.io.FilePermission "/resources/-", "read";
109
110 // MBean related permissions
111 permission javax.management.MBeanServerPermission "createMBeanServer";
112 permission javax.management.MBeanPermission "*", "registerMBean";
113 permission javax.management.MBeanPermission "*", "unregisterMBean";
114 permission javax.management.MBeanTrustPermission "register";
115 permission javax.management.MBeanPermission "-#-[-]", "queryNames";
116 permission javax.management.MBeanServerPermission "findMBeanServer";
117
118 // LibreOffice/OpenOffice related permissions
119 permission java.io.FilePermission "/opt/openoffice.org3/program/soffice.bin", "read";
120 permission java.io.FilePermission "/opt/libreoffice/program/soffice.bin", "read";
121 permission java.io.FilePermission "/usr/lib/openoffice/program/soffice.bin", "read";
122 permission java.io.FilePermission "/usr/lib/libreoffice/program/soffice.bin", "read";
123
124 // Allow file storage directory reading - for directory and everything underneath
125 // This is dependent on the setting of environment.permanentDirectory in xwiki.properties
126 permission java.io.FilePermission "${catalina.base}${file.separator}xwikidata${file.separator}", "read,write,delete";
127 permission java.io.FilePermission "${catalina.base}${file.separator}xwikidata${file.separator}-", "read,write,delete";
128
129 // Allow file storage directory reading - temporary directory and everything underneath
130 // This is dependent on the setting of environment.temporaryDirectory in xwiki.properties.
131 permission java.io.FilePermission "${catalina.base}${file.separator}temp${file.separator}", "read,write,delete";
132 permission java.io.FilePermission "${catalina.base}${file.separator}temp${file.separator}-", "read,write,delete";
133 };
134 {{/code}}
135
136 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.
137
138 == Using Nginx as a reverse-proxy for Tomcat (http/https) ==
139
140 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. A 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.
141
142 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.
143
144 === Http (unsecure) ===
145
146 * create this file ##/etc/nginx/conf.d/tomcat.conf##
147 * put the following code inside:(((
148 {{code language="none"}}
149 server {
150 listen 80;
151 server_name mydomain.com;
152
153 # Normally root should not be accessed, however, root should not serve files that might compromise the security of your server.
154 root /var/www/html;
155
156 # Configuration to avoid Request Entity too large error 413
157 client_max_body_size 0;
158
159 location / {
160 # All "root" requests will have /xwiki appended AND redirected to mydomain.com
161 rewrite ^ $scheme://$server_name/xwiki$request_uri? permanent;
162 }
163
164 location ^~ /xwiki {
165 # If path starts with /xwiki - then redirect to backend: XWiki application in Tomcat
166 # Read more about proxy_pass: http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_pass
167 proxy_pass http://localhost:8080;
168 proxy_set_header X-Real-IP $remote_addr;
169 proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
170 proxy_set_header Host $http_host;
171 proxy_set_header X-Forwarded-Proto $scheme;
172 }
173 }
174 {{/code}}
175 )))
176 * restart nginx
177
178 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"]].
179
180 === Https (secure) ===
181
182 There are many guides on how to create a secure configuration of nginx. To get started:
183
184 * [[Strong SSL Security on nginx>>https://raymii.org/s/tutorials/Strong_SSL_Security_On_nginx.html||rel="__blank"]]
185 * [[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"]]
186
187 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.
188
189 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.
190
191 (((
192 {{code language="none"}}
193 <Engine name="Catalina" defaultHost="localhost">
194 <Valve className="org.apache.catalina.valves.RemoteIpValve"
195 internalProxies="127\.0\.[0-1]\.1"
196 remoteIpHeader="x-forwarded-for"
197 requestAttributesEnabled="true"
198 protocolHeader="x-forwarded-proto"
199 protocolHeaderHttpsValue="https"></Valve>
200 {{/code}}
201 )))
202
203 Next, add the following nginx config file to your nginx config folder, replacing ##wiki.yourdomain.com## with your actual domain info:
204
205 (((
206 {{code language="none"}}
207 server {
208 listen 80;
209 server_name wiki.yourdomain.com;
210
211 location ~ /.well-known {
212 allow all;
213 }
214
215 rewrite ^ https://$server_name$request_uri? permanent;
216
217 access_log /var/log/nginx-xwiki/access.log;
218 error_log /var/log/nginx-xwiki/error.log;
219
220 }
221
222 server {
223 listen 443;
224 server_name wiki.yourdomain.com;
225
226 root /var/www/html;
227
228 # Configuration to avoid Request Entity too large error 413
229 client_max_body_size 0;
230
231 ssl on;
232 ssl_certificate /etc/letsencrypt/live/wiki.yourdomain.com/fullchain.pem;
233 ssl_certificate_key /etc/letsencrypt/live/wiki.yourdomain.com/privkey.pem;
234
235 access_log /var/log/nginx-xwiki/access_ssl.log;
236 error_log /var/log/nginx-xwiki/error_ssl.log;
237
238 location / {
239 proxy_set_header Host $http_host;
240 proxy_set_header X-Real-IP $remote_addr;
241 proxy_set_header X-Forward-For $proxy_add_x_forwarded_for;
242 proxy_set_header X-Forwarded-Proto $scheme;
243 proxy_set_header X-Scheme $scheme;
244 proxy_redirect off;
245 if (!-f $request_filename) {
246 proxy_pass http://127.0.0.1:8080;
247 break;
248 }
249 }
250
251 location ~ /.well-known {
252 allow all;
253 }
254 }
255 {{/code}}
256 )))
257
258 For more background on this config, see the discussion on this ticket: [[XWIKI-13963>>http://jira.xwiki.org/browse/XWIKI-13963||rel="__blank"]].
259
260 === Proxying and tunnels ===
261
262 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.
263
264 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:##
265
266 * 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.
267 * 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.
268
269 == Configuring tomcat for https ==
270
271 Although allowing users to directly connect to tomcat is not recommended, for a variety of reasons it may be desirable to configure tomcat to serve pages over an https connection. Since urls are generated from relative path (##/xwiki/bin/show/Space/Page##), Tomcat has to know which protocol to use, otherwise JSON requests with redirect fails such as in attachment uploads, extension updating, etc.
272
273 If you are using another server as a HTTPS proxy (such as Nginx, Apache httpd or HAProxy), follow the instructions below to avoid unexpected errors (such as "failed to lock page").
274
275 * Modify the connector property in ##server.xml## to set the correct https attributes(((
276 {{code language="none"}}
277 <Connector port="8080"
278 ...
279 secure="true"
280 scheme="https">
281 </Connector>
282 {{/code}}
283 )))
284 * Modify the host property in ##server.xml## to add the Remote Ip Valve(((
285 {{code language="none"}}
286 <Valve className="org.apache.catalina.valves.RemoteIpValve"
287 remoteIpHeader="x-forwarded-for"
288 protocolHeader="x-forwarded-proto">
289 </Valve>
290 {{/code}}
291 )))
292
293 {{info}}
294 **Important**
295 Remember to set ##X-Forwarded-For## and ##X-Forwarded-Proto## headers on HTTPS guard server (on which Apache httpd or Nginx runs)
296 {{/info}}
297
298 = Recommendations =
299
300 == Default encoding ==
301
302 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.
303
304 = Troubleshooting =
305
306 == Out Of Memory Error ==
307
308 === General Memory Settings ===
309
310 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>>platform:AdminGuide.Performances#HMemory]]. You'll need to allocate more memory to the JVM.
311
312 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>>platform:AdminGuide.Performances#HMemory]]). For example:
313
314 {{code language="none"}}
315 CATALINA_OPTS="-Xmx1024m -XX:MaxPermSize=192m"
316 {{/code}}
317
318 On most Linux distributions, this can also be achieved in ##/etc/tomcat//X///tomcat//X//.conf## or ##/etc/conf.d/tomcat//X//.conf## (where //X// is the version of Tomcat installed).
319
320 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.
321
322 === Max number of threads ===
323
324 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##)
325
326 If you have such messages in the ##catalina.out## check your default limitations of the ##systemd## with the command
327
328 {{code language="none"}}
329 > systemctl show --property DefaultTasksMax
330 {{/code}}
331
332 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.
333
334 Changing the parameter ##DefaultTasksMax## in ##/etc/systemd/system.conf## to a larger value, restarting the ##system-daemon## and ##tomcat9##, should solve the problem.
335
336 {{code language="none"}}
337 > systemctl daemon-reload
338 > systemctl restart tomcat9
339 {{/code}}
340
341 If the problem is not fixed with these changes, check the number of currently used threads by tomcat9 with the command
342
343 {{code language="none"}}
344 > ps -elfT | grep tomcat9| wc -l
345 {{/code}}
346
347 If the value is very near to the configured ##DefaultTasksMax##, you can try to increase it to an appropriate value.
348
349 == Java Security Manager ==
350
351 By default Tomcat is configured to have the Java Security Manager turned on. See the [[sample policy file>>platform:AdminGuide.InstallationWAR#HInstallandconfigureaServletContainer]] for more details.
352
353 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:
354
355 {{code language="none"}}
356 # Use the Java security manager? (yes/no)
357 TOMCAT5_SECURITY=
358 {{/code}}
359
360 Set it to ##no## to turn off the Security Manager.
361
362 == Allowing "/" and "\" in page names ==
363
364 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.
365
366 You can configure Tomcat to allow "/", by setting the ##org.apache.tomcat.util.buf.UDecoder.ALLOW_ENCODED_SLASH## system property to ##true##, as in:
367
368 {{code language="none"}}
369 -Dorg.apache.tomcat.util.buf.UDecoder.ALLOW_ENCODED_SLASH=true
370 {{/code}}
371
372 And by setting the ##org.apache.catalina.connector.CoyoteAdapter.ALLOW_BACKSLASH## system property to ##true## to allow "\", as in:
373
374 {{code language="none"}}
375 -Dorg.apache.catalina.connector.CoyoteAdapter.ALLOW_BACKSLASH=true
376 {{/code}}
377
378 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.
379
380 {{code language="none"}}
381 -Dorg.apache.tomcat.util.buf.UDecoder.ALLOW_ENCODED_SLASH=true
382 -Dorg.apache.catalina.connector.CoyoteAdapter.ALLOW_BACKSLASH=true
383 {{/code}}
384
385 === Apache front-end server ===
386
387 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]].
388
389 == NotSerializableException ==
390
391 If you get the following:
392
393 {{code language="none"}}
394 SEVERE: IOException while loading persisted sessions: java.io.WriteAbortedException: writing aborted; java.io.NotSerializableException: org.xwiki.model.internal.reference.LocalStringEntityReferenceSerializer
395 java.io.WriteAbortedException: writing aborted; java.io.NotSerializableException: org.xwiki.model.internal.reference.LocalStringEntityReferenceSerializer
396 at java.io.ObjectInputStream.readObject0(Unknown Source)
397 at java.io.ObjectInputStream.defaultReadFields(Unknown Source)
398 {{/code}}
399
400 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]].
401
402 == SEVERE: Error listenerStart ==
403
404 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:
405
406 {{code language="none"}}
407 org.apache.catalina.core.ContainerBase.[Catalina].level = INFO
408 org.apache.catalina.core.ContainerBase.[Catalina].handlers = java.util.logging.ConsoleHandler
409 {{/code}}
410
411 == Parameter count exceeded allowed maximum ==
412
413 If you get an error such as the following it means you reached the limit of parameters you can send in a form.
414
415 {{code language="none"}}
416 java.lang.IllegalStateException: Parameter count exceeded allowed maximum: 512
417 {{/code}}
418
419 You can set the value you want by setting the following in your Tomcat ##server.xml## file:
420
421 {{code language="none"}}
422 <Connector port=... maxParameterCount="10000" ></Connector>
423 {{/code}}
424
425 == ThreadLocal Errors ==
426
427 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.
428
429 {{code language="none"}}
430 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.
431 {{/code}}
432
433 = Old Instructions =
434
435 Note that [[Tomat 7 is no longer supported>>dev:Community.SupportStrategy.ServletContainerSupportStrategy.WebHome]].
436
437 {{error}}
438 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:
439
440 * >= 9.0.0.M5 and < 9.0.0.M10 for the 9.0.x branch (fixed in 9.0.0.M10)
441 * >= 8.5.1 and < 8.5.5 for the 8.5.x branch (fixed in 8.5.5)
442 * >= 8.0.34 and < 8.0.37 for the 8.0.x branch (fixed in 8.0.37)
443 * >= 7.0.70 and < 7.0.71 for the 7.0.x branch (fixed in 7.0.71)
444
445 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.
446 {{/error}}
447
448 * XWiki 12.0+ requires a Tomcat version >= 8 since it requires Servlet 3.1+
449 * Older versions of XWiki require a Tomcat version >= 7 since it requires Servlet 3.0+
450 * Tomcat 7 is not using URF-8 by default. Edit the ##conf/server.xml## file to set the UTF-8 encoding:(((
451 {{code language="none"}}
452 <Connector port="8080"
453 ...
454 URIEncoding="UTF-8">
455 </Connector>
456 {{/code}}
457 )))

Get Connected