36
40
Tomcat. This document is for the HTML web interface to the web application
37
41
<a href="manager-howto.html">manager</a>.</p>
39
<p>The interface is divided into five sections:
43
<p>The interface is divided into six sections:</p>
41
45
<li><strong>Message</strong> - Displays success and failure messages.</li>
42
46
<li><strong>Manager</strong> - General manager operations like list and
44
48
<li><strong>Applications</strong> - List of web applications and
46
50
<li><strong>Deploy</strong> - Deploying web applications.</li>
51
<li><strong>Diagnostics</strong> - Identifying potential problems.</li>
47
52
<li><strong>Server Information</strong> - Information about the Tomcat
84
87
<p>The Applications section lists information about all the installed web
85
88
applications and provides links for managing them. For each web application
86
the following is displayed:
89
the following is displayed:</p>
88
91
<li><strong>Path</strong> - The web application context path.</li>
89
92
<li><strong>Display Name</strong> - The display name for the web application
130
132
<p>Otherwise, the Message will start with <code>FAIL</code> and include an
131
error message. Possible causes for problems include:
133
error message. Possible causes for problems include:</p>
133
135
<li><em>Encountered exception</em>
170
171
<p>Otherwise, the Message will start with <code>FAIL</code> and include an
171
error message. Possible causes for problems include:
172
error message. Possible causes for problems include:</p>
173
174
<li><em>Encountered exception</em>
218
218
<p>Otherwise, the Message will start with <code>FAIL</code> and include an
219
error message. Possible causes for problems include:
219
error message. Possible causes for problems include:</p>
221
221
<li><em>Encountered exception</em>
276
275
<p>Otherwise, the Message will start with <code>FAIL</code> and include an
277
error message. Possible causes for problems include:
276
error message. Possible causes for problems include:</p>
279
278
<li><em>Encountered exception</em>
335
333
<p>In this example the web application located in the directory
336
334
<code>C:\path\to\foo</code> on the Tomcat server (running on Windows)
337
is deployed as the web application context named <code>/footoo</code>.
335
is deployed as the web application context named <code>/footoo</code>.</p>
339
337
Context Path: /footoo
340
338
WAR or Directory URL: file:C:/path/to/foo
344
342
<p>In this example the ".war" file <code>/path/to/bar.war</code> on the
345
343
Tomcat server (running on Unix) is deployed as the web application
346
344
context named <code>/bar</code>. Notice that there is no <code>path</code>
347
345
parameter so the context path defaults to the name of the web application
348
archive file without the ".war" extension.
346
archive file without the ".war" extension.</p>
350
348
WAR or Directory URL: jar:file:/path/to/bar.war!/
354
352
<h3>Deploy a Directory or War from the Host appBase</h3>
361
359
<code>foo</code> in the Host appBase directory of the Tomcat server is
362
360
deployed as the web application context named <code>/foo</code>. Notice
363
361
that there is no <code>path</code> parameter so the context path defaults
364
to the name of the web application directory.
362
to the name of the web application directory.</p>
366
364
WAR or Directory URL: foo
370
368
<p>In this example the ".war" file <code>bar.war</code> located in your
371
369
Host appBase directory on the Tomcat server is deployed as the web
372
application context named <code>/bartoo</code>.
370
application context named <code>/bartoo</code>.</p>
374
372
Context Path: /bartoo
375
373
WAR or Directory URL: bar.war
379
377
<h3>Deploy using a Context configuration ".xml" file</h3>
387
385
<p>A Context configuration ".xml" file can contain valid XML for a
388
386
web application Context just as if it were configured in your
389
387
Tomcat <code>server.xml</code> configuration file. Here is an
390
example for Tomcat running on Windows:
388
example for Tomcat running on Windows:</p>
392
390
<Context path="/foobar" docBase="C:\path\to\application\foobar"
403
401
<p>Use of the <i>WAR or Directory URL</i> is optional. When used
404
402
to select a web application ".war" file or directory it overrides any
405
403
docBase configured in the context configuration ".xml" file.</p>
407
405
<p>Here is an example of installing an application using a Context
408
configuration ".xml" file for Tomcat running on Windows.
406
configuration ".xml" file for Tomcat running on Windows.</p>
410
408
XML Configuration file URL: file:C:/path/to/context.xml
414
412
<p>Here is an example of installing an application using a Context
415
413
configuration ".xml" file and a web application ".war" file located
416
on the server (Tomcat running on Unix).
414
on the server (Tomcat running on Unix).</p>
418
416
XML Configuration file URL: file:/path/to/context.xml
419
417
WAR or Directory URL: jar:file:/path/to/bar.war!/
547
<section name="Diagnostics">
549
<subsection name="Finding memory leaks">
551
<p><strong>The find leaks diagnostic triggers a full garbage collection. It
552
should be used with extreme caution on production systems.</strong></p>
554
<p>The find leaks diagnostic attempts to identify web applications that have
555
caused memory leaks when they were stopped, reloaded or undeployed. Results
556
should always be confirmed
557
with a profiler. The diagnostic uses additional functionality provided by the
558
StandardHost implementation. It will not work if a custom host is used that
559
does not extend StandardHost.</p>
561
<p>This diagnostic will list context paths for the web applications that were
562
stopped, reloaded or undeployed, but which classes from the previous runs
563
are still present in memory, thus being a memory leak. If an application
564
has been reloaded several times, it may be listed several times.</p>
566
<p>Explicitly triggering a full garbage collection from Java code is documented
567
to be unreliable. Furthermore, depending on the JVM used, there are options to
568
disable explicit GC triggering, like <code>-XX:+DisableExplicitGC</code>.
569
If you want to make sure, that the diagnostics were successfully running a full GC,
570
you will need to check using tools like GC logging, JConsole or similar.</p>
549
575
<section name="Server Information">
551
577
<p>This section displays information about Tomcat, the operating system of
added
removed
webapps/docs/html-manager-howto.xml
