Quick Start HowTo

Apache Software Foundation | Jakarta Project | Apache Tomcat

## Quick Start HowTo

Introduction

This document describes the configuration files used by JK on the Web Server side for the 'impatients':

- workers.properties is a mandatory file used by the webserver and which is the same for all JK implementations (Apache/IIS/NES).
- WebServers add-ons to be set on the webserver side.

We'll give here minimum servers configuration and an example workers.properties to be able to install and check quickly your configuration.

Minimum workers.properties

Here is a minimum workers.properties , using just ajp13 to connect your Apache webserver to the Tomcat engine, complete documentation is available in Workers HowTo .

# 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`
`worker.worker1.lbfactor=50`
`worker.worker1.cachesize=10`
`worker.worker1.cache_timeout=600`
`worker.worker1.socket_keepalive=1`
`worker.worker1.socket_timeout=300`

Minimum Apache WebServer configuration

Here is a minimun informations about Apache configuration, a complete documentation is available in Apache HowTo .

You should first have mod_jk.so (unix) or mod_jk.dll (Windows) installed in your Apache module directory (see your Apache documentation to locate it).

Usual locations for modules directory on Unix:

- /usr/lib/apache/
- /usr/lib/apache2/
- /usr/local/apache/libexec/

Usual locations for modules directory on Windows :

- C:\Program Files\Apache Group\Apache\modules\
- C:\Program Files\Apache Group\Apache2\modules\

You'll find prebuilt binaries here

Here is the minimum which should be set in httpd.conf directly or included from another file:

Usual locations for configuration directory on Unix:

- /etc/httpd/conf/
- /etc/httpd2/conf/
- /usr/local/apache/conf/

Usual locations for configuration directory on Windows :

- C:\Program Files\Apache Group\Apache\conf\
- C:\Program Files\Apache Group\Apache2\conf\

# Load mod_jk module
# Update this path to match your modules location
`LoadModule jk_module libexec/mod_jk.so`
# Declare the module for <IfModule directive>
`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 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 log format
`JkLogStampFormat "[%a %b %d %H:%M:%S %Y] "`
# JkOptions indicate to send SSL KEY SIZE,
`JkOptions +ForwardKeySize +ForwardURICompat -ForwardDirectories`
# JkRequestLogFormat set the request format
`JkRequestLogFormat "%w %V %T"`
# Send everything for context /examples to worker named worker1 (ajp13)
`JkMount /examples/* worker1`

Minimum Domino WebServer configuration

A complete documentation is available in Domino HowTo .

This paragraph has not been written yet, but you can contribute to it.

Minimum IIS WebServer configuration

A complete documentation is available in IIS HowTo .

This paragraph has not been written yet, but you can contribute to it.

Minimum NES/iPlanet WebServer configuration

A complete documentation is available in Netscape/iPlanet HowTo .

This paragraph has not been written yet, but you can contribute to it.

Test your configuration

(Re)start the Web server and browse to the http://localhost/examples/