glenn 01/03/25 19:21:57 Modified: catalina/docs manager.html Log: Improve webapp unpack WAR file behaviour and enhance manager servlet Revision Changes Path 1.3 +33 -24 jakarta-tomcat-4.0/catalina/docs/manager.html Index: manager.html =================================================================== RCS file: /home/cvs/jakarta-tomcat-4.0/catalina/docs/manager.html,v retrieving revision 1.2 retrieving revision 1.3 diff -u -r1.2 -r1.3 --- manager.html 2001/01/14 01:31:44 1.2 +++ manager.html 2001/03/26 03:21:56 1.3 @@ -19,13 +19,15 @@ <h3>Introduction</h3> <p>Tomcat ships with a web application (by default installed at context -path <code>/manager</code>) that facilitates deploying, undeploying, and -reloading (that is, forcing a reload of all class files without removing the -application from service) of other applications that are running in the same -virtual host as the Manager application itself. This application is suited -to scripted operation, because it can be executed from any client program that -can issue HTTP requests. As such, it is complementary to other administrative -applications that have a more human-oriented user interface.</p> +path <code>/manager</code>) that facilitates installing, starting, stopping, +removing, listing information, and reloading (that is, forcing a reload of +all class files without removing the application from service) of other web +applications that are running in the same virtual host as the Manager +application itself. +This application is suited to scripted operation, because it can be executed +from any client program that can issue HTTP requests. As such, it is +complementary to other administrative applications that have a more +human-oriented user interface.</p> <p><strong>WARNING</strong> - As of the Tomcat 4.0 milestone 2 release, there is a bug in the operation of the "deploy" command that prevents deploying, @@ -43,27 +45,36 @@ have installed the Manager application on context path <code>/manager</code> on your local host installation of Tomcat.</p> <ul> -<li><b>http://localhost:8080/manager/list</b> - List the context paths of all - web applications currently deployed on the virtual host in which this - manager application is deployed.</li> -<li><b>http://localhost:8080/manager/deploy?path=/xxx&war=yyy</b> - - Deploy the web application whose WAR file (or directory containing the +<li><b>http://localhost:8080/manager/install?path=/xxx&war=yyy</b> - + Install the web application whose WAR file (or directory containing the unpacked application) is present at URL <code>yyy</code>, and attach it to context path <code>/xxx</code>. See below for valid syntax options for the web applcation archive URl. If the URL of an actual WAR file is specified, the WAR will be automatically expanded into a directory underneath the application base for this virtual host.</li> +<li><b>http://localhost:8080/manager/list</b> - List the context paths + of all currently installed web applications for this virtual host. + Each context will be listed with the following format + <code>path:status:sessions</code>. Where path is the context + path. Status is either running or stopped. Sessions is the number of + active Sessions.</li> <li><b>http://localhost:8080/manager/reload?path=/xxx</b> - Cause the web - application deployed at context path <code>/xxx</code> to reload all its + application installed at context path <code>/xxx</code> to reload all its associated Java classes, even if automatic reloading is disabled.</li> -<li><b>http://localhost:8080/manager/undeploy?path=/xxx</b> - Cause the web - application deployed at context path <code>/xxx</code> to be gracefully - shut down and undeployed. If a WAR file was automatically expanded into - an unpacked directory when this application was deployed (or when the - servlet container was first started), the expanded directory is deleted. - </li> +<li><b>http://localhost:8080/manager/remove?path=/xxx</b> - Cause the web + application installed at context path <code>/xxx</code> to be gracefully + shutdown and delete the web application directory and files.</li> +<li><b>http://localhost:8080/manager/sessions?path=/xxx</b> - List session + information about the web application attached to context path + <code>/xxx</code> for this virtual host.</li> +<li><b>http://localhost:8080/manager/start?path=/xxx</b> - Start the web + application attached to context path <code>/xxx</code> for this + virtual host.</li> +<li><b>http://localhost:8080/manager/stop?path=/xxx</b> - Stop the web + application attached to context path <code>/xxx</code> for this + virtual host.</li> </ul> - +<p>Use <code>path=/</code> for the ROOT context.</p> <p>The syntax of the URL for a web application archive must conform to one of the following patterns to be successfully deployed:</p> <ul> @@ -87,9 +98,7 @@ The first line of the response starts with "OK - " or "FAIL - " depending on whether the requested operation was successful or not, followed by a descriptive summary of the operation that took place, or the error that -prevented the requested operation from taking place. If the <code>/list</code> -operation was requested, this line is followed by a list of the context paths -of all deployed web applcations in this virtual host, one per line.</p> +prevented the requested operation from taking place.</p> <a name="Security"></a> <h3>Security Considerations</h3> @@ -120,7 +129,7 @@ <br> <div align="center"><hr width="75%"><font size="2"> -$Id: manager.html,v 1.2 2001/01/14 01:31:44 craigmcc Exp $ +$Id: manager.html,v 1.3 2001/03/26 03:21:56 glenn Exp $ </font></div> </body>
