You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by kk...@apache.org on 2014/11/26 00:59:50 UTC
svn commit: r1641726 - in /tomcat/tc8.0.x/trunk: ./
webapps/docs/html-manager-howto.xml webapps/docs/manager-howto.xml
Author: kkolinko
Date: Tue Nov 25 23:59:49 2014
New Revision: 1641726
URL: http://svn.apache.org/r1641726
Log:
Improve documentation of the Manager application:
Merged revisions 1641707-1641718 from tomcat/trunk:
r1641707: Wrap parameters that are common to all commands into a "Common Parameters" subsection, so that they are listed in TOC.
r1641718: Arrange description of variants of Deploy command as subsections, so that have a bigger header (h5->h4) and are listed in TOC.
Modified:
tomcat/tc8.0.x/trunk/ (props changed)
tomcat/tc8.0.x/trunk/webapps/docs/html-manager-howto.xml
tomcat/tc8.0.x/trunk/webapps/docs/manager-howto.xml
Propchange: tomcat/tc8.0.x/trunk/
------------------------------------------------------------------------------
Merged /tomcat/trunk:r1641707-1641718
Modified: tomcat/tc8.0.x/trunk/webapps/docs/html-manager-howto.xml
URL: http://svn.apache.org/viewvc/tomcat/tc8.0.x/trunk/webapps/docs/html-manager-howto.xml?rev=1641726&r1=1641725&r2=1641726&view=diff
==============================================================================
--- tomcat/tc8.0.x/trunk/webapps/docs/html-manager-howto.xml (original)
+++ tomcat/tc8.0.x/trunk/webapps/docs/html-manager-howto.xml Tue Nov 25 23:59:49 2014
@@ -300,7 +300,7 @@ This command is the logical opposite of
<p>There are a number of different ways the deploy command can be used.</p>
-<h5>Deploy a Directory or WAR by URL</h5>
+<subsection name="Deploy a Directory or WAR by URL">
<p>Install a web application directory or ".war" file located on the Tomcat
server. If no <i>Context Path</i> is specified, the directory name or the
@@ -314,8 +314,7 @@ refer to the entire WAR file.</p>
<p>In this example the web application located in the directory
<code>C:\path\to\foo</code> on the Tomcat server (running on Windows)
is deployed as the web application context named <code>/footoo</code>.</p>
-<source>
-Context Path: /footoo
+<source>Context Path: /footoo
WAR or Directory URL: file:C:/path/to/foo
</source>
@@ -327,8 +326,9 @@ parameter so the context path defaults t
archive file without the ".war" extension.</p>
<source>WAR or Directory URL: jar:file:/path/to/bar.war!/</source>
+</subsection>
-<h5>Deploy a Directory or War from the Host appBase</h5>
+<subsection name="Deploy a Directory or War from the Host appBase">
<p>Install a web application directory or ".war" file located in your Host
appBase directory. If no <i>Context Path</i> is specified the directory name
@@ -348,8 +348,9 @@ application context named <code>/bartoo<
<source>Context Path: /bartoo
WAR or Directory URL: bar.war</source>
+</subsection>
-<h5>Deploy using a Context configuration ".xml" file</h5>
+<subsection name="Deploy using a Context configuration ".xml" file">
<p>If the Host deployXML flag is set to true, you can install a web
application using a Context configuration ".xml" file and an optional
@@ -380,7 +381,7 @@ on the server (Tomcat running on Unix).<
<source>XML Configuration file URL: file:/path/to/context.xml
WAR or Directory URL: jar:file:/path/to/bar.war!/</source>
-
+</subsection>
</subsection>
<subsection name="Upload a WAR file to install">
Modified: tomcat/tc8.0.x/trunk/webapps/docs/manager-howto.xml
URL: http://svn.apache.org/viewvc/tomcat/tc8.0.x/trunk/webapps/docs/manager-howto.xml?rev=1641726&r1=1641725&r2=1641726&view=diff
==============================================================================
--- tomcat/tc8.0.x/trunk/webapps/docs/manager-howto.xml (original)
+++ tomcat/tc8.0.x/trunk/webapps/docs/manager-howto.xml Tue Nov 25 23:59:49 2014
@@ -249,16 +249,21 @@ represents the Manager command you wish
that are specific to that command. In the illustrations below, customize
the host and port appropriately for your installation.</p>
+<p>The commands are usually executed by HTTP GET requests. The
+<code>/deploy</code> command has a form that is executed by an HTTP PUT request.</p>
+
+<subsection name="Common Parameters">
+
<p>Most commands accept one or more of the following query parameters:</p>
<ul>
<li><strong>path</strong> - The context path (including the leading slash)
of the web application you are dealing with. To select the ROOT web
- application, specify "/". <strong>NOTE</strong> -
+ application, specify "/". <strong>NOTE</strong>:
It is not possible to perform administrative commands on the
Manager application itself.</li>
<li><strong>version</strong> - The version of this web application as used by
- the parallel deployment feature,</li>
-<li><strong>war</strong> - URL of a web application archive (WAR) file,
+ the <a href="config/context.html">parallel deployment</a> feature,</li>
+<li><strong>war</strong> - URL of a web application archive (WAR) file, or
pathname of a directory which contains the web application, or a
Context configuration ".xml" file. You can use URLs in any of the
following formats:
@@ -298,7 +303,9 @@ its message strings in resource bundles,
have been translated for your platform. The examples below show the English
version of the messages.</p>
-<subsection name="Deploy A New Application Remotely">
+</subsection>
+
+<subsection name="Deploy A New Application Archive (WAR) Remotely">
<source>http://localhost:8080/manager/text/deploy?path=/foo</source>
@@ -309,6 +316,8 @@ name or the war file name without the .w
application can later be undeployed (and the corresponding application directory
removed) by use of the <code>/undeploy</code> command.</p>
+<p>This command is executed by an HTTP PUT request.</p>
+
<p>The .WAR file may include Tomcat specific deployment configuration, by
including a Context configuration XML file in
<code>/META-INF/context.xml</code>.</p>
@@ -358,18 +367,21 @@ error message. Possible causes for prob
<code>path</code> (which must not be in use by any other web application).
This command is the logical opposite of the <code>/undeploy</code> command.</p>
-<p>There are a number of different ways the deploy command can be used.</p>
+<p>This command is executed by an HTTP GET request.
+There are a number of different ways the deploy command can be used.</p>
+
+<subsection name="Deploy a previously deployed webapp">
-<h5>Deploy a previously deployed webapp</h5>
+<source>http://localhost:8080/manager/text/deploy?path=/footoo&tag=footag</source>
<p>This can be used to deploy a previously deployed web application, which
has been deployed using the <code>tag</code> attribute. Note that the work
-directory for the Manager webapp will contain the previously deployed WARs;
+directory of the Manager webapp will contain the previously deployed WARs;
removing it would make the deployment fail.</p>
-<source>http://localhost:8080/manager/text/deploy?path=/footoo&tag=footag</source>
+</subsection>
-<h5>Deploy a Directory or WAR by URL</h5>
+<subsection name="Deploy a Directory or WAR by URL">
<p>Deploy a web application directory or ".war" file located on the Tomcat
server. If no <code>path</code> is specified, the directory name or the war file
@@ -393,8 +405,9 @@ so the context path defaults to the name
file without the ".war" extension.</p>
<source>http://localhost:8080/manager/text/deploy?war=jar:file:/path/to/bar.war!/</source>
+</subsection>
-<h5>Deploy a Directory or War from the Host appBase</h5>
+<subsection name="Deploy a Directory or War from the Host appBase">
<p>Deploy a web application directory or ".war" file located in your Host
appBase directory. The directory name or the war file name without the ".war"
@@ -412,8 +425,9 @@ Host appBase directory on the Tomcat ser
application context named <code>/bar</code>.</p>
<source>http://localhost:8080/manager/text/deploy?war=bar.war</source>
+</subsection>
-<h5>Deploy using a Context configuration ".xml" file</h5>
+<subsection name="Deploy using a Context configuration ".xml" file">
<p>If the Host deployXML flag is set to true you can deploy a web
application using a Context configuration ".xml" file and an optional
@@ -444,8 +458,9 @@ on the server.</p>
<source>http://localhost:8080/manager/text/deploy
?config=file:/path/context.xml&war=jar:file:/path/bar.war!/</source>
+</subsection>
-<h5>Deployment Notes</h5>
+<subsection name="Deployment Notes">
<p>If the Host is configured with unpackWARs=true and you deploy a war
file, the war will be unpacked into a directory in your Host appBase
@@ -462,8 +477,9 @@ from deploying web applications using a
also prevents them from deploying application directories or ".war"
files located outside of their Host appBase.</p>
+</subsection>
-<h5>Deploy Response</h5>
+<subsection name="Deploy Response">
<p>If installation and startup is successful, you will receive a response
like this:</p>
@@ -520,6 +536,7 @@ error message. Possible causes for prob
</ul>
</subsection>
+</subsection>
<subsection name="List Currently Deployed Applications">
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org