remm 2002/09/10 01:49:05
Modified: webapps/tomcat-docs build.xml project.xml
webapps/tomcat-docs/config jk2.xml
Log:
- Integrate JK2 docs.
- Cleanups.
Revision Changes Path
1.12 +10 -0 jakarta-tomcat-4.0/webapps/tomcat-docs/build.xml
Index: build.xml
===================================================================
RCS file: /home/cvs/jakarta-tomcat-4.0/webapps/tomcat-docs/build.xml,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- build.xml 16 Sep 2001 04:58:28 -0000 1.11
+++ build.xml 10 Sep 2002 08:49:05 -0000 1.12
@@ -10,6 +10,8 @@
<property file="../../build.properties"/>
<property file="${user.home}/build.properties"/>
+ <property name="tomcat-jk.home" value="${jtc.home}/jk"/>
+
<property name="build.compiler" value="classic"/>
<property name="webapps.build" value="../build"/>
<property name="webapps.dist" value="../dist"/>
@@ -112,6 +114,14 @@
includes="*.xml">
<param name="relative-path" expression=".."/>
</style>
+
+ <!-- Build Coyote JK2 documentation -->
+ <mkdir dir="${webapps.build}/${webapp.name}/jk2"/>
+ <ant dir="${tomcat-jk.home}" target="docs"/>
+
+ <copy todir="${webapps.build}/${webapp.name}/jk2">
+ <fileset dir="${tomcat-jk.home}/build/docs"/>
+ </copy>
</target>
1.17 +5 -1 jakarta-tomcat-4.0/webapps/tomcat-docs/project.xml
Index: project.xml
===================================================================
RCS file: /home/cvs/jakarta-tomcat-4.0/webapps/tomcat-docs/project.xml,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -r1.16 -r1.17
--- project.xml 8 Sep 2002 17:56:04 -0000 1.16
+++ project.xml 10 Sep 2002 08:49:05 -0000 1.17
@@ -22,10 +22,14 @@
<item name="Building from Source" href="BUILDING.txt"/>
</menu>
+ <menu name="Configuration">
+ <item name="Reference" href="config/index.html"/>
+ </menu>
+
<menu name="Administrators">
<item name="CGI HOW-TO" href="cgi-howto.html"/>
- <item name="Config. Reference" href="config/index.html"/>
<item name="Class Loader HOW-TO" href="class-loader-howto.html"/>
+ <item name="Connectors List" href="config/connectors.html"/>
<item name="JNDI DataSource HOW-TO"
href="jndi-datasource-examples-howto.html"/>
<item name="JNDI Resources HOW-TO" href="jndi-resources-howto.html"/>
1.3 +2 -442 jakarta-tomcat-4.0/webapps/tomcat-docs/config/jk2.xml
Index: jk2.xml
===================================================================
RCS file: /home/cvs/jakarta-tomcat-4.0/webapps/tomcat-docs/config/jk2.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- jk2.xml 16 Apr 2002 17:48:56 -0000 1.2
+++ jk2.xml 10 Sep 2002 08:49:05 -0000 1.3
@@ -157,448 +157,8 @@
<section name="Configuration HOWTOs">
- <subsection name="Apache">
-
- <subsection name="Introduction">
-
- <p>This section explains how to connect Tomcat 4 to the popular
- open source web server, Apache. It was originally part of
- <i>Tomcat: A Minimalistic User's Guide</i> by Gal Shachor, but
- has been split off for organizational reasons. It should be
- considered a <b>work in progress</b>. Since the Tomcat source
- tree is constantly changing, the information herein may be out
- of date. The only definitive reference at this point is the <a
- href="http://jakarta.apache.org/site/sourceindex.html";>source
- code</a>.</p>
-
- </subsection>
-
- <subsection name="Installation">
-
- <subsection name="Needed Components">
-
- <p>In a nutshell a web server is waiting for client HTTP requests.
- When these requests arrive the server does whatever is needed to
- serve the requests by providing the necessary content. Adding a
- servlet container may somewhat change this behavior. Now the web
- server needs also to perform the following:</p>
-
- <ul>
- <li>Load the servlet container adapter library
- and initialize it (prior to serving requests). </li>
- <li>When a request arrives, it needs to check and see if a certain
- request belongs to a servlet, if so it needs to let the adapter
- take the request and handle it.</li>
- </ul>
-
- <p>The adapter on the other hand needs to know what requests it is
- going to serve, usually based on some pattern in the request URL,
- and to where to direct these requests.</p>
-
- <p>Things are even more complex when the user wants to set
- a configuration that uses virtual hosts, or when they want multiple
- developers to work on the same web server but on different servlet
- container JVMs. We will cover these two cases
- in the advanced sections.</p>
-
- </subsection>
-
- <subsection name="mod_jk Terminology">
-
- <p>The following terms are used in this section:</p>
-
- <ul>
- <li><strong>Worker process</strong> - A worker is a Tomcat
- instance that is running to serve servlet requests coming
- from the web server. In most cases there is only a single worker
- (the one and only Tomcat process) but sometimes you will run
- multiple workers to achieve load balancing or site partitioning.
- Each worker is identified to the web server by the host were
- it is located, the port where it listens and the communication
- protocol used to exchange messages.</li>
- <li><strong>In-Process Worker</strong> - This is a special
- worker. Instead of working with a Tomcat process residing on
- another process, the web server opens a JVM and executes
- Tomcat inside the web server process address space.
- Our discussion in this document is not going to get into this
- special worker. Note: Tomcat 4 can't be run as this type of
- worker at the moment.</li>
- <li><strong>Web Server Plug-in/Tomcat Redirector</strong> -
- For Tomcat to cooperate with any web server it needs an "agent"
- to reside in the web server and send him servlet requests.
- This is the web server plug-in, and in our case the web server
- plug-in is mod_jk. The redirector usually comes in the shape of
- a DLL or shared object module that you plug into
- the web server.</li>
- <li><strong>Plug-in Configuration</strong> - We need to
- configure the web server plug-in so that it knows where
- the different Tomcat workers are and to which of them
- it should forward requests. This information, accompanied with
- some internal parameter, such as the log level, comprises
- the plug-in configuration.</li>
- <li><strong>Web Server Configuration</strong> - Each web server
- has some configuration that defines its behavior, e.g. on which
- port to listen, what files to serve, what web server plug-ins
- to load, etc. You will need to modify your web server
- configuration to instruct it to load the Tomcat
- redirector mod_jk.</li>
- </ul>
-
- </subsection>
-
- <subsection name="Getting mod_jk">
-
- <p>The mod_jk source now resides in the jakarta-tomcat-connectors
- subproject. Please refer to it for build instructions.</p>
-
- <p>Binaries for mod_jk are available for several platforms in the
- same area as the Tomcat Binary Release. The binaries are located
- in subdirectories by platform. For some platforms, such as Windows,
- this is the typical way of obtaining mod_jk since most Windows
- systems do not have C compilers. For others, the binary
- distribution of mod_jk offers simpler installation.</p>
-
- <p><strong>Note: Note: The version of mod_jk is not dependent on
- the version of Tomcat. The Tomcat 3.3 distribution of mod_jk will
- function correctly with Tomcat 4.x and other 3.x versions of
- Tomcat, such as Tomcat 3.2.1.</strong></p>
-
- </subsection>
-
- <subsection name="Configuring Apache">
-
- <p>If you've previously configured Apache to use mod_jserv, remove
- any ApJServMount directives from your httpd.conf. If you're
- including tomcat-apache.conf or tomcat.conf, you'll want to remove
- them as well - they are specific to mod_jserv.
- The mod_jserv configuration directives are not compatible
- with mod_jk!</p>
-
- <p>Unlike Tomcat 3, Tomcat 4 doesn't automatically generate the
- necessary <code>$CATALINA_HOME/conf/mod_jk.conf</code>,
- and it will have to be created manually. Note that Tomcat
- and Apache must be restarted after adding a new context.</p>
-
- <p>The basic configuration is as follows:</p>
-
- <ul>
- <li>You will need to instruct Apache to load Tomcat. This can be
- done with Apache's LoadModule and AddModule configuration
- directives.</li>
- <li>You must inform mod_jk the location of your
- workers.properties file. Use mod_jk's JkWorkersFile
- configuration directive.</li>
- <li>You should specify a location where mod_jk is going to place
- its log file and a log level to be used. Use the JkLogFile and
- JkLogLevel configuration directives. Possible log levels are
- debug, info, error and emerg. If the JkLogLevel is not specified,
- no log is generated.</li>
- <li>The directive JkLogStampFormat will configure the date/time
- format found on mod_jk logfile. Using strftime() format string
- it's set by default to "[%a %b %d %H:%M:%S %Y] "</li>
- <li>Use mod_jk's JkMount directive to assign specific URLs to
- Tomcat. In general the structure of a JkMount directive is:
- <code>JkMount URL_PREFIX WORKER_NAME</code>. You can use the
- JkMount directive at the top level or inside <VirtualHost>
- sections of your httpd.conf file.</li>
- </ul>
-
- </subsection>
-
- <subsection name="Configuring Tomcat">
-
- <p>Tomcat 4 won't automatically generate the Apache configuration
- file at the moment.</p>
-
- <p>After enabling the AJP 1.3 connector, you need to define workers,
- using a <code>$CATALINA_HOME/conf/workers.properties</code> file.
- In most cases, using the example workers.properties given below
- should work fine, after changing the path values to reflect how your
- environment is set up.</p>
-
- </subsection>
-
- <subsection name="Example Configuration Files">
-
- <p>Excerpt from workers.properties showing the Ajp13 worker:</p>
-
-<source>
-# Setup for Solaris system
-#
-workers.tomcat_home=/usr/local/jakarta-tomcat
-workers.java_home=/usr/java
-ps=/
-worker.list=ajp12, ajp13
-
-# Definition for Ajp13 worker
-#
-worker.ajp13.port=8009
-worker.ajp13.host=localhost
-worker.ajp13.type=ajp13
-</source>
-
- <p>Excerpt from Apaches httpd.conf showing JK directives:</p>
-
-<source>
-# Load mod_jk
-#
-LoadModule jk_module libexec/mod_jk.so
-AddModule mod_jk.c
-
-# Configure mod_jk
-#
-JkWorkersFile /usr/local/jakarta-tomcat/conf/jk/workers.properties
-JkLogFile /usr/local/apache/logs/mod_jk.log
-JkLogLevel info
-
-# First Virtual Host.
-#
-<VirtualHost 10.0.0.1:80>
-DocumentRoot /web/host1
-ServerName host1.apache.org
-JkMount /*.jsp ajp13
-JkMount /servlet/* ajp13
-</VirtualHost>
-
-# Second Virtual Host. Also accessible via HTTPS
-#
-<VirtualHost 10.0.0.2:80>
-DocumentRoot /web/host2
-ServerName host2.apache.org
-JkMount /*.jsp ajp13
-JkMount /servlet/* ajp13
-</VirtualHost>
-
-<VirtualHost 10.0.0.2:443>
-DocumentRoot /web/host2
-ServerName host2.apache.org
-SSLEngine On
-JkMount /*.jsp ajp13
-JkMount /servlet/* ajp13
-</VirtualHost>
-</source>
-
- </subsection>
-
- </subsection>
-
- </subsection>
-
- <subsection name="IIS 4.x and 5.x">
-
- <subsection name="Introduction">
-
- <p>This section explains how to set up IIS 4.0 or newer to cooperate
- with Tomcat 4. Normally IIS cannot execute Servlets and Java Server
- Pages (JSPs), configuring IIS to use Tomcat redirector plugin
- will allow IIS to redirect Servlet and JSP requests to Tomcat.</p>
-
- <p>The Tomcat redirector for IIS is composed of four entities:
- <ul>
- <li>isapi_redirect.dll - The IIS server plugin, either obtain a
- pre-built DLL or build it yourself (see the build section).</li>
- <li>worker.properties - A file that describes the host(s) and
- port (s) used by the workers (Tomcat processes).</li>
- <li>uriworkermap.properties - A file that maps URL-Path patterns
- to workers.</li>
- <li>iis_redirect.reg - A file that creates registry entries
- in the Windows registry.</li>
- </ul>
- </p>
-
- </subsection>
-
- <subsection name="Installation">
-
- <p>Make sure the Tomcat AJP connector is properly declared in the
- Catalina configuration file.</p>
-
- <p>Download isapi_redirect.dll for Tomcat 3.3 release or use the
- following
- <a
href="http://jakarta.apache.org/builds/jakarta-tomcat/release/v3.3/bin/win32/i386/";>link</a>.
- </p>
-
- <p>Note: See below for examples of the configuration files. Those
- configuration files assume Tomcat is installed in the
- <code>c:\jakarta-tomcat-4.0.1</code> directory.</p>
-
- <p>The next step is to create worker.properties to help
- isapi_redirect.dll to identify where to find Tomcat and its
- configuration.</p>
-
- <p>Next, the ISAPI filter for Tomcat must be configured to redirect
- requests for specific webapps to Tomcat.</p>
-
- <p>Then the <code>uriworkermap.properties</code> file must be created
- in <code>%CATALINA_HOME%\conf</code> directory.</p>
-
- </subsection>
-
- <subsection name="Configuring IIS">
-
- <p>
- <ul>
- <li>Launch Internet Service Manager</li>
- <li>Stop the Web Site if it is running</li>
- <li>Create a virtual directory, by clicking on the default
- web site
- <ul>
- <li>Type the alias to say jakarta, press Next</li>
- <li>Set the directory to <code>%CATALINA_HOME%\bin</code>
- where you installed isapi_redirect.dll, press next</li>
- <li>Provide only read and execute privileges for
- security purposes</li>
- </ul>
- </li>
- <li>Add a filter to the default web site, using the
- IIS Management Console, right click on the properties and
- go to ISAPI filters tab. Press Add button,
- add isapi_redirect.dll as a filter the name of the filter
- should reflect its task (for example, "Jakarta Redirector").
- The Executable field should point to the place where we installed
- isapi_redirect.dll, in our case
- <code>%CATALINA_HOME%\bin\isapi_redirect.dll</code></li>
- <li>Copy and paste the registry entries found below into a file
- iis_redirect.reg. Remember to correct the
- directories where Tomcat is installed in this file.
- Run the iis_redirect.reg file found at the end of this document.
- This will create entries in the registry which
- the isapi_redirect.dll looks for to determine the configuration
- and location of Tomcat.</li>
- <li>Startup IIS.</li>
- <li>Go to the Properties of the web site and select the ISAPI
- filters tab to make sure that the ISAPI filter got registered
- correctly. It should have a Green arrow alongside it.
- Note: it is recommended to restart computer for the ISAPI filter
- to load.</li>
- </ul>
- </p>
-
- </subsection>
-
- <subsection name="Sample worker.properties file">
-
- <p>
-<source>
-# ************ Begin worker.properties **************
-worker.ajp13.type=ajp13
-
-#
-# Specifies the load balance factor when used with
-# a load balancing worker.
-# Note:
-# ----> lbfactor must be > 0
-# ----> Low lbfactor means less work done by the worker.
-worker.ajp13.lbfactor=1
-
-#
-# Specify the size of the open connection cache.
-#worker.ajp13.cachesize
-
-#
-#------ DEFAULT LOAD BALANCER WORKER DEFINITION ----------------------
-#---------------------------------------------------------------------
-#
-
-#
-# The loadbalancer (type lb) worker perform weighted round-robin
-# load balancing with sticky sessions.
-# Note:
-# ----> If a worker dies, the load balancer will check its state
-# once in a while. Until then all work is redirected to peer
-# worker.
-worker.loadbalancer.type=lb
-worker.loadbalancer.balanced_workers=ajp13
-
-#
-# worker.tomcat_home should point to the location where you
-# installed tomcat. This is where you have your conf, webapps and lib
-# directories.
-#
-worker.tomcat_home=C:\jakarta-tomcat-4.0.1
-
-#
-# worker.java_home should point to your Java installation. Normally
-# you should have a bin and lib directories beneath it.
-#
-worker.java_home=C:\jdk1.3.1
-
-#
-# You should configure your environment slash... ps=\ on NT and / on UNIX
-# and maybe something different elsewhere.
-#
-ps=\
-
-#
-#------ ADVANCED MODE ------------------------------------------------
-#---------------------------------------------------------------------
-#
-
-#
-#------ DEFAULT worker list ------------------------------------------
-#---------------------------------------------------------------------
-#
-# The worker that your plugins should create and work with
-worker.list=ajp13
-
-#
-#------ DEFAULT ajp13 WORKER DEFINITION ------------------------------
-#---------------------------------------------------------------------
-#
-
-#
-# Defining a worker named ajp13 and of type ajp13
-# Note that the name and the type do not have to match.
-#
-worker.ajp13.port=8009
-worker.ajp13.host=localhost
-
-# ************ End worker.properties **************
-</source>
- </p>
-
- </subsection>
-
- <subsection name="Sample uriworkermap.properties">
-
- <p>
-<source>
-# *********** Begin uriworkermap.properties ***
-#
-# Simple worker configuration file
-#
-
-# Mount the Servlet context to the ajp13 worker
-/servlet/*=ajp13
-
-# Mount the examples context to the ajp13 worker
-/examples/*=ajp13
-
-# Advanced mount of the examples context
-# /examples/servlet/*=ajp13
-# ************* End uriworkermap.properties ****
-</source>
- </p>
-
- </subsection>
-
- <subsection name="iis_redirect.reg">
-
- <p>
-<source>
-REGEDIT4
-[HKEY_LOCAL_MACHINE\SOFTWARE\Apache Software Foundation\Jakarta Isapi
Redirector\1.0]
-"extension_uri"="/jakarta/isapi_redirect.dll"
-"log_file"="C:\\jakarta-tomcat-4.0.1\\logs\\iis_redirect.log"
-"log_level"="emerg"
-"worker_file"="C:\\jakarta-tomcat-4.0.1\\conf\\worker.properties"
-"worker_mount_file"="C:\\jakarta-tomcat-4.0.1\\conf\\uriworkermap.properties"
-</source>
- </p>
-
- </subsection>
-
- </subsection>
+ <p>Please refer to the <a href="../jk2/index.html">Coyote JK 2 documentation</a>
+ for HOWTOs and complete configuration information.</p>
</section>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
