craigmcc 01/08/27 13:22:37 Modified: . RUNNING.txt webapps/tomcat-docs manager-howto.xml ssl-howto.xml webapps/tomcat-docs/appdev deployment.xml source.xml webapps/tomcat-docs/config context.xml host.xml loader.xml logger.xml realm.xml valve.xml Log: Update "tomcat-docs" documents to reflect the option for CATALINA_BASE instead of CATALINA_HOME. Revision Changes Path 1.2 +27 -2 jakarta-tomcat-4.0/RUNNING.txt Index: RUNNING.txt =================================================================== RCS file: /home/cvs/jakarta-tomcat-4.0/RUNNING.txt,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- RUNNING.txt 2001/07/27 22:26:03 1.1 +++ RUNNING.txt 2001/08/27 20:22:37 1.2 @@ -1,4 +1,4 @@ -$Id: RUNNING.txt,v 1.1 2001/07/27 22:26:03 craigmcc Exp $ +$Id: RUNNING.txt,v 1.2 2001/08/27 20:22:37 craigmcc Exp $ Running The Tomcat 4.0 Servlet/JSP Container @@ -101,7 +101,32 @@ ./shutdown.sh (Unix) -(4) Troubleshooting: +(4) Advanced Configuration - Multiple Tomcat 4 Instances + +In many circumstances, it is desireable to have a single copy of a Tomcat 4 +binary distribution shared among multiple users on the same server. To make +this possible, you must configure a CATALINA_BASE environment variable (in +addition to CATALINA_HOME as described above) that points to a directory +that is unique to your instance. + +When you do this, Tomcat 4 will calculate all relative references for files in +the following directories based on the value for CATALINA_BASE instead of +CATALINA_HOME: + +* conf - Server configuration files (including server.xml) + +* logs - Log and output files + +* webapps - Automatically loaded web applications + +* work - Temporary working directories for web applications + +If you do not set CATALINA_BASE to an explicit value, it will be initialized +to the same value as is set for CATALINA_HOME (which means that the same +directory is used for all relative path resoluations). + + +(5) Troubleshooting: There are only really 3 things that can go wrong during the stand-alone Tomcat 4.0 install: 1.2 +10 -0 jakarta-tomcat-4.0/webapps/tomcat-docs/manager-howto.xml Index: manager-howto.xml =================================================================== RCS file: /home/cvs/jakarta-tomcat-4.0/webapps/tomcat-docs/manager-howto.xml,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- manager-howto.xml 2001/08/16 23:21:25 1.1 +++ manager-howto.xml 2001/08/27 20:22:37 1.2 @@ -59,6 +59,16 @@ <section name="Configuring Manager Application Access"> + <blockquote><em> + <p>The description below uses the variable name $CATALINA_HOME + to refer to the directory into which you have installed Tomcat 4, + and is the base directory against which most relative paths are + resolved. However, if you have configured Tomcat 4 for multiple + instances by setting a CATALINA_BASE directory, you should use + $CATALINA_BASE instead of $CATALINA_HOME for each of these + references.</p> + </em></blockquote> + <p>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. Therefore, the Manager application is shipped with the requirement that anyone 1.3 +10 -0 jakarta-tomcat-4.0/webapps/tomcat-docs/ssl-howto.xml Index: ssl-howto.xml =================================================================== RCS file: /home/cvs/jakarta-tomcat-4.0/webapps/tomcat-docs/ssl-howto.xml,v retrieving revision 1.2 retrieving revision 1.3 diff -u -r1.2 -r1.3 --- ssl-howto.xml 2001/08/21 20:22:52 1.2 +++ ssl-howto.xml 2001/08/27 20:22:37 1.3 @@ -16,6 +16,16 @@ <section name="Quick-Start Version"> + <blockquote><em> + <p>The description below uses the variable name $CATALINA_HOME + to refer to the directory into which you have installed Tomcat 4, + and is the base directory against which most relative paths are + resolved. However, if you have configured Tomcat 4 for multiple + instances by setting a CATALINA_BASE directory, you should use + $CATALINA_BASE instead of $CATALINA_HOME for each of these + references.</p> + </em></blockquote> + <p>To install and configure SSL support on Tomcat 4, you need to follow these simple steps. For more information, read the rest of this HOW-TO.</p> <ol> 1.3 +10 -0 jakarta-tomcat-4.0/webapps/tomcat-docs/appdev/deployment.xml Index: deployment.xml =================================================================== RCS file: /home/cvs/jakarta-tomcat-4.0/webapps/tomcat-docs/appdev/deployment.xml,v retrieving revision 1.2 retrieving revision 1.3 diff -u -r1.2 -r1.3 --- deployment.xml 2001/08/05 03:42:28 1.2 +++ deployment.xml 2001/08/27 20:22:37 1.3 @@ -102,6 +102,16 @@ <section name="Web Application Deployment Descriptor"> + <blockquote><em> + <p>The description below uses the variable name $CATALINA_HOME + to refer to the directory into which you have installed Tomcat 4, + and is the base directory against which most relative paths are + resolved. However, if you have configured Tomcat 4 for multiple + instances by setting a CATALINA_BASE directory, you should use + $CATALINA_BASE instead of $CATALINA_HOME for each of these + references.</p> + </em></blockquote> + <p>As mentioned above, the <code>/WEB-INF/web.xml</code> file contains the Web Application Deployment Descriptor for your application. As the filename extension implies, this file is an XML document, and defines everything about 1.3 +10 -0 jakarta-tomcat-4.0/webapps/tomcat-docs/appdev/source.xml Index: source.xml =================================================================== RCS file: /home/cvs/jakarta-tomcat-4.0/webapps/tomcat-docs/appdev/source.xml,v retrieving revision 1.2 retrieving revision 1.3 diff -u -r1.2 -r1.3 --- source.xml 2001/08/05 03:42:28 1.2 +++ source.xml 2001/08/27 20:22:37 1.3 @@ -16,6 +16,16 @@ <section name="Directory Structure"> + <blockquote><em> + <p>The description below uses the variable name $CATALINA_HOME + to refer to the directory into which you have installed Tomcat 4, + and is the base directory against which most relative paths are + resolved. However, if you have configured Tomcat 4 for multiple + instances by setting a CATALINA_BASE directory, you should use + $CATALINA_BASE instead of $CATALINA_HOME for each of these + references.</p> + </em></blockquote> + <p>A key recommendation of this manual is to separate the directory hierarchy containing your source code (described in this section) from the directory hierarchy containing your deployable application 1.3 +10 -0 jakarta-tomcat-4.0/webapps/tomcat-docs/config/context.xml Index: context.xml =================================================================== RCS file: /home/cvs/jakarta-tomcat-4.0/webapps/tomcat-docs/config/context.xml,v retrieving revision 1.2 retrieving revision 1.3 diff -u -r1.2 -r1.3 --- context.xml 2001/08/25 20:06:30 1.2 +++ context.xml 2001/08/27 20:22:37 1.3 @@ -52,6 +52,16 @@ <a href="host.html#User Web Applications">User Web Applications</a> for more information.</p> + <blockquote><em> + <p>The description below uses the variable name $CATALINA_HOME + to refer to the directory into which you have installed Tomcat 4, + and is the base directory against which most relative paths are + resolved. However, if you have configured Tomcat 4 for multiple + instances by setting a CATALINA_BASE directory, you should use + $CATALINA_BASE instead of $CATALINA_HOME for each of these + references.</p> + </em></blockquote> + </section> 1.2 +10 -0 jakarta-tomcat-4.0/webapps/tomcat-docs/config/host.xml Index: host.xml =================================================================== RCS file: /home/cvs/jakarta-tomcat-4.0/webapps/tomcat-docs/config/host.xml,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- host.xml 2001/08/25 03:37:39 1.1 +++ host.xml 2001/08/27 20:22:37 1.2 @@ -37,6 +37,16 @@ associated with each Engine MUST have a name matching the <code>defaultHost</code> attribute of that Engine.</p> + <blockquote><em> + <p>The description below uses the variable name $CATALINA_HOME + to refer to the directory into which you have installed Tomcat 4, + and is the base directory against which most relative paths are + resolved. However, if you have configured Tomcat 4 for multiple + instances by setting a CATALINA_BASE directory, you should use + $CATALINA_BASE instead of $CATALINA_HOME for each of these + references.</p> + </em></blockquote> + </section> 1.2 +10 -0 jakarta-tomcat-4.0/webapps/tomcat-docs/config/loader.xml Index: loader.xml =================================================================== RCS file: /home/cvs/jakarta-tomcat-4.0/webapps/tomcat-docs/config/loader.xml,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- loader.xml 2001/08/25 20:06:30 1.1 +++ loader.xml 2001/08/27 20:22:37 1.2 @@ -37,6 +37,16 @@ <p>For a more in-depth description of the class loader hierarchy that is implemented by Catalina, see <strong>FIXME - Reference</strong>.</p> + <blockquote><em> + <p>The description below uses the variable name $CATALINA_HOME + to refer to the directory into which you have installed Tomcat 4, + and is the base directory against which most relative paths are + resolved. However, if you have configured Tomcat 4 for multiple + instances by setting a CATALINA_BASE directory, you should use + $CATALINA_BASE instead of $CATALINA_HOME for each of these + references.</p> + </em></blockquote> + </section> 1.2 +10 -0 jakarta-tomcat-4.0/webapps/tomcat-docs/config/logger.xml Index: logger.xml =================================================================== RCS file: /home/cvs/jakarta-tomcat-4.0/webapps/tomcat-docs/config/logger.xml,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- logger.xml 2001/08/25 20:06:30 1.1 +++ logger.xml 2001/08/27 20:22:37 1.2 @@ -26,6 +26,16 @@ <p>For a more in-depth description of the class loader hierarchy that is implemented by Catalina, see <strong>FIXME - Reference</strong>.</p> + <blockquote><em> + <p>The description below uses the variable name $CATALINA_HOME + to refer to the directory into which you have installed Tomcat 4, + and is the base directory against which most relative paths are + resolved. However, if you have configured Tomcat 4 for multiple + instances by setting a CATALINA_BASE directory, you should use + $CATALINA_BASE instead of $CATALINA_HOME for each of these + references.</p> + </em></blockquote> + </section> 1.2 +10 -0 jakarta-tomcat-4.0/webapps/tomcat-docs/config/realm.xml Index: realm.xml =================================================================== RCS file: /home/cvs/jakarta-tomcat-4.0/webapps/tomcat-docs/config/realm.xml,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- realm.xml 2001/08/25 20:06:30 1.1 +++ realm.xml 2001/08/27 20:22:37 1.2 @@ -37,6 +37,16 @@ implementations, see <strong>FIXME - link to "Realm Configuration HOW-TO" in the administrator's section</strong>.</p> + <blockquote><em> + <p>The description below uses the variable name $CATALINA_HOME + to refer to the directory into which you have installed Tomcat 4, + and is the base directory against which most relative paths are + resolved. However, if you have configured Tomcat 4 for multiple + instances by setting a CATALINA_BASE directory, you should use + $CATALINA_BASE instead of $CATALINA_HOME for each of these + references.</p> + </em></blockquote> + </section> 1.2 +10 -0 jakarta-tomcat-4.0/webapps/tomcat-docs/config/valve.xml Index: valve.xml =================================================================== RCS file: /home/cvs/jakarta-tomcat-4.0/webapps/tomcat-docs/config/valve.xml,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- valve.xml 2001/08/25 20:06:30 1.1 +++ valve.xml 2001/08/27 20:22:37 1.2 @@ -23,6 +23,16 @@ Individual Valves have distinct processing capabilities, and are described individually below.</p> + <blockquote><em> + <p>The description below uses the variable name $CATALINA_HOME + to refer to the directory into which you have installed Tomcat 4, + and is the base directory against which most relative paths are + resolved. However, if you have configured Tomcat 4 for multiple + instances by setting a CATALINA_BASE directory, you should use + $CATALINA_BASE instead of $CATALINA_HOME for each of these + references.</p> + </em></blockquote> + </section>