Author: kkolinko Date: Thu Mar 14 23:48:06 2013 New Revision: 1456725 URL: http://svn.apache.org/r1456725 Log: Merged revisions r1456706 r1456713 r1456716 r1456721 from tomcat/trunk: Correct Deployer and Manager pages of Tomcat documentation: Wrap long lines. Better introduction of the Manager web application. Added mention of Tomcat Maven Plugin project. Context descriptors are not created for deployed apps in Tomcat 7. Add RemoteAddrValve to Manager configuration examples.
Modified: tomcat/tc7.0.x/trunk/ (props changed) tomcat/tc7.0.x/trunk/RUNNING.txt tomcat/tc7.0.x/trunk/webapps/docs/changelog.xml tomcat/tc7.0.x/trunk/webapps/docs/deployer-howto.xml tomcat/tc7.0.x/trunk/webapps/docs/manager-howto.xml Propchange: tomcat/tc7.0.x/trunk/ ------------------------------------------------------------------------------ Merged /tomcat/trunk:r1456706,1456713,1456716,1456721 Modified: tomcat/tc7.0.x/trunk/RUNNING.txt URL: http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/RUNNING.txt?rev=1456725&r1=1456724&r2=1456725&view=diff ============================================================================== --- tomcat/tc7.0.x/trunk/RUNNING.txt (original) +++ tomcat/tc7.0.x/trunk/RUNNING.txt Thu Mar 14 23:48:06 2013 @@ -314,6 +314,8 @@ The file will look like the following: <?xml version="1.0" encoding="UTF-8"?> <Context docBase="${catalina.home}/webapps/manager" antiResourceLocking="false" privileged="true" > + <Valve className="org.apache.catalina.valves.RemoteAddrValve" + allow="127\.0\.0\.1" /> </Context> See Deployer chapter in User Guide and Context and Host chapters in the Modified: tomcat/tc7.0.x/trunk/webapps/docs/changelog.xml URL: http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/webapps/docs/changelog.xml?rev=1456725&r1=1456724&r2=1456725&view=diff ============================================================================== --- tomcat/tc7.0.x/trunk/webapps/docs/changelog.xml (original) +++ tomcat/tc7.0.x/trunk/webapps/docs/changelog.xml Thu Mar 14 23:48:06 2013 @@ -104,6 +104,13 @@ </fix> </changelog> </subsection> + <subsection name="Web applications"> + <changelog> + <update> + Correct Deployer and Manager pages of Tomcat documentation. (kkolinko) + </update> + </changelog> + </subsection> </section> <section name="Tomcat 7.0.38 (markt)" rtext="not released"> <subsection name="Catalina"> Modified: tomcat/tc7.0.x/trunk/webapps/docs/deployer-howto.xml URL: http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/webapps/docs/deployer-howto.xml?rev=1456725&r1=1456724&r2=1456725&view=diff ============================================================================== --- tomcat/tc7.0.x/trunk/webapps/docs/deployer-howto.xml (original) +++ tomcat/tc7.0.x/trunk/webapps/docs/deployer-howto.xml Thu Mar 14 23:48:06 2013 @@ -45,17 +45,29 @@ <ul> <li>Statically; the web application is setup before Tomcat is started</li> <li> - Dynamically; in conjunction with the Tomcat Manager web application or - manipulating already deployed web applications + Dynamically; by directly manipulating already deployed web + applications (relying on <em>auto-deployment</em> + feature) or remotely by using the Tomcat Manager web + application </li> </ul> <p> - The Tomcat Manager is a tool that allows URL-based web application - deployment features. There is also a tool called the Client Deployer, - which is a command shell based script that interacts with the Tomcat - Manager but provides additional functionality such as compiling and - validating web applications as well as packaging web application into - web application resource (WAR) files. + The <a href="manager-howto.html">Tomcat Manager</a> is a web + application that can be used interactively (via HTML GUI) or + programmatically (via URL-based API) to deploy and manage web + applications. + </p> + <p> + There are a number of ways to perform deployment that rely on + the Manager web application. Apache Tomcat provides tasks + for Apache Ant build tool. + <a href="http://tomcat.apache.org/maven-plugin.html">Apache Tomcat Maven Plugin</a> + project provides integration with Apache Maven. + There is also a tool called the Client Deployer, which can be + used from a command line and provides additional functionality + such as compiling and validating web applications as well as + packaging web application into web application resource (WAR) + files. </p> </section> @@ -65,7 +77,8 @@ applications as this is provided out of the box by Tomcat. Nor is any installation required for deployment functions with the Tomcat Manager, although some configuration is required as detailed in the - Tomcat Manager manual. An installation is however required if you wish + <a href="manager-howto.html">Tomcat Manager manual</a>. + An installation is however required if you wish to use the Tomcat Client Deployer (TCD). </p> <p> @@ -88,7 +101,7 @@ The TCD package need not be extracted into any existing Tomcat installation, it can be extracted to any location. </li> - <li>Read Using the <a href="#Deploying using the Client Deployer Package"> + <li>Read Using the <a href="#Deploying_using_the_Client_Deployer_Package"> Tomcat Client Deployer</a></li> </ol> </section> @@ -158,10 +171,6 @@ </li> <li>.WAR files will be deployed</li> </ol> - <p> - Note again that for each deployed web application, a - Context Descriptor will be created <i>unless one exists already</i>. - </p> </section> <section name="Deploying on a running Tomcat server"> @@ -276,8 +285,8 @@ <code>compile</code> (default): Compile and validate the web application. This can be used standalone, and does not need a running Tomcat server. The compiled application will only run on the associated - Tomcat 7.0.x server release, and is not guaranteed to work on another - Tomcat release, as the code generated by Jasper depends on its runtime + <em>Tomcat X.Y.Z</em> server release, and is not guaranteed to work + on another Tomcat release, as the code generated by Jasper depends on its runtime component. It should also be noted that this target will also compile automatically any Java source file located in the <code>/WEB-INF/classes</code> folder of the web application.</li> Modified: tomcat/tc7.0.x/trunk/webapps/docs/manager-howto.xml URL: http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/webapps/docs/manager-howto.xml?rev=1456725&r1=1456724&r2=1456725&view=diff ============================================================================== --- tomcat/tc7.0.x/trunk/webapps/docs/manager-howto.xml (original) +++ tomcat/tc7.0.x/trunk/webapps/docs/manager-howto.xml Thu Mar 14 23:48:06 2013 @@ -71,8 +71,10 @@ Manager web application <code>Context</c <code>$CATALINA_BASE/conf/[enginename]/[hostname]</code> folder. Here is an example:</p> <pre> -<Context privileged="true" - docBase="/usr/local/kinetic/tomcat7/server/webapps/manager"> +<Context privileged="true" antiResourceLocking="false" + docBase="${catalina.home}/webapps/manager"> + <Valve className="org.apache.catalina.valves.RemoteAddrValve" + allow="127\.0\.0\.1" /> </Context> </pre> @@ -442,7 +444,8 @@ http://localhost:8080/manager/text/deplo configuration ".xml" file and a web application ".war" file located on the server.</p> <source> -http://localhost:8080/manager/text/deploy?config=file:/path/context.xml&war=jar:file:/path/bar.war!/ +http://localhost:8080/manager/text/deploy + ?config=file:/path/context.xml&war=jar:file:/path/bar.war!/ </source> @@ -1272,9 +1275,9 @@ http://webserver/manager/jmxproxy/?qry=S fetch the value of a specific MBean's attribute. The general form of the <code>get</code> command is: - <source> - http://webserver/manager/jmxproxy/?get=BEANNAME&att=MYATTRIBUTE&key=MYKEY - </source> +<source> +http://webserver/manager/jmxproxy/?get=BEANNAME&att=MYATTRIBUTE&key=MYKEY +</source> You must provide the following parameters: <ol> @@ -1287,15 +1290,16 @@ http://webserver/manager/jmxproxy/?qry=S be shown. For example, let's say we wish to fetch the current heap memory data: - <source> - http://webserver/manager/jmxproxy/?get=java.lang:type=Memory&att=HeapMemoryUsage - </source> +<source> +http://webserver/manager/jmxproxy/?get=java.lang:type=Memory&att=HeapMemoryUsage +</source> Or, if you only want the "used" key: - <source> - http://webserver/manager/jmxproxy/?get=java.lang:type=Memory&att=HeapMemoryUsage&key=used - </source> +<source> +http://webserver/manager/jmxproxy/ + ?get=java.lang:type=Memory&att=HeapMemoryUsage&key=used +</source> </subsection> <subsection name="JMX Set command"> @@ -1315,7 +1319,8 @@ http://webserver/manager/jmxproxy/?set=B <code>ErrorReportValve</code>. The following will set debugging to 10. <source> http://localhost:8080/manager/jmxproxy/ -?set=Catalina%3Atype%3DValve%2Cname%3DErrorReportValve%2Chost%3Dlocalhost&att=debug&val=10 + ?set=Catalina%3Atype%3DValve%2Cname%3DErrorReportValve%2Chost%3Dlocalhost + &att=debug&val=10 </source> and my result is (YMMV): <source> @@ -1323,14 +1328,15 @@ Result: ok </source> Here is what I see if I pass in a bad value. Here is the URL I used, - I try set debugging equal to 'cowbell': + I try set debugging equal to 'cow': <source> http://localhost:8080/manager/jmxproxy/ -?set=Catalina%3Atype%3DValve%2Cname%3DErrorReportValve%2Chost%3Dlocalhost&att=debug&val=cowbell + ?set=Catalina%3Atype%3DValve%2Cname%3DErrorReportValve%2Chost%3Dlocalhost + &att=debug&val=cow </source> When I try that, my result is <source> -Error: java.lang.NumberFormatException: For input string: "cowbell" +Error: java.lang.NumberFormatException: For input string: "cow" </source> </subsection> @@ -1338,12 +1344,14 @@ Error: java.lang.NumberFormatException: <p>The <code>invoke</code> command enables methods to be called on MBeans. The general form of the command is:</p> <source> -http://webserver/manager/jmxproxy/?invoke=BEANNAME&op=METHODNAME&ps=COMMASEPARATEDPARAMETERS +http://webserver/manager/jmxproxy/ + ?invoke=BEANNAME&op=METHODNAME&ps=COMMASEPARATEDPARAMETERS </source> <p>For example, to call the <code>findConnectors()</code> method of the <strong>Service</strong> use:</p> <source> -http://localhost:8080/manager/jmxproxy/?invoke=Catalina%3Atype%3DService&op=findConnectors&ps= +http://localhost:8080/manager/jmxproxy/ + ?invoke=Catalina%3Atype%3DService&op=findConnectors&ps= </source> </subsection> --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org For additional commands, e-mail: dev-h...@tomcat.apache.org