## Quick Start HowTo

### Introduction

This document describes the configuration files used by JK on the web server side for the 'impatient':

- workers.properties 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, NSAPI for the iPlanet Web Server).
- web server add-ons to be set on the web server 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 web server 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

### Minimum Apache HTTP Server configuration

Here is some very basic information about Apache configuration, a more complete HowTo for Apache is available.

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/
- /usr/local/apache/modules/

Usual locations for modules directory on Windows:

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

You'll find a link to 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  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

### Minimum Microsoft IIS configuration

A separate HowTo for the Microsoft IIS web server is available.

More information to be added!

### Minimum iPlanet Web Server configuration

A separate HowTo for the iPlanet Web Server is available. More information to be added?

### Test your configuration

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

### Comments

Notice: This comments section collects your suggestions on improving documentation for Apache Tomcat.
If you have trouble and need help, read Find Help page and ask your question on the tomcat-users mailing list. Do not ask such questions here. This is not a Q&A section.
The Apache Comments System is explained here. Comments may be removed by our moderators if they are either implemented or considered invalid/off-topic.