xdocs/common_howto/quick.xml (147 lines of code) (raw):
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document [
<!ENTITY project SYSTEM "project.xml">
]>
<document url="quick.html">
&project;
<copyright>
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
</copyright>
<properties>
<title>Quick Start HowTo</title>
<author email="hgomez@apache.org">Henri Gomez</author>
</properties>
<body>
<section name="Introduction">
<p>
This document describes the configuration files used by JK on the
web server side for the 'impatient':
<ul>
<li>
<b>workers.properties</b> is a mandatory file used by the web server and which
is the same for all JK implementations (mod_jk for the Apache HTTP Server,
ISAPI for Microsoft IIS).
</li>
<li>
<b>web server</b> add-ons to be set on the web server side.
</li>
</ul>
</p>
<p>
We'll give here minimum servers configuration and an example <b>workers.properties</b>
to be able to install and check quickly your configuration.
</p>
</section>
<section name="Minimum workers.properties">
<p>
Here is a minimum <b>workers.properties</b>, using just ajp13 to connect your web server
to the Tomcat engine, complete documentation is available in <a href="workers.html">Workers HowTo</a>.
</p>
<p>
<source># Define 1 real worker using ajp13
worker.list=worker1
# Set properties for worker1 (ajp13)
worker.worker1.type=ajp13
worker.worker1.host=localhost
worker.worker1.port=8009
</source>
</p>
</section>
<section name="Minimum Apache HTTP Server configuration">
<p>
Here is some very basic information about Apache configuration, a
more complete <a href="../webserver_howto/apache.html">HowTo for Apache</a> is available.
</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 for modules directory on Unix:
<ul>
<li>/usr/lib/apache/</li>
<li>/usr/lib/apache2/</li>
<li>/usr/local/apache/libexec/</li>
<li>/usr/local/apache/modules/</li>
</ul>
</p>
<p>
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>
</ul>
</p>
<p>
You'll find a link to prebuilt binaries
<a href="//tomcat.apache.org/download-connectors.cgi">here</a>
</p>
<p>
Here is the minimum which should be set in <b>httpd.conf</b> directly or
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>
<source># Load mod_jk module
# Update this path to match your modules location
LoadModule jk_module modules/mod_jk.so
# Declare the module for <IfModule directive> (remove this line for Apache 2.x)
AddModule mod_jk.c
# Where to find workers.properties
# Update this path to match your conf directory location (put workers.properties next to httpd.conf)
JkWorkersFile /etc/httpd/conf/workers.properties
# Where to put jk shared memory
# Update this path to match your local state directory or logs directory
JkShmFile /var/log/httpd/mod_jk.shm
# Where to put jk logs
# Update this path to match your logs directory location (put mod_jk.log next to access_log)
JkLogFile /var/log/httpd/mod_jk.log
# Set the jk log level [debug/error/info]
JkLogLevel info
# Select the timestamp log format
JkLogStampFormat "[%a %b %d %H:%M:%S %Y] "
# Send everything for context /examples to worker named worker1 (ajp13)
JkMount /examples/* worker1
</source>
</p>
</section>
<section name="Minimum Microsoft IIS configuration">
<p>
A separate <a href="../webserver_howto/iis.html">HowTo for the Microsoft IIS web server</a> is available.
</p>
<todo>
More information to be added!
</todo>
</section>
<section name="Test your configuration">
<p>
(Re)start the web server and browse to the <a href="http://localhost/examples/">http://localhost/examples/</a>
</p>
</section>
</body>
</document>