remm 02/01/27 03:52:11
Modified: webapps/tomcat-docs/config jk.xml
Log:
- Port documentation for ApacheConfig and IISConfig by Bill Barker.
Revision Changes Path
1.2 +232 -2 jakarta-tomcat-4.0/webapps/tomcat-docs/config/jk.xml
Index: jk.xml
===================================================================
RCS file: /home/cvs/jakarta-tomcat-4.0/webapps/tomcat-docs/config/jk.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- jk.xml 25 Jan 2002 15:21:34 -0000 1.1
+++ jk.xml 27 Jan 2002 11:52:11 -0000 1.2
@@ -299,8 +299,9 @@
<subsection name="Configuring Tomcat">
- <p>Tomcat 4 won't automatically generate the Apache configuration
- file at the moment.</p>
+ <p>Tomcat 4 can be configured to automatically generate the Apache
+ configuration file. The next section describes how to enable
+ this option.</p>
<p>After enabling the AJP 1.3 connector, you need to define workers,
using a <code>$CATALINA_HOME/conf/workers.properties</code> file.
@@ -310,6 +311,121 @@
</subsection>
+ <subsection name="Using ApacheConfig">
+
+ <p>Tomcat 4 provides extra flexability over Tomcat 3 in setting up
+ the automatic generation of the Apache configuration file.
+ However, this comes at the cost of a bit more complexity. Each
+ time that Tomcat is started, it will write the configuration file
+ to <code>$CATALINA_HOME/conf/auto/mod_jk.conf</code>. You can
+ then either
+ <source>Include $CATALINA_HOME/conf/auto/mod_jk.conf</source>
+ in your <code>httpd.conf</code> file.</p>
+
+ <p>To generate the global Apache directives (e.g.
+ <code>LoadModule</code>, <code>JkLogFile</code>), you define a
+ <code>Server</code> Listener:</p>
+
+<source>
+ <Server port="8005" shutdown="SHUTDOWN" debug="0">
+ <Listener className="org.apache.ajp.tomcat4.config.ApacheConfig" />
+ ...
+</source>
+
+ <p>To configure the individual context information, you then either
+ define a <code>Host</code> Listener or a <code>Context</code>
+ Listener depending on if you are using virutal hosting or not.
+ Defining a <code>Host</code> Listener will generate the Apache
+ <code><VirtualHost></code> directive and include all of
+ the configurations for the <code>Contexts</code> under this host.
+ Using the <code>Context</code> Listener allows you the flexability
+ to configure the <code>Context</code> the same way even if it
+ is being served from several hosts.</p>
+
+ <p>Except for the placement of the <code><Listener ...></code>,
+ the syntax is virtualy identical for the <code>Host</code>
+ Listener and the <code>Context</code> Listener. The examples that
+ follow will demonstrate the functionality for a <code>Host</code>
+ Listener. The simplest configuration is:</p>
+
+<source>
+ <Host name="localhost" debug="0" appbase="webapps" >
+ <Listener className="org.apache.ajp.tomcat4.config.ApacheConfig"
+ append="true" />
+</source>
+
+ <p>It is possible to modify the output configuration file with the
+ following attributes:</p>
+
+ <attributes>
+
+ <attribute name="configHome" required="false">
+ Default parent directory for the following paths. If not set, this
+ defaults to CATALINA_HOME. Ignored whenever any of the following
+ paths is absolute
+ </attribute>
+
+ <attribute name="jkConfig" required="false">
+ Path to write apacke mod_jk conf file to. If not set, defaults to
+ "conf/auto/mod_jk.conf".
+ </attribute>
+
+ <attribute name="workersConfig" required="false">
+ Path to workers.properties file used by mod_jk. If not set,
+ defaults to "conf/jk/workers.properties".
+ </attribute>
+
+ <attribute name="modJk" required="false">
+ Path to Apache mod_jk plugin file. If not set, defaults to
+ "modules/mod_jk.dll" on windows, "modules/mod_jk.nlm" on netware,
+ and "libexec/mod_jk.so" everywhere else.
+ </attribute>
+
+ <attribute name="jkLog" required="false">
+ Path to log file to be used by mod_jk
+ </attribute>
+
+ <attribute name="jkDebug" required="false">
+ JK Loglevel setting. May be debug, info, error, or emerg. If not
+ set, defaults to no log.
+ </attribute>
+
+ <attribute name="jkWorker" required="false">
+ The desired worker. Must be set to one of the workers defined in
+ the workers.properties file. "ajp13" or "inprocess" are
+ the workers found in the default workers.properties file. If not
+ specified, defaults to "ajp13".
+ </attribute>
+
+ <attribute name="forwardAll" required="false">
+ If true, forward all requests to Tomcat. This helps ensure that
+ all the behavior configured in the web.xml file functions
+ correctly. If false, let Apache serve static resources. The
+ default is true. Warning: When false, some configuration in the
+ web.xml may not be duplicated in Apache. Review the mod_jk conf
+ file to see what configuration is actually being set in Apache.
+ </attribute>
+
+ <attribute name="noRoot" required="false">
+ If true, the root context is not mapped to Tomcat. If false and
+ forwardAll is true, all requests to the root context are mapped to
+ Tomcat. If false and forwardAll is false, only JSP and servlets
+ requests to the root context are mapped to Tomcat. When false, to
+ correctly serve Tomcat's root context you must also modify the
+ DocumentRoot setting in Apache's httpd.conf file to point to
+ Tomcat's root context directory. Otherwise some content, such as
+ Apache's index.html, will be served by Apache before mod_jk gets a
+ chance to claim the request and pass it to Tomcat. The default is
+ true.</attribute>
+
+ <attribute name="append" required="false">
+ Append to the current configuration file.
+ </attribute>
+
+ </attributes>
+
+ </subsection>
+
<subsection name="Example Configuration Files">
<p>Excerpt from workers.properties showing the Ajp13 worker:</p>
@@ -465,6 +581,120 @@
to load.</li>
</ul>
</p>
+
+ </subsection>
+
+ <subsection name="Using IISConfig">
+
+ <p>Tomcat 4 provides extra flexability over Tomcat 3 in setting up
+ the automatic generation of the IIS configuration file.
+ However, this comes at the cost of a bit more complexity. Each
+ time that Tomcat is started, it will write the configuration file
+ to <code>%CATALINA_HOME%/conf/auto/uriworkers.properties</code>. If
+ enabled as a <code>Server</code> Listener, it will also write the
+ required registry entries to
+ <code>%CATALINA_HOME%/conf/auto/iis_redirect.reg</code>. You may
+ enter the settings into the registry by double-clicking on this
+ file from the Windows Explorer.</p>
+
+ <p>To generate the global IIS directives (including the registry file),
+ you define a <code>Server</code> Listener:</p>
+
+<source>
+ <Server port="8005" shutdown="SHUTDOWN" debug="0">
+ <Listener className="org.apache.ajp.tomcat4.config.IISConfig" />
+ ...
+</source>
+
+ <p>To configure the individual context information, you then either
+ define a <code>Host</code> Listener or a <code>Context</code>
+ Listener depending on if you are using virutal hosting or not.
+ Defining a <code>Host</code> Listener will include all of
+ the configurations for the <code>Contexts</code> under this host.
+ Using the <code>Context</code> Listener allows you the flexability
+ to configure the <code>Context</code> the same way even if it
+ is being served from several hosts.</p>
+
+ <p>Except for the placement of the <code><Listener ...></code>,
+ the syntax is virtualy identical for the <code>Host</code>
+ Listener and the <code>Context</code> Listener. The examples that
+ follow will demonstrate the functionality for a <code>Host</code>
+ Listener. The simplest configuration is:</p>
+
+<source>
+ <Host name="localhost" debug="0" appbase="webapps" >
+ <Listener className="org.apache.ajp.tomcat4.config.IISConfig"
+ append="true" />
+</source>
+
+ <p>It is possible to modify the output configuration file with the
+ following attributes:</p>
+
+ <attributes>
+
+ <attribute name="configHome" required="false">
+ Default parent directory for the following paths. If not set, this
+ defaults to CATALINA_HOME. Ignored whenever any of the following
+ paths is absolute.
+ </attribute>
+
+ <attribute name="regConfig" required="false">
+ Path to use for writing the registry settings configuration file.
+ If not set, defaults to "conf/auto/iis_redirect.reg".
+ </attribute>
+
+ <attribute name="uriConfig" required="false">
+ Path to use for writing the URI worker map configuration file.
+ If not set, defaults to "conf/auto/uriworkermap.properties".
+ </attribute>
+
+ <attribute name="workersConfig" required="false">
+ Path to workers.properties file used by mod_jk. If not set,
+ defaults to "conf/jk/workers.properties".
+ </attribute>
+
+ <attribute name="jkLog" required="false">
+ path to log file to be used by mod_jk
+ </attribute>
+
+ <attribute name="jkDebug" required="false">
+ JK Loglevel setting. May be debug, info, error, or emerg. If not
+ set, defaults to no emerg.
+ </attribute>
+
+ <attribute name="jkWorker" required="false">
+ The desired worker. Must be set to one of the workers defined in
+ the workers.properties file. "ajp13" or "inprocess" are
+ the workers found in the default workers.properties file. If not
+ specified, defaults to "ajp13".
+ </attribute>
+
+ <attribute name="forwardAll" required="false">
+ If true, forward all requests to Tomcat. This helps ensure that
+ all the behavior configured in the web.xml file functions
+ correctly. If false, let IIS serve static resources. The
+ default is true. Warning: When false, some configuration in the
+ web.xml may not be duplicated in IIS. Review the mod_jk conf
+ file to see what configuration is actually being set in IIS.
+ </attribute>
+
+ <attribute name="noRoot" required="false">
+ If true, the root context is not mapped to Tomcat. If false and
+ forwardAll is true, all requests to the root context are mapped to
+ Tomcat. If false and forwardAll is false, only JSP and servlets
+ requests to the root context are mapped to Tomcat. When false, to
+ correctly serve Tomcat's root context you must also modify the
+ DocumentRoot setting in IIS's httpd.conf file to point to
+ Tomcat's root context directory. Otherwise some content, such as
+ IIS's index.html, will be served by IIS before mod_jk gets a
+ chance to claim the request and pass it to Tomcat. The default is
+ true.</attribute>
+
+ <attribute name="append" required="false">
+ Append to the current configuration file.
+ </attribute>
+
+ </attributes>
</subsection>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
