From: markt Date: Thu, 21 Feb 2008 21:51:52 +0000 (+0000) Subject: Doc improvements: X-Git-Url: https://git.internetallee.de/?a=commitdiff_plain;h=66bbcff8b2a9645e0afc41a64c49a126ed2af9d1;p=tomcat7.0 Doc improvements: Tomcat 5 -> Tomcat 6 $CATALINA_HOME -> $CATALINA_BASE /server/lib -> /lib /common/lib -> /lib git-svn-id: https://svn.apache.org/repos/asf/tomcat/trunk@630013 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/webapps/docs/appdev/deployment.xml b/webapps/docs/appdev/deployment.xml index 11392bd35..0cfa31c81 100644 --- a/webapps/docs/appdev/deployment.xml +++ b/webapps/docs/appdev/deployment.xml @@ -118,30 +118,22 @@ API Specification, version 2.3, which you should consult for more details.

-

Like most servlet containers, Tomcat 5 also supports mechanisms to install +

Like most servlet containers, Tomcat 6 also supports mechanisms to install library JAR files (or unpacked classes) once, and make them visible to all installed web applications (without having to be included inside the web application itself. The details of how Tomcat locates and shares such classes are described in the Class Loader HOW-TO documentation. -For the purposes of our discussion, there are two locations that are commonly -used within a Tomcat 5 installation for shared code:

- +The location commonly used within a Tomcat 6 installation for shared code is +$CATALINA_HOME/lib. JAR files placed here are visible both to +web applications and internal Tomcat code. This is a good place to put JDBC +drivers that are required for both your application or internal Tomcat use +(such as for a JDBCRealm).

-

Out of the box, a standard Tomcat 5 installation includes a variety +

Out of the box, a standard Tomcat 6 installation includes a variety of pre-installed shared library files, including:

diff --git a/webapps/docs/config/realm.xml b/webapps/docs/config/realm.xml index a9461e2bf..e462093df 100644 --- a/webapps/docs/config/realm.xml +++ b/webapps/docs/config/realm.xml @@ -53,13 +53,11 @@

-

The description below uses the variable name $CATALINA_HOME - to refer to the directory into which you have installed Tomcat 6, - and is the base directory against which most relative paths are - resolved. However, if you have configured Tomcat 6 for multiple - instances by setting a CATALINA_BASE directory, you should use - $CATALINA_BASE instead of $CATALINA_HOME for each of these - references.

+

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 6 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 6.

@@ -454,7 +452,7 @@ -

Absolute or relative (to $CATALINA_HOME) pathname to the XML file +

Absolute or relative (to $CATALINA_BASE) pathname to the XML file containing our user information. See below for details on the XML element format required. If no pathname is specified, the default value is conf/tomcat-users.xml.

diff --git a/webapps/docs/config/valve.xml b/webapps/docs/config/valve.xml index f9f92f254..49d0c4eeb 100644 --- a/webapps/docs/config/valve.xml +++ b/webapps/docs/config/valve.xml @@ -40,13 +40,11 @@ described individually below.

-

The description below uses the variable name $CATALINA_HOME - to refer to the directory into which you have installed Tomcat 6, - and is the base directory against which most relative paths are - resolved. However, if you have configured Tomcat 6 for multiple - instances by setting a CATALINA_BASE directory, you should use - $CATALINA_BASE instead of $CATALINA_HOME for each of these - references.

+

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 6 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 6.

@@ -83,9 +81,9 @@

Absolute or relative pathname of a directory in which log files created by this valve will be placed. If a relative path is - specified, it is interpreted as relative to $CATALINA_HOME. If + specified, it is interpreted as relative to $CATALINA_BASE. If no directory attribute is specified, the default value is "logs" - (relative to $CATALINA_HOME).

+ (relative to $CATALINA_BASE).

 diff --git a/webapps/docs/default-servlet.xml b/webapps/docs/default-servlet.xml index 3696f2668..75e8f93e7 100644 --- a/webapps/docs/default-servlet.xml +++ b/webapps/docs/default-servlet.xml @@ -52,7 +52,7 @@ as serves the directory listings (if directory listings are enabled).
-It is declared globally in $CATALINA_HOME/conf/web.xml. +It is declared globally in $CATALINA_BASE/conf/web.xml. By default here is it's declaration: <servlet> diff --git a/webapps/docs/deployer-howto.xml b/webapps/docs/deployer-howto.xml index 75cbe8529..61dddfc9d 100644 --- a/webapps/docs/deployer-howto.xml +++ b/webapps/docs/deployer-howto.xml @@ -127,8 +127,8 @@

The locations for Context Descriptors are;

    -
  1. $CATALINA_HOME/conf/[enginename]/[hostname]/context.xml
    2. -
  2. $CATALINA_HOME/webapps/[webappname]/META-INF/context.xml
    3. +
  3. $CATALINA_BASE/conf/[enginename]/[hostname]/context.xml
    4. +
  4. $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, @@ -149,7 +149,7 @@

The web applications present in the location specified by the Host's (default Host is "localhost") appBase attribute (default - appBase is "$CATALINA_HOME/webapps") will be deployed on Tomcat startup + appBase is "$CATALINA_BASE/webapps") will be deployed on Tomcat startup only if the Host's deployOnStartup attribute is "true".

@@ -215,7 +215,7 @@ Re-deployment of a web application if a Context Descriptor file (with a filename corresponding to the Context path of the previously deployed web application) is added to the - $CATALINA_HOME/conf/[enginename]/[hostname]/ + $CATALINA_BASE/conf/[enginename]/[hostname]/ directory.

  • @@ -279,7 +279,7 @@ compile (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 5.5.x server release, and is not guaranteed to work on another + Tomcat 6.0.x 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 diff --git a/webapps/docs/funcspecs/fs-admin-apps.xml b/webapps/docs/funcspecs/fs-admin-apps.xml index 65e16f74b..d8aeea574 100644 --- a/webapps/docs/funcspecs/fs-admin-apps.xml +++ b/webapps/docs/funcspecs/fs-admin-apps.xml @@ -38,7 +38,7 @@

    The purpose of this specification is to define high level requirements for administrative applications that can be used to manage the operation - of a running Tomcat 5 container. A variety of Access Methods + of a running Tomcat 6 container. A variety of Access Methods to the supported administrative functionality shall be supported, to meet varying requirements:

      @@ -102,7 +102,7 @@
      • To the maximum extent feasible, all administrative functions, and the access methods that support them, shall run portably - on all platforms where Tomcat 5 itself runs.
        • + on all platforms where Tomcat 6 itself runs.
      • In a default Tomcat distribution, all administrative capabilities shall be disabled. It shall be necessary for a system administrator to specifically enable the desired access methods @@ -176,9 +176,9 @@
      • Java 2 Standard Edition (Version 1.2 or later)
      • Servlet 2.4 - (supported natively by Tomcat 5)
        • + (supported natively by Tomcat 6)
      • JavaServer Pages 2.0 - (supported natively by Tomcat 5)
        • + (supported natively by Tomcat 6)
      • JavaServer Pages Standard Tag Library 1.0 (Jakarta Taglibs-Standard 1.0.3)
      • Struts Framework (Version 1.0) - MVC Framework for Web Applications
        • diff --git a/webapps/docs/funcspecs/fs-admin-objects.xml b/webapps/docs/funcspecs/fs-admin-objects.xml index 1bad2435f..42e86e831 100644 --- a/webapps/docs/funcspecs/fs-admin-objects.xml +++ b/webapps/docs/funcspecs/fs-admin-objects.xml @@ -75,7 +75,7 @@ Operations that can be performed when the administrative application is following configurable properties:

        • debug - Debugging detail level. [0]
          • -
        • directory - Absolute or relative (to $CATALINA_HOME) path +
        • directory - Absolute or relative (to $CATALINA_BASE) path of the directory into which access log files are created. [logs].
        • pattern - Pattern string defining the fields to be @@ -168,7 +168,7 @@ Operations that can be performed when the administrative application is requirements of the Java2 Enterprise Edition specification? [true]
        • workDir - Absolute pathname of a scratch directory that is provided to this web application. [Automatically assigned relative to - $CATALINA_HOME/work]
          • + $CATALINA_BASE/work]

        Each Context is owned by a parent Host, and is @@ -235,7 +235,7 @@ Operations that can be performed when the administrative application is

        Default web application characteristics are configured in a special - deployment descriptor named $CATALINA_HOME/conf/web.xml. This + deployment descriptor named $CATALINA_BASE/conf/web.xml. This section describes the configurable components that may be stored there.

        FIXME - Complete the description of default servlets, @@ -315,7 +315,7 @@ Operations that can be performed when the administrative application is with this host (for example, a particular host might be named www.mycompany.com with an alias company.com). -

      • appBase - Absolute or relative (to $CATALINA_HOME) path +
      • appBase - Absolute or relative (to $CATALINA_BASE) path to a directory from which web applications will be automatically deployed.
      • debug - Debugging detail level. [0]
        • @@ -423,7 +423,7 @@ Operations that can be performed when the administrative application is following configurable properties:

        • debug - Debugging detail level. [0]
          • -
        • pathname - Absolute or relative (to $CATALINA_HOME) path to +
        • pathname - Absolute or relative (to $CATALINA_BASE) path to the XML file containing our user information. [conf/tomcat-users.xml]
        diff --git a/webapps/docs/funcspecs/fs-admin-opers.xml b/webapps/docs/funcspecs/fs-admin-opers.xml index 5093b000f..f8ffd83e3 100644 --- a/webapps/docs/funcspecs/fs-admin-opers.xml +++ b/webapps/docs/funcspecs/fs-admin-opers.xml @@ -35,7 +35,7 @@

        This document defines the Supported Operations that may be performed against the Administered -Objects that are supported by Tomcat 5 administrative applications. +Objects that are supported by Tomcat 6 administrative applications. Not all operations are required to be available through every administrative application that is implemented. However, if a given operation is available, it should operate consistently with the descriptions found here.

        diff --git a/webapps/docs/funcspecs/fs-default.xml b/webapps/docs/funcspecs/fs-default.xml index 4123790d2..bb5e20a96 100644 --- a/webapps/docs/funcspecs/fs-default.xml +++ b/webapps/docs/funcspecs/fs-default.xml @@ -90,7 +90,7 @@
        • The default servlet must be registered in the application deployment descriptor (or the default deployment descriptor in file - $CATALINA_HOME/conf/web.xml) using a "default servlet" + $CATALINA_BASE/conf/web.xml) using a "default servlet" servlet mapping, signified by URL pattern "/".
        diff --git a/webapps/docs/funcspecs/fs-invoker.xml b/webapps/docs/funcspecs/fs-invoker.xml index 78ee57670..34bf02edc 100644 --- a/webapps/docs/funcspecs/fs-invoker.xml +++ b/webapps/docs/funcspecs/fs-invoker.xml @@ -89,7 +89,7 @@
        • The invoker servlet must be registered in the application deployment descriptor (or the default deployment descriptor in file - $CATALINA_HOME/conf/web.xml) using a "path mapped" + $CATALINA_BASE/conf/web.xml) using a "path mapped" servlet mapping. The historical default mapping is to URL pattern "/servlet/*", although the invoker servlet must operate correctly with an arbitrary mapping.
          • diff --git a/webapps/docs/funcspecs/fs-jdbc-realm.xml b/webapps/docs/funcspecs/fs-jdbc-realm.xml index b432c6b35..18a4aa8ec 100644 --- a/webapps/docs/funcspecs/fs-jdbc-realm.xml +++ b/webapps/docs/funcspecs/fs-jdbc-realm.xml @@ -37,7 +37,7 @@

          The purpose of the JDBCRealm implementation is to - provide a mechanism by which Tomcat 5 can acquire information needed + provide a mechanism by which Tomcat 6 can acquire information needed to authenticate web application users, and define their security roles, from a relational database accessed via JDBC APIs. For integration with Catalina, the resulting class(es) must implement the @@ -104,7 +104,7 @@ JDBCRealm to operate correctly:

          • The desire to utilize JDBCRealm must be registered in - $CATALINA_HOME/conf/server.xml, in a + $CATALINA_BASE/conf/server.xml, in a <Realm> element that is nested inside a corresponding <Engine>, <Host>, or <Context> element.
            • diff --git a/webapps/docs/funcspecs/fs-jndi-realm.xml b/webapps/docs/funcspecs/fs-jndi-realm.xml index d39376b95..2c9d86a26 100644 --- a/webapps/docs/funcspecs/fs-jndi-realm.xml +++ b/webapps/docs/funcspecs/fs-jndi-realm.xml @@ -37,7 +37,7 @@

            The purpose of the JNDIRealm implementation is to - provide a mechanism by which Tomcat 5 can acquire information needed + provide a mechanism by which Tomcat 6 can acquire information needed to authenticate web application users, and define their security roles, from a directory server or other service accessed via JNDI APIs. For integration with Catalina, this class must implement the @@ -111,7 +111,7 @@ JNDIRealm to operate correctly:

            • The desire to utilize JNDIRealm must be registered in - $CATALINA_HOME/conf/server.xml, in a + $CATALINA_BASE/conf/server.xml, in a <Realm> element that is nested inside a corresponding <Engine>, <Host>, or <Context> element.
              • diff --git a/webapps/docs/funcspecs/fs-memory-realm.xml b/webapps/docs/funcspecs/fs-memory-realm.xml index 25a9ace18..6d3e3a27e 100644 --- a/webapps/docs/funcspecs/fs-memory-realm.xml +++ b/webapps/docs/funcspecs/fs-memory-realm.xml @@ -37,10 +37,10 @@

              The purpose of the MemoryRealm implementation is to - provide a mechanism by which Tomcat 5 can acquire information needed + provide a mechanism by which Tomcat 6 can acquire information needed to authenticate web application users, and define their security roles, from a simple text-based configuration file in XML format. This is - intended to simplify the initial installation and operation of Tomcat 5, + intended to simplify the initial installation and operation of Tomcat 6, without the complexity of configuring a database or directory server based Realm. It is not intended for production use.

              @@ -102,7 +102,7 @@ MemoryRealm to operate correctly:

              • The desire to utilize MemoryRealm must be registered in - $CATALINA_HOME/conf/server.xml, in a + $CATALINA_BASE/conf/server.xml, in a <Realm> element that is nested inside a corresponding <Engine>, <Host>, or <Context> element. (This is already @@ -123,11 +123,7 @@
              • MemoryRealm must have an XML parser compatible with the JAXP/1.1 APIs available to it. This is normally accomplished by placing the corresponding JAR files in directory - $CATALINA_HOME/server/lib (to make them visible only - to internal Catalina classes) or in directory - $CATALINA_HOME/common/lib (to make them visible to - Catalina internal classes and installed web - applications).
                • + $CATALINA_HOME/lib.
              @@ -174,7 +170,7 @@
              • Configurable debugging detail level.
              • Configurable file pathname (absolute or relative to - $CATALINA_HOME of the XML file containing our + $CATALINA_BASE of the XML file containing our defined users. [conf/tomcat-users.xml].
              diff --git a/webapps/docs/funcspecs/index.xml b/webapps/docs/funcspecs/index.xml index 4c5cde8ba..760c84a5d 100644 --- a/webapps/docs/funcspecs/index.xml +++ b/webapps/docs/funcspecs/index.xml @@ -34,7 +34,7 @@

              This documentation area includes functional specifications for many features supported by the Catalina servlet container -portion of Tomcat 5. In most cases, these features are not documented in the +portion of Tomcat 6. In most cases, these features are not documented in the underlying Servlet or JSP specifications, so a definition of the expected correct behavior is important both to implementors of those features, and to test writers trying to decide what to test.

              @@ -43,14 +43,14 @@ test writers trying to decide what to test.

              in the menu (to the left):

              • Administrative Apps - Overall requirements for supporting an - ability to configure and operate a Tomcat 5 installation through tools, + ability to configure and operate a Tomcat 6 installation through tools, as well as detailed requirements for the tools themselves.
              • Internal Servlets - Requirements for Catalina features that are implemented as internal, container-managed, servlets.
              • Realm Implementations - Requirements for the implementations of the org.apache.catalina.Realm interface (providing access to collections of users, passwords and roles) that are included in the - standard Tomcat 5 distribution.
                • + standard Tomcat 6 distribution.

              NOTE - In some cases, the contents of these functional specs has diff --git a/webapps/docs/html-manager-howto.xml b/webapps/docs/html-manager-howto.xml index 65a730e91..5acf434b3 100644 --- a/webapps/docs/html-manager-howto.xml +++ b/webapps/docs/html-manager-howto.xml @@ -133,7 +133,7 @@ error message. Possible causes for problems include:

            • Encountered exception

              An exception was encountered trying to start the web application. - Check the Tomcat 5 logs for the details.

              + Check the Tomcat 6 logs for the details.

            • Invalid context path was specified
              @@ -173,7 +173,7 @@ error message. Possible causes for problems include:
            • Encountered exception

              An exception was encountered trying to stop the web application. - Check the Tomcat 5 logs for the details.

              + Check the Tomcat 6 logs for the details.

            • Invalid context path was specified
              @@ -221,7 +221,7 @@ error message. Possible causes for problems include:
            • Encountered exception

              An exception was encountered trying to restart the web application. - Check the Tomcat 5 logs for the details.

              + Check the Tomcat 6 logs for the details.

            • Invalid context path was specified
              @@ -510,7 +510,7 @@ error message. Possible causes for problems include:

            • Encountered exception

              An exception was encountered trying to start the new web application. - Check the Tomcat 5 logs for the details, but likely explanations include + Check the Tomcat 6 logs for the details, but likely explanations include problems parsing your /WEB-INF/web.xml file, or missing classes encountered when initializing application event listeners and filters.

              diff --git a/webapps/docs/index.xml b/webapps/docs/index.xml index 693f4a5e3..8b72ca8b5 100644 --- a/webapps/docs/index.xml +++ b/webapps/docs/index.xml @@ -87,7 +87,7 @@ Apache Tomcat 6, and using many of the Apache Tomcat features.

              - Configuring a JNDI DataSoure with a DB connection pool. Examples for many popular databases.
            • Classloading - - Information about class loading in Apache Tomcat 5, including where to place + - Information about class loading in Apache Tomcat 6, including where to place your application classes so that they are visible.
            • JSPs - Information about Jasper configuration, as well as the JSP compiler @@ -101,7 +101,7 @@ Apache Tomcat 6, and using many of the Apache Tomcat features.

            • CGI - Using CGIs with Apache Tomcat.
            • Proxy Support - - Configuring Apache Tomcat 5 to run behind a proxy server (or a web server + Configuring Apache Tomcat 6 to run behind a proxy server (or a web server functioning as a proxy server).
            • MBean Descriptor - Configuring MBean descriptors files for custom components.
              • diff --git a/webapps/docs/introduction.xml b/webapps/docs/introduction.xml index 858c021cf..4779b0880 100644 --- a/webapps/docs/introduction.xml +++ b/webapps/docs/introduction.xml @@ -64,10 +64,12 @@ terms; some specific to Tomcat, and others defined by the $CATALINA_HOME. This represents the root of your Tomcat installation. When we say, "This information can be found in your $CATALINA_HOME/README.txt file" we mean to look at the README.txt file at the -root of your Tomcat install.

              +root of your Tomcat install. Optionally, Tomcat may be configured for multiple +instances by defining $CATALINA_BASE for each instance. If +multiple instances are not configured, $CATALINA_BASE is the +same as $CATALINA_HOME.

              -

              These are some of the key tomcat directories, all relative -to $CATALINA_HOME:

              +

              These are some of the key tomcat directories:

              • /bin - Startup, shutdown, and other scripts. The diff --git a/webapps/docs/jasper-howto.xml b/webapps/docs/jasper-howto.xml index 610003be4..8b075dbd5 100644 --- a/webapps/docs/jasper-howto.xml +++ b/webapps/docs/jasper-howto.xml @@ -353,7 +353,7 @@ Jikes to compile JSP pages:
                • From your Ant installation, copy ant.jar and (if it's available: Ant 1.5 and later) ant-launcher.jar to -$CATALINA_BASE/lib.
                  • +$CATALINA_HOME/lib.
                • Download and install jikes. jikes must support the -encoding option. Execute jikes -help to verify that it was built with support for -encoding.
                  • diff --git a/webapps/docs/jndi-datasource-examples-howto.xml b/webapps/docs/jndi-datasource-examples-howto.xml index 69d00cc46..9531dfb73 100644 --- a/webapps/docs/jndi-datasource-examples-howto.xml +++ b/webapps/docs/jndi-datasource-examples-howto.xml @@ -306,7 +306,7 @@ select id, foo, bar from testdata

                  -

                  Finally deploy your web app into $CATALINA_HOME/webapps either +

                  Finally deploy your web app into $CATALINA_BASE/webapps either as a warfile called DBTest.war or into a sub-directory called DBTest

                  Once deployed, point a browser at diff --git a/webapps/docs/jndi-resources-howto.xml b/webapps/docs/jndi-resources-howto.xml index 82fd71962..8919e8bba 100644 --- a/webapps/docs/jndi-resources-howto.xml +++ b/webapps/docs/jndi-resources-howto.xml @@ -48,7 +48,7 @@ configuration.

                  For Tomcat 6, these entries in per-web-application InitialContext are configured in the <Context> elements that -can be specified in either $CATALINA_HOME/conf/server.xml or, +can be specified in either $CATALINA_BASE/conf/server.xml or, preferably, the per-web-application context XML file ( META-INF/context.xml).

                  @@ -57,7 +57,7 @@ preferably, the per-web-application context XML file ( entire server. These are configured in the <GlobalNameingResources> element of -$CATALINA_HOME/conf/server.xml. You may expose these resources to +$CATALINA_BASE/conf/server.xml. You may expose these resources to web applications by using <ResourceLink> elements.

                  diff --git a/webapps/docs/logging.xml b/webapps/docs/logging.xml index d8e88652b..a3f117856 100644 --- a/webapps/docs/logging.xml +++ b/webapps/docs/logging.xml @@ -214,7 +214,7 @@

                - Example logging.properties file to be placed in $CATALINA_HOME/conf: + Example logging.properties file to be placed in $CATALINA_BASE/conf: handlers = 1catalina.org.apache.juli.FileHandler, 2localhost.org.apache.juli.FileHandler, \ 3manager.org.apache.juli.FileHandler, 4admin.org.apache.juli.FileHandler, \ diff --git a/webapps/docs/manager-howto.xml b/webapps/docs/manager-howto.xml index e7eb6064c..da9f54ef3 100644 --- a/webapps/docs/manager-howto.xml +++ b/webapps/docs/manager-howto.xml @@ -101,7 +101,7 @@ the following functions:

                A default Tomcat installation includes the manager. To add an instance of the Manager web application Context to a new host install the manager.xml context configuration file in the -$CATALINA_HOME/conf/[enginename]/[hostname] folder. Here is an +$CATALINA_BASE/conf/[enginename]/[hostname] folder. Here is an example: 

                 <Context path="/manager" debug="0" privileged="true"
@@ -135,13 +135,11 @@ With Ant for more information.
                • -

                The description below uses the variable name $CATALINA_HOME - to refer to the directory into which you have installed Tomcat 6, - and is the base directory against which most relative paths are - resolved. However, if you have configured Tomcat 6 for multiple - instances by setting a CATALINA_BASE directory, you should use - $CATALINA_BASE instead of $CATALINA_HOME for each of these - references.

                +

                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 6 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 6.

                It would be quite unsafe to ship Tomcat with default settings that allowed @@ -150,7 +148,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 associated with them. Further, there is no username in the default users file -($CATALINA_HOME/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.

                @@ -161,9 +159,9 @@ to some existing username/password combination. Exactly where this is done depends on which Realm implementation you are using:

                • MemoryRealm - If you have not customized your - $CATALINA_HOME/conf/server.xml to select a different one, + $CATALINA_BASE/conf/server.xml to select a different one, Tomcat 6 defaults to an XML-format file stored at - $CATALINA_HOME/conf/tomcat-users.xml, which can be + $CATALINA_BASE/conf/tomcat-users.xml, which can be edited with any text editor. This file contains an XML <user> for each individual user, which might look something like this: @@ -857,7 +855,7 @@ application artifacts that exist within appBase directory This will delete the the application .WAR, if present, the application directory resulting either from a deploy in unpacked form or from .WAR expansion as well as the XML Context definition from -$CATALINA_HOME/conf/[enginename]/[hostname]/ directory. +$CATALINA_BASE/conf/[enginename]/[hostname]/ directory. If you simply want to take an application out of service, you should use the /stop command instead.

                  diff --git a/webapps/docs/monitoring.xml b/webapps/docs/monitoring.xml index bd7c5c315..54b625b23 100644 --- a/webapps/docs/monitoring.xml +++ b/webapps/docs/monitoring.xml @@ -113,7 +113,7 @@ controlRole tomcat

                  For simple tomcat ant task usage with ant 1.6.x we have integrate import and antlib support.

                  -

                  antlibCopy your catalina-ant.jar from $CATALINA_HOME/server/lib to $ANT_HOME/lib.

                  +

                  antlibCopy your catalina-ant.jar from $CATALINA_HOME/lib to $ANT_HOME/lib.

                  Following example show the JMX Accessor usage:

                  diff --git a/webapps/docs/proxy-howto.xml b/webapps/docs/proxy-howto.xml
index 0c5e7db63..bfd4bbb25 100644
--- a/webapps/docs/proxy-howto.xml
+++ b/webapps/docs/proxy-howto.xml
@@ -81,16 +81,16 @@ LoadModule proxy_module  {path-to-modules}/mod_proxy.so
 AddModule  mod_proxy.c
 
 
                • Include two directives in your httpd.conf file for
-    each web application that you wish to forward to Tomcat 5.  For
+    each web application that you wish to forward to Tomcat 6.  For
     example, to forward an application at context path /myapp:
 
 ProxyPass         /myapp  http://localhost:8081/myapp
 ProxyPassReverse  /myapp  http://localhost:8081/myapp
 
     which tells Apache to forward URLs of the form
-    http://localhost/myapp/* to the Tomcat 5 connector
+    http://localhost/myapp/* to the Tomcat 6 connector
     listening on port 8081.
                  • 
-
                • Configure your copy of Tomcat 5 to include a special
+
                • Configure your copy of Tomcat 6 to include a special
     <Connector> element, with appropriate
     proxy settings, for example:
 
diff --git a/webapps/docs/realm-howto.xml b/webapps/docs/realm-howto.xml
index 52b600237..8c0104be1 100644
--- a/webapps/docs/realm-howto.xml
+++ b/webapps/docs/realm-howto.xml
@@ -129,7 +129,7 @@ sources of authentication information:
                  
 and integrate it with Tomcat 6.  To do so, you need to:
 
                    
   
                  • Implement org.apache.catalina.Realm,
                    • 
-  
                  • Place your compiled realm in $CATALINA_HOME/server/lib,
                    • 
+  
                  • Place your compiled realm in $CATALINA_HOME/lib,
                    • 
   
                  • Declare your realm as described in the "Configuring a Realm" section below,
                    • 
   
                  • Declare your realm to the MBeans Descriptor.
                    • 
 
                  
@@ -342,14 +342,14 @@ database structure conforms to the following requirements:
                  
     $CATALINA_HOME/lib directory.
     Note that only JAR files are recognized!
                  • 
 
                • Set up a <Realm> element, as described below, in your
-    $CATALINA_HOME/conf/server.xml file.
                  • 
+    $CATALINA_BASE/conf/server.xml file.
 
                • Restart Tomcat 6 if it is already running.
                  • 
 
 
 
                  Realm Element Attributes
                  
 
 
                  To configure JDBCRealm, you will create a <Realm>
-element and nest it in your $CATALINA_HOME/conf/server.xml file,
+element and nest it in your $CATALINA_BASE/conf/server.xml file,
 as described above.  The following
 attributes are supported by this implementation:
                  
 
@@ -437,7 +437,7 @@ create table user_roles (
 
 
 
                  Example Realm elements are included (commented out) in the
-default $CATALINA_HOME/conf/server.xml file.  Here's an example
+default $CATALINA_BASE/conf/server.xml file.  Here's an example
 for using a MySQL database called "authority", configured with the tables
 described above, and accessed with username "dbuser" and password "dbpass":
                  
 
@@ -520,14 +520,14 @@ as your database structure conforms to the following requirements:
                  
     JNDI DataSource Example HOW-TO
     for information on how to configure a JNDI named JDBC DataSource.
 
                • Set up a <Realm> element, as described below, in your
-    $CATALINA_HOME/conf/server.xml file.
                  • 
+    $CATALINA_BASE/conf/server.xml file.
 
                • Restart Tomcat 6 if it is already running.
                  • 
 
 
 
                  Realm Element Attributes
                  
 
 
                  To configure DataSourceRealm, you will create a <Realm>
-element and nest it in your $CATALINA_HOME/conf/server.xml file,
+element and nest it in your $CATALINA_BASE/conf/server.xml file,
 as described above.  The following
 attributes are supported by this implementation:
                  
 
@@ -829,14 +829,14 @@ the name of this attribute.
                  
     ldap.jar available with JNDI) inside the
     $CATALINA_HOME/lib directory.
 
                • Set up a <Realm> element, as described below, in your
-    $CATALINA_HOME/conf/server.xml file.
                  • 
+    $CATALINA_BASE/conf/server.xml file.
 
                • Restart Tomcat 6 if it is already running.
                  • 
 
 
 
                  Realm Element Attributes
                  
 
 
                  To configure JNDIRealm, you will create a <Realm>
-element and nest it in your $CATALINA_HOME/conf/server.xml file,
+element and nest it in your $CATALINA_BASE/conf/server.xml file,
 as described above.  The following
 attributes are supported by this implementation:
                  
 
@@ -1186,13 +1186,13 @@ authentication is usually to be preferred.
                  
 
                  MemoryRealm is a simple demonstration implementation of the
 Tomcat 6 Realm interface.  It is not designed for production use.
 At startup time, MemoryRealm loads information about all users, and their
-corresponding roles, from an XML document (by default, this document is loaded from $CATALINA_HOME/conf/tomcat-users.xml).  Changes to the data
+corresponding roles, from an XML document (by default, this document is loaded from $CATALINA_BASE/conf/tomcat-users.xml).  Changes to the data
 in this file are not recognized until Tomcat is restarted.
                  
 
 
                  Realm Element Attributes
                  
 
 
                  To configure MemoryRealm, you will create a <Realm>
-element and nest it in your $CATALINA_HOME/conf/server.xml file,
+element and nest it in your $CATALINA_BASE/conf/server.xml file,
 as described above.  The following
 attributes are supported by this implementation:
                  
 
@@ -1213,7 +1213,7 @@ attributes are supported by this implementation:
                  
   
 
   
-    
                  Absolute or relative (to $CATALINA_HOME) pathname of the XML document
+    
                  Absolute or relative (to $CATALINA_BASE) pathname of the XML document
     containing our valid usernames, passwords, and roles.  See below for more
     information on the format of this file.  If not specified, the value
     conf/tomcat-users.xml is used.
                  
@@ -1327,7 +1327,7 @@ Regardless, the first Principal returned is always treated as the user
  href="http://java.sun.com/j2se/1.4.1/docs/guide/security/jaas/tutorials/LoginConfigFile.html">JAAS
 LoginConfig file) and tell Tomcat where to find it by specifying
 its location to the JVM, for instance by setting the environment
-variable: JAVA_OPTS=-DJAVA_OPTS=-Djava.security.auth.login.config==$CATALINA_HOME/conf/jaas.config
+variable: JAVA_OPTS=-DJAVA_OPTS=-Djava.security.auth.login.config==$CATALINA_BASE/conf/jaas.config
 
           
                • Configure your security-constraints in your web.xml for
 the resources you want to protect
                  • 
@@ -1337,7 +1337,7 @@ the resources you want to protect
         
                  Realm Element Attributes
                  
         
                  To configure JAASRealm as for step 6 above, you create
 a <Realm> element and nest it in your 
-$CATALINA_HOME/conf/server.xml
+$CATALINA_BASE/conf/server.xml
 file within your <Engine> node. The following attributes 
 are supported by this implementation:
                  
 
diff --git a/webapps/docs/security-manager-howto.xml b/webapps/docs/security-manager-howto.xml
index 98a72ff83..5ae498040 100644
--- a/webapps/docs/security-manager-howto.xml
+++ b/webapps/docs/security-manager-howto.xml
@@ -53,7 +53,7 @@
   system administrator can use to keep the server secure and reliable.
                  
 
   
                  WARNING - A security audit
-  have been conducted using the Tomcat 5 codebase. Most of the critical
+  have been conducted using the Tomcat 6 codebase. Most of the critical
   package have been protected and a new security package protection mechanism 
   has been implemented. Still, make sure that you are satisfied with your SecurityManager 
   configuration before allowing untrusted users to publish web applications, 
@@ -139,7 +139,7 @@ permission java.io.FilePermission "** your application context**", "read";
   
                  Policy File Format
                  
 
   
                  The security policies implemented by the Java SecurityManager are
-  configured in the $CATALINA_HOME/conf/catalina.policy file.
+  configured in the $CATALINA_BASE/conf/catalina.policy file.
   This file completely replaces the java.policy file present
   in your JDK system directories.  The catalina.policy file
   can be edited by hand, or you can use the
@@ -161,12 +161,13 @@ grant [signedBy <signer>,] [codeBase <code source>] {
   end at the end of the current line.  The codeBase is in the
   form of a URL, and for a file URL can use the ${java.home}
   and ${catalina.home} properties (which are expanded out to
-  the directory paths defined for them by the JAVA_HOME and
-  CATALINA_HOME environment variables).
                  
+  the directory paths defined for them by the JAVA_HOME,
+  CATALINA_HOME and CATALINA_BASE environment
+  variables).
                  
 
   
                  The Default Policy File
                  
 
-  
                  The default $CATALINA_HOME/conf/catalina.policy file
+  
                  The default $CATALINA_BASE/conf/catalina.policy file
   looks like this:
                  
 
 // ============================================================================
@@ -341,7 +342,7 @@ $CATALINA_HOME/bin/catalina.sh start -security    (Unix)
 
   
                  The Default Properties File
                  
 
-  
                  The default $CATALINA_HOME/conf/catalina.properties file
+  
                  The default $CATALINA_BASE/conf/catalina.properties file
   looks like this:
                  
   
 #
diff --git a/webapps/docs/ssl-howto.xml b/webapps/docs/ssl-howto.xml
index f7097f595..2e41b4c22 100644
--- a/webapps/docs/ssl-howto.xml
+++ b/webapps/docs/ssl-howto.xml
@@ -38,13 +38,11 @@
     use OpenSSL, which uses a different configuration.
                  
 
     
                  
-    
                  The description below uses the variable name $CATALINA_HOME
-    to refer to the directory into which you have installed Tomcat 6,
-    and is the base directory against which most relative paths are
-    resolved.  However, if you have configured Tomcat 6 for multiple
-    instances by setting a CATALINA_BASE directory, you should use
-    $CATALINA_BASE instead of $CATALINA_HOME for each of these
-    references.
                  
+    
                  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 6 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 6.
                  
     
                  
 
 
                  To install and configure SSL support on Tomcat 6, you need to follow
@@ -62,7 +60,7 @@ $JAVA_HOME/bin/keytool -genkey -alias tomcat -keyalg RSA
 
                  
     and specify a password value of "changeit".

                  
 
                • Uncomment the "SSL HTTP/1.1 Connector" entry in
-    $CATALINA_HOME/conf/server.xml and tweak as necessary.
                  • 
+    $CATALINA_BASE/conf/server.xml and tweak as necessary.
     

                  
 
 
@@ -301,9 +299,9 @@ If you haven't compiled in SSL support into your Tomcat Native library, then you
 
                  
 
 
                  The final step is to configure your secure socket in the
-$CATALINA_HOME/conf/server.xml file, where
-$CATALINA_HOME represents the directory into which you
-installed Tomcat 6.  An example <Connector> element
+$CATALINA_BASE/conf/server.xml file, where
+$CATALINA_BASE represents the base directory for the
+Tomcat 6 instance.  An example <Connector> element
 for an SSL connector is included in the default server.xml
 file installed with Tomcat.  It will look something like this: