| <?xml version="1.0"?> |
| <!-- |
| 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. |
| --> |
| <!DOCTYPE document [ |
| <!ENTITY project SYSTEM "project.xml"> |
| ]> |
| <document url="index.html"> |
| |
| &project; |
| |
| <properties> |
| <author email="mturk@apache.org">Mladen Turk</author> |
| <author email="rjung@apache.org">Rainer Jung</author> |
| <title>Documentation Overview</title> |
| </properties> |
| |
| <body> |
| |
| <section name="Introduction"> |
| |
| <p>The <strong>Apache Tomcat Connectors</strong> project is part of the Tomcat project |
| and provides web server plugins to connect web servers with Tomcat and other backends. |
| </p> |
| <p>The supported web servers are:</p> |
| <ul> |
| <li>the Apache HTTP Server with a plugin (module) named <strong>mod_jk</strong>.</li> |
| <li>Microsoft IIS with a plugin (extension) named <strong>ISAPI redirector</strong> |
| (or simply redirector).</li> |
| <li>the iPlanet Web Server with a plugin named <strong>NSAPI redirector</strong>. The |
| iPlanet Web Server was previously known under various names, including Netscape Enterprise Server, |
| SunOne Web Server and Sun Enterprise System web server.</li> |
| </ul> |
| <p>In all cases the plugin uses a special protocol named <strong>Apache JServ Protocol</strong> |
| or simply <strong>AJP</strong> to connect to the backend. Backends known to support AJP |
| are Apache Tomcat, Jetty and JBoss. Although there exist 3 versions of the protocol, |
| <strong>ajp12</strong>, <strong>ajp13</strong>, <strong>ajp14</strong>, most installations |
| only use ajp13. The older ajp12 does not use persistent connections and is obsolete, the newer |
| version ajp14 is still experimental. Sometimes ajp13 is called AJP 1.3 or AJPv13, but we |
| will mostly use the name ajp13. |
| </p> |
| <p>Most features of the plugins are the same for all web servers. Some details vary |
| on a per web server basis. The documentation and the configuration is split into common |
| parts and web server specific parts.</p> |
| <p> |
| down to the more detailed documentation that is available. Each available |
| manual is described in more detail below.</p> |
| |
| </section> |
| |
| <section name="Headlines"> |
| <ul> |
| <li><a href="news/20180301.html#JK-1.2.43 released"><b>JK-1.2.43 released</b></a> |
| <p>The Apache Tomcat team is proud to announce the immediate availability |
| of Tomcat Connectors 1.2.43 Stable. This release contains improvements and |
| bug fixes for issues found in previous releases.</p> |
| |
| <p>Download the <a href="//tomcat.apache.org/download-connectors.cgi">JK 1.2.43 |
| release</a>.</p> |
| </li> |
| |
| <li> |
| <p>Download |
| <a href="//archive.apache.org/dist/tomcat/tomcat-connectors/">previous |
| releases</a> from the archives.</p> |
| </li> |
| |
| </ul> |
| </section> |
| |
| <section name="Reference Guide"> |
| <br /> |
| <ul> |
| <li><a href="reference/workers.html"><b>workers.properties</b></a> |
| <p>A Tomcat worker is a Tomcat instance that is waiting to execute servlets |
| on behalf of some web server. For example, we can have a web server such as Apache |
| forwarding servlet requests to a Tomcat process (the worker) running behind it. |
| </p> |
| <p>This page contains detailed description of all workers.properties |
| directives. |
| </p> |
| </li> |
| |
| <li><a href="reference/uriworkermap.html"><b>uriworkermap.properties</b></a> |
| <p> |
| The forwarding of requests from the web server to tomcat gets configured by defining mapping rules. |
| The so-called <b>uriworkermap</b> file is a mechanism of defining those rules. |
| </p> |
| </li> |
| |
| <li><a href="reference/status.html"><b>Status Worker</b></a> |
| <p> |
| The status worker is a builtin management worker. It displays state information |
| and can also be used to dynamically reconfigure JK. |
| </p> |
| </li> |
| |
| <li><a href="reference/apache.html"><b>Apache HTTP Server (mod_jk)</b></a> |
| <p>This page contains detailed description of all directives of mod_jk for the |
| Apache HTTP Server. |
| </p> |
| </li> |
| |
| <li><a href="reference/iis.html"><b>Microsoft IIS (ISAPI redirector)</b></a> |
| <p>This page contains detailed description of all directives of the ISAPI redirector for Microsoft IIS. |
| </p> |
| </li> |
| |
| </ul> |
| </section> |
| |
| <section name="Common HowTo"> |
| <br /> |
| <ul> |
| |
| <li><a href="common_howto/quick.html"><b>Quick Start</b></a> |
| <p>This page describes the configuration files used by JK on the |
| web server side for the 'impatient'. |
| </p> |
| </li> |
| <li><a href="common_howto/workers.html"><b>All about workers</b></a> |
| <p>This page contains an overview about the various aspects of defining |
| and using workers. |
| </p> |
| </li> |
| <li><a href="common_howto/timeouts.html"><b>Timeouts</b></a> |
| <p>This page describes the possible timeout settings you can use. |
| </p> |
| </li> |
| <li><a href="common_howto/loadbalancers.html"><b>Load Balancing</b></a> |
| <p>This page contains an introduction on load balancing with JK. |
| </p> |
| </li> |
| <li><a href="common_howto/proxy.html"><b>Reverse Proxy</b></a> |
| <p>This page contains an introduction to reverse proxies, how JK |
| handles this situation and how you can influence the JK proxying behaviour. |
| </p> |
| </li> |
| |
| </ul> |
| </section> |
| |
| <section name="Webserver HowTo"> |
| <br /> |
| <p>These pages contain detailed descriptions of how to build and |
| install JK for the various web servers. |
| </p> |
| <ul> |
| |
| <li><a href="webserver_howto/apache.html"><b>Apache HTTP Server (mod_jk)</b></a> |
| </li> |
| <li><a href="webserver_howto/iis.html"><b>Microsoft IIS (ISAPI redirector)</b></a> |
| </li> |
| <li><a href="webserver_howto/nes.html"><b>iPlanet Web Server (NSAPI redirector)</b></a> |
| </li> |
| |
| </ul> |
| </section> |
| |
| <section name="AJP Protocol Reference"> |
| <br /> |
| <ul> |
| <li><a href="ajp/ajpv13a.html"><b>AJPv13</b></a> |
| <p>This page describes the Apache JServ Protocol version 1.3 (hereafter |
| <b>ajp13</b>). |
| </p> |
| </li> |
| <li><a href="ajp/ajpv13ext.html"><b>AJPv13 Extension Proposal</b></a> |
| <p>This page describes an extension proposal for ajp13. |
| </p> |
| </li> |
| </ul> |
| |
| </section> |
| |
| <section name="Miscellaneous documentation"> |
| <br /> |
| <ul> |
| <li><a href="miscellaneous/faq.html"><b>Frequently asked questions</b></a> |
| <p> |
| </p> |
| </li> |
| <li><a href="miscellaneous/changelog.html"><b>Changelog</b></a> |
| <p> |
| This page contains the detailed list of all changes made in each version of JK. |
| </p> |
| </li> |
| <li><a href="http://issues.apache.org/bugzilla/buglist.cgi?query_format=advanced&short_desc_type=allwordssubstr&short_desc=&product=Tomcat+Connectors&long_desc_type=substring&long_desc=&bug_file_loc_type=allwordssubstr&bug_file_loc=&keywords_type=allwords&keywords=&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&emailassigned_to1=1&emailtype1=substring&email1=&emailassigned_to2=1&emailreporter2=1&emailcc2=1&emailtype2=substring&email2=&bugidtype=include&bug_id=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&cmdtype=doit&order=Reuse+same+sort+as+last+time&field0-0-0=noop&type0-0-0=noop&value0-0-0="> |
| <b>Current Tomcat Connectors bugs</b></a> |
| <p>This is the Bugzilla Bug List related to Tomcat Connectors. |
| </p> |
| </li> |
| <li><a href="miscellaneous/doccontrib.html"><b>Contribute documentation</b></a> |
| <p> |
| This page describes, how to contribute to the JK documentation. |
| </p> |
| </li> |
| <li><a href="miscellaneous/jkstatustasks.html"><b>JK Status Ant Tasks</b></a> |
| <p> |
| This page describes ant tasks to automate JK management via the status worker. |
| </p> |
| </li> |
| <li><a href="miscellaneous/reporttools.html"><b>Reporting Tools</b></a> |
| <p> |
| This page contains information, on some report analysis scripts contained in the JK distribution. |
| </p> |
| </li> |
| <li><a href="http://tomcat.apache.org/connectors-doc-archive/jk2/index.html"> |
| <b>Old JK/JK2 documentation archive.</b></a> |
| <p>Here you can find old JK and JK2 documentation. |
| </p> |
| </li> |
| </ul> |
| |
| </section> |
| |
| </body> |
| </document> |