hgomez 2002/11/07 01:16:16
Modified: jk/xdocs/jk quickhowto.xml
Log:
Added documentation for the impatient ;)
Revision Changes Path
1.4 +59 -37 jakarta-tomcat-connectors/jk/xdocs/jk/quickhowto.xml
Index: quickhowto.xml
===================================================================
RCS file: /home/cvs/jakarta-tomcat-connectors/jk/xdocs/jk/quickhowto.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- quickhowto.xml 6 Nov 2002 17:11:27 -0000 1.3
+++ quickhowto.xml 7 Nov 2002 09:16:15 -0000 1.4
@@ -1,18 +1,18 @@
<?xml version="1.0"?>
<document>
<properties>
-<title>Quick Start JK HowTo</title>
+<title>Quick Start HowTo</title>
<author email="[EMAIL PROTECTED]">Henri Gomez</author>
<date>$Date$</date>
</properties>
<section name="Introduction">
<p>
This document describes the configuration files used by JK on the
- Tomcat and Web Server side for the impatients:
+ Web Server side for the 'impatients':
<ul>
<li>
- <b>workers.properties</b> is used on the webserver side. For the Apache
- servers the default path is in the ServerRoot/conf directory.
+ <b>workers.properties</b> is a mandatory file used by the webserver and which
+ is the same for all JK implementations (Apache/IIS/NES).
</li>
<li>
<b>WebServers</b> add-ons to be set on the webserver side.
@@ -27,48 +27,45 @@
<section name="Minimum workers.properties">
<p>
- Here is the minimun workers.properties, using just ajp12, ajp13 and
load-balancing to connect your Apache webserver
- to the Tomcat engine
+ Here is a minimum <b>workers.properties</b>, using just ajp13 to connect your
Apache webserver
+ to the Tomcat engine, complete documentation is available in <a
href="jk/workershowto.html">Workers HowTo</a>.
</p>
<p>
<screen>
-<note># Define 3 workers, 2 real workers using ajp12, ajp13 and the last one being
a loadbalancing worker</note>
-<read>worker.list=worker1, worker2, worker3</read>
-<note># Set properties for worker1 (ajp12)</note>
-<read>worker.worker1.type=ajp12</read>
+<note># Define 1 real worker using ajp13</note>
+<read>worker.list=worker1</read>
+<note># Set properties for worker1 (ajp13)</note>
+<read>worker.worker1.type=ajp13</read>
<read>worker.worker1.host=locahost</read>
-<read>worker.worker1.port=8007</read>
-<read>worker.worker1.lbfactor=5</read>
-<note># Set properties for worker2 (ajp13)</note>
-<read>worker.worker2.type=ajp13</read>
-<read>worker.worker2.host=locahost</read>
-<read>worker.worker2.port=8009</read>
-<read>worker.worker2.lbfactor=50</read>
-<read>worker.worker2.cachesize=10</read>
-<read>worker.worker2.cache_timeout=600</read>
-<read>worker.worker2.socket_keepalive=1</read>
-<read>worker.worker2.socket_timeout=300</read>
-<note># Set properties for worker3 (lb) which use worker1 and worker2</note>
-<read>worker.worker3.balanced_workers=worker1,worker2</read>
+<read>worker.worker1.port=8009</read>
+<read>worker.worker1.lbfactor=50</read>
+<read>worker.worker1.cachesize=10</read>
+<read>worker.worker1.cache_timeout=600</read>
+<read>worker.worker1.socket_keepalive=1</read>
+<read>worker.worker1.socket_timeout=300</read>
</screen>
</p>
</section>
<section name="Minimum Apache WebServer configuration">
<p>
+ Here is a minimun informations about Apache configuration, a
+ complete documentation is available in <a href="jk/aphowto.html">Apache
HowTo</a>.
+</p>
+<p>
You should first have <b>mod_jk.so</b> (unix) or <b>mod_jk.dll</b> (Windows)
installed
in your Apache module directory (see your Apache documentation to locate it).
</p>
<p>
- Usual locations on Unix:
+ Usual locations for modules directory on Unix:
<ul>
- <li>/usr/lib/apache</li>
- <li>/usr/lib/apache2</li>
- <li>/usr/local/apache/libexec</li>
+ <li>/usr/lib/apache/</li>
+ <li>/usr/lib/apache2/</li>
+ <li>/usr/local/apache/libexec/</li>
</ul>
</p>
<p>
- Usual locations on Windows :
+ Usual locations for modules directory on Windows :
<ul>
<li>C:\Program Files\Apache Group\Apache\modules\</li>
<li>C:\Program Files\Apache Group\Apache2\modules\</li>
@@ -79,17 +76,35 @@
</p>
<p>
Here is the minimum which should be set in <b>httpd.conf</b> directly or
- included from another file, the default path is in the ServerRoot/conf
directory.
+ included from another file:
+</p>
+<p>
+ Usual locations for configuration directory on Unix:
+ <ul>
+ <li>/etc/httpd/conf/</li>
+ <li>/etc/httpd2/conf/</li>
+ <li>/usr/local/apache/conf/</li>
+ </ul>
+</p>
+<p>
+ Usual locations for configuration directory on Windows :
+ <ul>
+ <li>C:\Program Files\Apache Group\Apache\conf\</li>
+ <li>C:\Program Files\Apache Group\Apache2\conf\</li>
+ </ul>
</p>
<p>
<screen>
<note># Load mod_jk module</note>
+<note># Update this path to match your modules location</note>
<read>LoadModule jk_module libexec/mod_jk.so</read>
<note># Declare the module for <IfModule directive></note>
<read>AddModule mod_jk.c</read>
<note># Where to find workers.properties</note>
+<note># Update this path to match your conf directory location (put
workers.properties next to httpd.conf)</note>
<read>JkWorkersFile /etc/httpd/conf/workers.properties</read>
<note># Where to put jk logs</note>
+<note># Update this path to match your logs directory location (put mod_jk.log next
to access_log)</note>
<read>JkLogFile /var/log/httpd/mod_jk.log</read>
<note># Set the jk log level [debug/error/info]</note>
<read>JkLogLevel info</read>
@@ -99,17 +114,24 @@
<read>JkOptions +ForwardKeySize +ForwardURICompat -ForwardDirectories</read>
<note># JkRequestLogFormat set the request format </note>
<read>JkRequestLogFormat "%w %V %T"</read>
-<note># Send servlet for context /examples to worker named worker2 (ajp13)</note>
-<read>JkMount /examples/servlet/* worker2</read>
-<note># Send JSPs for context /examples to worker named worker2 (ajp13)</note>
-<read>JkMount /examples/*.jsp worker2</read>
+<note># Send everything for context /examples to worker named worker1 (ajp13)</note>
+<read>JkMount /examples/* worker1</read>
</screen>
</p>
</section>
+<section name="Minimum Domino WebServer configuration">
+<p>
+ A complete documentation is available in <a href="jk/domhowto.html">Domino
HowTo</a>.
+</p>
+<todo>
+More informations to be added, Nacho ?
+</todo>
+</section>
+
<section name="Minimum IIS WebServer configuration">
<p>
-Minimum configuration for IIS Web Servers.
+ A complete documentation is available in <a href="jk/iishowto.html">IIS
HowTo</a>.
</p>
<todo>
More informations to be added, Nacho ?
@@ -118,7 +140,7 @@
<section name="Minimum NES/iPlanet WebServer configuration">
<p>
-Minimum configuration for NES/iPlanet Web Servers.
+ A complete documentation is available in <a
href="jk/neshowto.html">Netscape/iPlanet HowTo</a>.
</p>
<todo>
More informations to be added, Mike ?
@@ -128,7 +150,7 @@
<section name="Test your configuration">
<p>
-(Re)start the Web server and browse to the <a>http://localhost/examples/</a>
+ (Re)start the Web server and browse to the <a>http://localhost/examples/</a>
</p>
</section>
--
To unsubscribe, e-mail: <mailto:tomcat-dev-unsubscribe@;jakarta.apache.org>
For additional commands, e-mail: <mailto:tomcat-dev-help@;jakarta.apache.org>
