1
<?xml version="1.0" encoding="ISO-8859-1"?>
3
<!ENTITY project SYSTEM "project.xml">
5
<document url="quick.html">
9
Copyright 1999-2004 The Apache Software Foundation
11
Licensed under the Apache License, Version 2.0 (the "License");
12
you may not use this file except in compliance with the License.
13
You may obtain a copy of the License at
15
http://www.apache.org/licenses/LICENSE-2.0
17
Unless required by applicable law or agreed to in writing, software
18
distributed under the License is distributed on an "AS IS" BASIS,
19
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
20
See the License for the specific language governing permissions and
21
limitations under the License.
24
<title>Quick Start HowTo</title>
25
<author email="hgomez@apache.org">Henri Gomez</author>
26
<date>$Date: 2005/07/04 08:01:01 $</date>
29
<section name="Introduction">
31
This document describes the configuration files used by JK on the
32
Web Server side for the 'impatients':
35
<b>workers.properties</b> is a mandatory file used by the webserver and which
36
is the same for all JK implementations (Apache/IIS/NES).
39
<b>WebServers</b> add-ons to be set on the webserver side.
44
We'll give here minimum servers configuration and an example <b>workers.properties</b>
45
to be able to install and check quickly your configuration.
49
<section name="Minimum workers.properties">
51
Here is a minimum <b>workers.properties</b>, using just ajp13 to connect your Apache webserver
52
to the Tomcat engine, complete documentation is available in <a href="workers.html">Workers HowTo</a>.
57
# Define 1 real worker using ajp13
59
# Set properties for worker1 (ajp13)
60
worker.worker1.type=ajp13
61
worker.worker1.host=localhost
62
worker.worker1.port=8009
63
worker.worker1.lbfactor=50
64
worker.worker1.cachesize=10
65
worker.worker1.cache_timeout=600
66
worker.worker1.socket_keepalive=1
67
worker.worker1.reclycle_timeout=300
73
<section name="Minimum Apache WebServer configuration">
75
Here is a minimun informations about Apache configuration, a
76
complete documentation is available in <a href="apache.html">Apache HowTo</a>.
79
You should first have <b>mod_jk.so</b> (unix) or <b>mod_jk.dll</b> (Windows) installed
80
in your Apache module directory (see your Apache documentation to locate it).
83
Usual locations for modules directory on Unix:
85
<li>/usr/lib/apache/</li>
86
<li>/usr/lib/apache2/</li>
87
<li>/usr/local/apache/libexec/</li>
91
Usual locations for modules directory on Windows :
93
<li>C:\Program Files\Apache Group\Apache\modules\</li>
94
<li>C:\Program Files\Apache Group\Apache2\modules\</li>
98
You'll find prebuilt binaries <a href="http://jakarta.apache.org/site/binindex.cgi/">here</a>
101
Here is the minimum which should be set in <b>httpd.conf</b> directly or
102
included from another file:
105
Usual locations for configuration directory on Unix:
107
<li>/etc/httpd/conf/</li>
108
<li>/etc/httpd2/conf/</li>
109
<li>/usr/local/apache/conf/</li>
113
Usual locations for configuration directory on Windows :
115
<li>C:\Program Files\Apache Group\Apache\conf\</li>
116
<li>C:\Program Files\Apache Group\Apache2\conf\</li>
123
# Update this path to match your modules location
124
LoadModule jk_module libexec/mod_jk.so
125
# Declare the module for <IfModule directive> (remove this line on Apache 2.x)
127
# Where to find workers.properties
128
# Update this path to match your conf directory location (put workers.properties next to httpd.conf)
129
JkWorkersFile /etc/httpd/conf/workers.properties
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]
135
# Select the log format
136
JkLogStampFormat "[%a %b %d %H:%M:%S %Y] "
137
# JkOptions indicate to send SSL KEY SIZE,
138
JkOptions +ForwardKeySize +ForwardURICompat -ForwardDirectories
139
# JkRequestLogFormat set the request format
140
JkRequestLogFormat "%w %V %T"
141
# Send everything for context /examples to worker named worker1 (ajp13)
142
JkMount /examples/* worker1
148
<section name="Minimum Domino WebServer configuration">
150
A complete documentation is available in <a href="domino.html">Domino HowTo</a>.
152
More informations to be added!
157
<section name="Minimum IIS WebServer configuration">
159
A complete documentation is available in <a href="iis.html">IIS HowTo</a>.
162
More informations to be added!
166
<section name="Minimum NES/iPlanet WebServer configuration">
168
A complete documentation is available in <a href="nes.html">Netscape/iPlanet HowTo</a>.
170
More informations to be added?
176
<section name="Test your configuration">
178
(Re)start the Web server and browse to the <a href="http://localhost/examples/">http://localhost/examples/</a>