rubbos/app/tomcat-connectors-1.2.32-src/xdocs/generic_howto/quick.xml

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE document [
   3   <!ENTITY project SYSTEM "project.xml">
   4 ]>
   5 <document url="quick.html">
   6
   7   &project;
   8 <copyright>
   9    Licensed to the Apache Software Foundation (ASF) under one or more
  10    contributor license agreements.  See the NOTICE file distributed with
  11    this work for additional information regarding copyright ownership.
  12    The ASF licenses this file to You under the Apache License, Version 2.0
  13    (the "License"); you may not use this file except in compliance with
  14    the License.  You may obtain a copy of the License at
  15
  16        http://www.apache.org/licenses/LICENSE-2.0
  17
  18    Unless required by applicable law or agreed to in writing, software
  19    distributed under the License is distributed on an "AS IS" BASIS,
  20    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  21    See the License for the specific language governing permissions and
  22    limitations under the License.
  23 </copyright>
  24 <properties>
  25 <title>Quick Start HowTo</title>
  26 <author email="hgomez@apache.org">Henri Gomez</author>
  27 <date>$Date: 2010-03-15 16:26:00 +0100 (Mon, 15 Mar 2010) $</date>
  28 </properties>
  29 <body>
  30 <section name="Introduction">
  31 <p>
  32   This document describes the configuration files used by JK on the
  33   Web Server side for the 'impatient':
  34     <ul>
  35     <li>
  36     <b>workers.properties</b> is a mandatory file used by the webserver and which
  37     is the same for all JK implementations (Apache/IIS/NES).
  38     </li>
  39     <li>
  40     <b>web server</b> add-ons to be set on the webserver side.
  41     </li>
  42     </ul>
  43 </p>
  44 <p>
  45   We'll give here minimum servers configuration and an example <b>workers.properties</b>
  46   to be able to install and check quickly your configuration.
  47 </p>
  48 </section>
  49
  50 <section name="Minimum workers.properties">
  51 <p>
  52     Here is a minimum <b>workers.properties</b>, using just ajp13 to connect your Apache webserver
  53     to the Tomcat engine, complete documentation is available in <a href="workers.html">Workers HowTo</a>.
  54 </p>
  55 <p>
  56 <source>
  57
  58   # Define 1 real worker using ajp13
  59   worker.list=worker1
  60   # Set properties for worker1 (ajp13)
  61   worker.worker1.type=ajp13
  62   worker.worker1.host=localhost
  63   worker.worker1.port=8009
  64
  65 </source>
  66 </p>
  67 </section>
  68
  69 <section name="Minimum Apache web server configuration">
  70 <p>
  71    Here is a minimum information about Apache configuration, a
  72    more complete <a href="../webserver_howto/apache.html">separate HowTo for Apache</a> is available.
  73 </p>
  74 <p>
  75   You should first have <b>mod_jk.so</b> (unix) or <b>mod_jk.dll</b> (Windows) installed
  76   in your Apache module directory (see your Apache documentation to locate it).
  77 </p>
  78 <p>
  79   Usual locations for modules directory on Unix:
  80   <ul>
  81   <li>/usr/lib/apache/</li>
  82   <li>/usr/lib/apache2/</li>
  83   <li>/usr/local/apache/libexec/</li>
  84   </ul>
  85 </p>
  86 <p>
  87   Usual locations for modules directory on Windows :
  88   <ul>
  89   <li>C:\Program Files\Apache Group\Apache\modules\</li>
  90   <li>C:\Program Files\Apache Group\Apache2\modules\</li>
  91   </ul>
  92 </p>
  93 <p>
  94   You'll find a link to prebuilt binaries
  95         <a href="http://tomcat.apache.org/download-connectors.cgi/">here</a>
  96 </p>
  97 <p>
  98     Here is the minimum which should be set in <b>httpd.conf</b> directly or
  99     included from another file:
 100 </p>
 101 <p>
 102   Usual locations for configuration directory on Unix:
 103   <ul>
 104   <li>/etc/httpd/conf/</li>
 105   <li>/etc/httpd2/conf/</li>
 106   <li>/usr/local/apache/conf/</li>
 107   </ul>
 108 </p>
 109 <p>
 110   Usual locations for configuration directory on Windows :
 111   <ul>
 112   <li>C:\Program Files\Apache Group\Apache\conf\</li>
 113   <li>C:\Program Files\Apache Group\Apache2\conf\</li>
 114   </ul>
 115 </p>
 116 <p>
 117 <source>
 118
 119   # Load mod_jk module
 120   # Update this path to match your modules location
 121   LoadModule    jk_module  libexec/mod_jk.so
 122   # Declare the module for &lt;IfModule directive&gt; (remove this line on Apache 2.x)
 123   AddModule     mod_jk.c
 124   # Where to find workers.properties
 125   # Update this path to match your conf directory location (put workers.properties next to httpd.conf)
 126   JkWorkersFile /etc/httpd/conf/workers.properties
 127   # Where to put jk shared memory
 128   # Update this path to match your local state directory or logs directory
 129   JkShmFile     /var/log/httpd/mod_jk.shm
 130   # Where to put jk logs
 131   # Update this path to match your logs directory location (put mod_jk.log next to access_log)
 132   JkLogFile     /var/log/httpd/mod_jk.log
 133   # Set the jk log level [debug/error/info]
 134   JkLogLevel    info
 135   # Select the timestamp log format
 136   JkLogStampFormat "[%a %b %d %H:%M:%S %Y] "
 137   # Send everything for context /examples to worker named worker1 (ajp13)
 138   JkMount  /examples/* worker1
 139
 140 </source>
 141 </p>
 142 </section>
 143
 144 <section name="Minimum IIS web server configuration">
 145 <p>
 146   A separate <a href="../webserver_howto/iis.html">HowTo for the IIS web server</a> is available.
 147 </p>
 148 <todo>
 149 More information to be added!
 150 </todo>
 151 </section>
 152
 153 <section name="Minimum NES/iPlanet/Sun web server configuration">
 154 <p>
 155   A separate <a href="../webserver_howto/nes.html">HowTo for the Netscape/iPlanet/Sun web server</a> is available.
 156 <todo>
 157 More information to be added?
 158 </todo>
 159 </p>
 160 </section>
 161
 162
 163 <section name="Test your configuration">
 164 <p>
 165   (Re)start the web server and browse to the <a href="http://localhost/examples/">http://localhost/examples/</a>
 166 </p>
 167
 168 </section>
 169 </body>
 170 </document>