Deployment is the term used for the process of installing a web @@ -51,15 +41,14 @@

Web application deployment may be accomplished in a number of ways - within the Tomcat server. -

Statically; the web application is setup before Tomcat is started
Dynamically; in conjunction with the Tomcat Manager web application or manipulating already deployed web applications

The Tomcat Manager is a tool that allows URL-based web application deployment features. There is also a tool called the Client Deployer, @@ -125,11 +114,13 @@ these Context Descriptors to perform their roles properly.

- The locations for Context Descriptors are; -

$CATALINA_BASE/conf/[enginename]/[hostname]/context.xml
$CATALINA_BASE/webapps/[webappname]/META-INF/context.xml

Files in (1) are named [webappname].xml but files in (2) are named context.xml. If a Context Descriptor is not provided for a Context, Tomcat configures the Context using default values. diff --git a/webapps/docs/manager-howto.xml b/webapps/docs/manager-howto.xml index f71f07bca..c285c5196 100644 --- a/webapps/docs/manager-howto.xml +++ b/webapps/docs/manager-howto.xml @@ -30,41 +30,7 @@

- -

-Introduction
- -Configuring Manager Application Access
-Supported Manager Commands
-

-Deploy A New Application Remotely
-Deploy A New Application from a Local Path
- -List Currently Deployed Applications
-Reload An Existing Application
-List OS and JVM Properties
- -List Available Global JNDI Resources
-List Available Security Roles
-Session Statistics
-Start an Existing Application
-Stop an Existing Application
- -Undeploy an Existing Application
-Server Status
-Finding memory leaks
-

- -Executing Manager Commands With Ant
- -Using the JMX Proxy Servlet
-

-What is JMX Proxy Servlet?
-Query command
-Set command
-

- +

@@ -104,18 +70,17 @@ the following functions:

Manager web application Context to a new host install the manager.xml context configuration file in the $CATALINA_BASE/conf/[enginename]/[hostname] folder. Here is an -example: +example:

 <Context path="/manager" debug="0" privileged="true"
          docBase="/usr/local/kinetic/tomcat6/server/webapps/manager">
 </Context>

If you have Tomcat configured to support multiple virtual hosts (websites) you would need to configure a Manager for each.

There are three ways to use the Manager web application. +

There are three ways to use the Manager web application.

As an application with a user interface you use in your browser. Here is an example URL where you can replace localhost with @@ -130,19 +95,18 @@ Supported Manager Commands for more information.

Executing Manager Commands With Ant

-
The description below uses the variable name $CATALINA_BASE to refer the +
+
The description below uses the variable name $CATALINA_BASE to refer the base directory against which most relative paths are resolved. If you have not configured Tomcat for multiple instances by setting a CATALINA_BASE directory, then $CATALINA_BASE will be set to the value of $CATALINA_HOME, - the directory into which you have installed Tomcat.
-
+ the directory into which you have installed Tomcat.
+

It would be quite unsafe to ship Tomcat with default settings that allowed anyone on the Internet to execute the Manager application on your server. @@ -150,7 +114,7 @@ Therefore, the Manager application is shipped with the requirement that anyone who attempts to use it must authenticate themselves, using a username and password that have the role manager-script associated with them. Further, there is no username in the default users file -($CATALINA_BASE/conf/tomcat-users.xml) that is assigned this +($CATALINA_BASE/conf/tomcat-users.xml) that is assigned this role. Therefore, access to the Manager application is completely disabled by default.

@@ -197,7 +161,7 @@ the role manager.

In addition to the password restrictions the manager web application could be restricted by the remote IP address or host by adding a RemoteAddrValve or RemoteHostValve. Here is -an example of restricting access to the localhost by IP address: +an example of restricting access to the localhost by IP address:

 <Context path="/manager" privileged="true"
          docBase="/usr/local/kinetic/tomcat6/server/webapps/manager">
@@ -205,7 +169,6 @@ an example of restricting access to the localhost by IP address:
                 allow="127\.0\.0\.1"/>
 </Context>

@@ -287,7 +250,7 @@ removed) by use of the /undeploy command.

including a Context configuration XML file in /META-INF/context.xml.

URL parameters include: +

URL parameters include:

update: When set to true, any existing update will be undeployed first. The default value is set to false.

NOTE - This command is the logical opposite of the /undeploy command.

@@ -344,11 +306,11 @@ This command is the logical opposite of the /undeploy command.

This can be used to deploy a previous version of a web application, which has been deployed using the tag attribute. Note that the work directory for the manager webapp will contain the previously deployed WARs; -removing it would make the deployment fail. +removing it would make the deployment fail.

http://localhost:8080/manager/text/deploy?path=/footoo&tag=footag -

Deploy a Directory or WAR by URL

@@ -363,21 +325,21 @@ the entire WAR file.

In this example the web application located in the directory /path/to/foo on the Tomcat server is deployed as the -web application context named /footoo. +web application context named /footoo.

http://localhost:8080/manager/text/deploy?path=/footoo&war=file:/path/to/foo -

In this example the ".war" file /path/to/bar.war on the Tomcat server is deployed as the web application context named /bar. Notice that there is no path parameter so the context path defaults to the name of the web application archive -file without the ".war" extension. +file without the ".war" extension.

http://localhost:8080/manager/text/deploy?war=jar:file:/path/to/bar.war!/ -

Deploy a Directory or War from the Host appBase

@@ -388,19 +350,19 @@ extension is used as the path.

In this example the web application located in a sub directory named foo in the Host appBase directory of the Tomcat server is deployed as the web application context named /foo. Notice -that the context path used is the name of the web application directory. +that the context path used is the name of the web application directory.

http://localhost:8080/manager/text/deploy?war=foo -

In this example the ".war" file bar.war located in your Host appBase directory on the Tomcat server is deployed as the web -application context named /bar. +application context named /bar.

http://localhost:8080/manager/text/deploy?war=bar.war -

Deploy using a Context configuration ".xml" file

@@ -413,7 +375,7 @@ configuration file.

A Context configuration ".xml" file can contain valid XML for a web application Context just as if it were configured in your Tomcat server.xml configuration file. Here is an -example: +example:

<Context path="/foobar" docBase="/path/to/application/foobar" debug="0"> @@ -424,26 +386,26 @@ example: </Context> -

When the optional war parameter is set to the URL for a web application ".war" file or directory it overrides any docBase configured in the context configuration ".xml" file.

Here is an example of deploying an application using a Context -configuration ".xml" file. +configuration ".xml" file.

http://localhost:8080/manager/text/deploy?config=file:/path/context.xml -

Here is an example of deploying an application using a Context configuration ".xml" file and a web application ".war" file located -on the server. +on the server.

http://localhost:8080/manager/text/deploy?config=file:/path/context.xml&war=jar:file:/path/bar.war!/ -

Deployment Notes

@@ -1257,7 +1219,7 @@ can be used: calling a Catalina task more than once, badly set Ant tasks depends chains may cause that a task be called more than once in the same Ant run, even if not intended to. A bit of caution should be exercised when you are -capturing output from that task, because this could lead to something unexpected: +capturing output from that task, because this could lead to something unexpected:

when capturing in a property you will find in it only the output from the first call, because Ant properties are immutable and once set they cannot be changed, @@ -1267,7 +1229,6 @@ output, unless you are using the append="true" attribute, in which see the output of each task call appended to the file.

-- 2.11.0