You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by cs...@apache.org on 2018/12/14 17:45:50 UTC
svn commit: r1848964 [15/25] - in /tomcat/site/trunk/docs/connectors-doc: ./
ajp/ ajp/printer/ common_howto/ common_howto/printer/ images/ images/fonts/
miscellaneous/ miscellaneous/printer/ news/ news/printer/ printer/
reference/ reference/printer/ we...
Modified: tomcat/site/trunk/docs/connectors-doc/reference/apache.html
URL: http://svn.apache.org/viewvc/tomcat/site/trunk/docs/connectors-doc/reference/apache.html?rev=1848964&r1=1848963&r2=1848964&view=diff
==============================================================================
--- tomcat/site/trunk/docs/connectors-doc/reference/apache.html (original)
+++ tomcat/site/trunk/docs/connectors-doc/reference/apache.html Fri Dec 14 17:45:49 2018
@@ -1,5 +1,35 @@
-<html><head><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>The Apache Tomcat Connectors - Reference Guide - Configuring mod_jk for the Apache HTTP Server</title><meta name="author" value="Mladen Turk"><meta name="email" value="mturk@apache.org"><link href="../style.css" type="text/css" rel="stylesheet"></head><body bgcolor="#ffffff" text="#000000" link="#525D76" alink="#525D76" vlink="#525D76"><table border="0" width="100%" cellspacing="4"><!--PAGE HEADER--><tr><td colspan="2"><!--TOMCAT LOGO--><a href="http://tomcat.apache.org/"><img src="../images/tomcat.gif" align="left" alt="Apache Tomcat" border="0"></a><!--APACHE LOGO--><a href="http://www.apache.org/"><img src="http://www.apache.org/images/asf-logo.gif" align="right" alt=" :: Apache Software Foundation" border="0"></a></td></tr><!--HEADER SEPARATOR--><tr><td colspan="2"><hr noshade size="1"></td></tr><tr><!--LEFT SIDE NAVIGATION--><td width="20%" valign="top" nowrap="true"><p><strong>Links</str
ong></p><ul><li><a href="../index.html">Docs Home</a></li></ul><p><strong>Common HowTo</strong></p><ul><li><a href="../common_howto/quick.html">For the impatient</a></li><li><a href="../common_howto/workers.html">All about workers</a></li><li><a href="../common_howto/timeouts.html">Timeouts</a></li><li><a href="../common_howto/loadbalancers.html">Load Balancing</a></li><li><a href="../common_howto/proxy.html">Reverse Proxy</a></li></ul><p><strong>Web Server HowTo</strong></p><ul><li><a href="../webserver_howto/apache.html">Apache HTTP Server (mod_jk)</a></li><li><a href="../webserver_howto/iis.html">Microsoft IIS (ISAPI redirector)</a></li><li><a href="../webserver_howto/nes.html">iPlanet Web Server (NSAPI redirector)</a></li></ul><p><strong>Reference Guide</strong></p><ul><li><a href="../reference/workers.html">workers.properties</a></li><li><a href="../reference/uriworkermap.html">uriworkermap.properties</a></li><li><a href="../reference/status.html">Status Worker</a></li><li><a h
ref="../reference/apache.html">Apache HTTP Server (mod_jk)</a></li><li><a href="../reference/iis.html">Microsoft IIS (ISAPI redirector)</a></li></ul><p><strong>AJP Protocol Reference</strong></p><ul><li><a href="../ajp/ajpv13a.html">AJPv13 (ajp13)</a></li><li><a href="../ajp/ajpv13ext.html">AJPv13 Extension Proposal</a></li></ul><p><strong>Miscellaneous Documentation</strong></p><ul><li><a href="../miscellaneous/faq.html">Frequently asked questions</a></li><li><a href="../miscellaneous/changelog.html">Changelog</a></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=">Current Tomcat Connectors bugs</a></li><li><a href="../miscellaneous/doccontrib.html">Contribute documentation</a></li><li><a href="../miscellaneous/jkstatustasks.html">JK Status Ant Tasks</a></li><li><a href="../miscellaneous/reporttools.html">Reporting Tools</a></li><li><a href="http://tomcat.apache.org/connectors-doc-archive/jk2/index.html">Old JK/JK2 documentation</a></li></ul><p><strong>News</strong></p><ul><li><a href="../news/20180301.html">2018</a></li><li><a href="../news/20150901.html">2016</a></li><li><a href="../news/20150101.html">2015</a></li><li><a href="../news/20140201.html">2014</a></li><li><a href="../news/20120301.html">2012</a></li><li><a href="../news/20110701.html">2011</a></li><li><a href="../news/2
0100101.html">2010</a></li><li><a href="../news/20090301.html">2009</a></li><li><a href="../news/20081001.html">2008</a></li><li><a href="../news/20070301.html">2007</a></li><li><a href="../news/20060101.html">2006</a></li><li><a href="../news/20050101.html">2005</a></li><li><a href="../news/20041100.html">2004</a></li></ul></td><!--RIGHT SIDE MAIN BODY--><td width="80%" valign="top" align="left"><table border="0" width="100%" cellspacing="4"><tr><td align="left" valign="top"><h1>The Apache Tomcat Connectors - Reference Guide</h1><h2>Configuring mod_jk for the Apache HTTP Server</h2></td><td align="right" valign="top" nowrap="true"><small><a href="printer/apache.html"><img src="../images/printer.gif" border="0" alt="Printer Friendly Version"><br>print-friendly<br>version
- </a></small></td></tr></table><table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Configuration Directives"><strong>Configuration Directives</strong></a></font></td></tr><tr><td><blockquote>
+<!DOCTYPE html SYSTEM "about:legacy-compat">
+<html lang="en"><head><META http-equiv="Content-Type" content="text/html; charset=UTF-8"><link href="../images/docs-stylesheet.css" rel="stylesheet" type="text/css"><title>The Apache Tomcat Connectors: mod_jk, ISAPI redirector, NSAPI redirector (1.2.x) - Configuring mod_jk for the Apache HTTP Server</title><meta name="author" content="Mladen Turk"><script type="application/javascript" data-comments-identifier="">
+ "use strict"; // Enable strict mode
+
+ (function() {
+ var thisScript = document.currentScript;
+ if (!thisScript) { // Workaround for IE <= 11
+ var scripts = document.getElementsByTagName("script");
+ thisScript = scripts[scripts.length - 1];
+ }
+ document.addEventListener("DOMContentLoaded", (function() {
+ var commentsDiv = document.getElementById("comments_thread");
+ var commentsShortname = "tomcat";
+ var commentsIdentifier = "https://tomcat.apache.org/" +
+ thisScript.getAttribute("data-comments-identifier") + ".html";
+
+ (function(w, d) {
+ if (w.location.hostname.toLowerCase() == "tomcat.apache.org") {
+ var s = d.createElement("script");
+ s.type = "application/javascript";
+ s.async = true;
+ s.src = "https://comments.apache.org/show_comments.lua?site=" +
+ encodeURIComponent(commentsShortname) +
+ "&page=" + encodeURIComponent(commentsIdentifier);
+ d.head.appendChild(s);
+ } else {
+ commentsDiv.appendChild(d.createTextNode("Comments are disabled for this page at the moment."));
+ }
+ })(window, document);
+ }), false);
+ })();
+ </script></head><body><div id="wrapper"><header><div id="header"><div><div><div class="logo noPrint"><a href="http://tomcat.apache.org/"><img alt="Tomcat Home" src="../images/tomcat.png"></a></div><div style="height: 1px;"></div><div class="asfLogo noPrint"><a href="https://www.apache.org/" target="_blank"><img src="../images/asf-logo.svg" alt="The Apache Software Foundation" style="width: 266px; height: 83px;"></a></div><h1>The Apache Tomcat Connectors: mod_jk, ISAPI redirector, NSAPI redirector</h1><div style="height: 1px;"></div><div style="clear: left;"></div></div></div></div></header><div id="middle"><div><div id="mainLeft" class="noprint"><div><nav><div><h2>Links</h2><ul><li><a href="index.html">Docs Home</a></li></ul></div><div><h2>Common HowTo</h2><ul><li><a href="common_howto/quick.html">For the impatient</a></li><li><a href="common_howto/workers.html">All about workers</a></li><li><a href="common_howto/timeouts.html">Timeouts</a></li><li><a href="common_howto/loadbalanc
ers.html">Load Balancing</a></li><li><a href="common_howto/proxy.html">Reverse Proxy</a></li></ul></div><div><h2>Web Server HowTo</h2><ul><li><a href="webserver_howto/apache.html">Apache HTTP Server (mod_jk)</a></li><li><a href="webserver_howto/iis.html">Microsoft IIS (ISAPI redirector)</a></li><li><a href="webserver_howto/nes.html">iPlanet Web Server (NSAPI redirector)</a></li></ul></div><div><h2>Reference Guide</h2><ul><li><a href="reference/workers.html">workers.properties</a></li><li><a href="reference/uriworkermap.html">uriworkermap.properties</a></li><li><a href="reference/status.html">Status Worker</a></li><li><a href="reference/apache.html">Apache HTTP Server (mod_jk)</a></li><li><a href="reference/iis.html">Microsoft IIS (ISAPI redirector)</a></li></ul></div><div><h2>AJP Protocol Reference</h2><ul><li><a href="ajp/ajpv13a.html">AJPv13 (ajp13)</a></li><li><a href="ajp/ajpv13ext.html">AJPv13 Extension Proposal</a></li></ul></div><div><h2>Miscellaneous Documentation</h2><ul><l
i><a href="miscellaneous/faq.html">Frequently asked questions</a></li><li><a href="miscellaneous/changelog.html">Changelog</a></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=">Current Tomcat Connectors bugs</a></li><li><a href="miscellaneous/doccontrib.html">Contribute documentation</a></li><li><a href="
miscellaneous/jkstatustasks.html">JK Status Ant Tasks</a></li><li><a href="miscellaneous/reporttools.html">Reporting Tools</a></li><li><a href="http://tomcat.apache.org/connectors-doc-archive/jk2/index.html">Old JK/JK2 documentation</a></li></ul></div><div><h2>News</h2><ul><li><a href="news/20180301.html">2018</a></li><li><a href="news/20160901.html">2016</a></li><li><a href="news/20150101.html">2015</a></li><li><a href="news/20140201.html">2014</a></li><li><a href="news/20120301.html">2012</a></li><li><a href="news/20110701.html">2011</a></li><li><a href="news/20100101.html">2010</a></li><li><a href="news/20090301.html">2009</a></li><li><a href="news/20081001.html">2008</a></li><li><a href="news/20070301.html">2007</a></li><li><a href="news/20060101.html">2006</a></li><li><a href="news/20050101.html">2005</a></li><li><a href="news/20041100.html">2004</a></li></ul></div></nav></div></div><div id="mainRight"><div id="content"><h2>Configuring mod_jk for the Apache HTTP Server</h2><h3
id="Configuration_Directives">Configuration Directives</h3><div class="text">
<p>
Most of the directives are allowed once in the global part of the Apache HTTP Server
configuration and once in every <VirtualHost> elements. Exceptions from this rule are
@@ -11,12 +41,12 @@ Since version 1.2.20 they can be overwri
Exceptions from this rule are again explicitly listed in the table below.
See especially JkMountCopy.
</p>
-<p><font color="#ff0000">
-Warning: If Apache and Tomcat are configured to serve content from
+<warn>
+<strong><span style="color: red;">Warning:</span> If Apache and Tomcat are configured to serve content from
the same file system location then care must be taken to ensure that Apache is
not able to serve inappropriate content such as the contents of the WEB-INF
-directory or JSP source code.
-</font></p>
+directory or JSP source code.</strong>
+</warn>
<p>
This could occur if the Apache DocumentRoot
overlaps with a Tomcat Host's appBase or the docBase of any Context. It could
@@ -26,7 +56,11 @@ the docBase of any Context.
<p>
Here are the all directives supported by Apache:
</p>
-<table border="1" cellpadding="5"><tr><th width="20%" bgcolor="#023264"><font color="#ffffff">Directive</font></th><th width="80%" bgcolor="#023264"><font color="#ffffff">Description</font></th></tr><tr><td align="left" valign="center"><code>JkWorkersFile</code></td><td align="left" valign="center"><p>
+<table class="defaultTable"><tr><th style="width: 15%;">
+ Attribute
+ </th><th style="width: 85%;">
+ Description
+ </th></tr><tr><td><code class="attributeName">JkWorkersFile</code></td><td><p>
The name of a worker file for the Tomcat servlet containers.
<br>
This directive is only allowed once. It must be put into
@@ -35,7 +69,7 @@ the global part of the configuration.
If you don't use the JkWorkerProperty directives, then you must
define your workers with a valid JkWorkersFile. There is no default
value.
-</p></td></tr><tr><td align="left" valign="center"><code>JkWorkerProperty</code></td><td align="left" valign="center"><p>
+</p></td></tr><tr><td><code class="attributeName">JkWorkerProperty</code></td><td><p>
Enables setting worker properties inside Apache configuration file.
The syntax is the same as in the JkWorkersFile (usually workers.properties).
Simply prefix each line with "JkWorkerProperty" to put it directly into
@@ -49,7 +83,7 @@ define your workers with a valid JkWorke
value.
<br>
This directive is available in jk1.2.7 version and later.
-</p></td></tr><tr><td align="left" valign="center"><code>JkShmFile</code></td><td align="left" valign="center"><p>
+</p></td></tr><tr><td><code class="attributeName">JkShmFile</code></td><td><p>
Shared memory file name. Used only on unix platforms.
The shm file is used by balancer and status workers.
<br>
@@ -70,21 +104,21 @@ workers and their members. It is need in
during runtime by status workers.</li>
</ul>
</p>
-</td></tr><tr><td align="left" valign="center"><code>JkShmSize</code></td><td align="left" valign="center"><p>
+</td></tr><tr><td><code class="attributeName">JkShmSize</code></td><td><p>
Size of the shared memory file name.
<br>
This directive is only allowed once. It must be put into
the global part of the configuration.
<br>
The default value depends on the platform. It is usually less than 64KB.
-</p></td></tr><tr><td align="left" valign="center"><code>JkMountFile</code></td><td align="left" valign="center"><p>
+</p></td></tr><tr><td><code class="attributeName">JkMountFile</code></td><td><p>
File containing multiple mappings from a context to a Tomcat worker.
It is usually called uriworkermap.properties.
<br>
For inheritance rules, see: JkMountCopy.
<br>
There is no default value.
-</p></td></tr><tr><td align="left" valign="center"><code>JkMountFileReload</code></td><td align="left" valign="center"><p>
+</p></td></tr><tr><td><code class="attributeName">JkMountFileReload</code></td><td><p>
This directive configures the reload check interval in seconds.
The JkMountFile is checked periodically for changes.
A changed file gets reloaded automatically. If you set
@@ -93,7 +127,7 @@ this directive to "0", reload checking i
The default value is 60 seconds.
<br>
This directive has been added in version 1.2.20 of mod_jk.
-</p></td></tr><tr><td align="left" valign="center"><code>JkMount</code></td><td align="left" valign="center"><p>
+</p></td></tr><tr><td><code class="attributeName">JkMount</code></td><td><p>
A mount point from a context to a Tomcat worker.
<br>
This directive is allowed multiple times.
@@ -115,7 +149,7 @@ You might append rule extensions to the
The extensions are separated from the worker name by a
semicolon ";" using the same syntax as in the
uriworkermap.properties file.
-</p></td></tr><tr><td align="left" valign="center"><code>JkUnMount</code></td><td align="left" valign="center"><p>
+</p></td></tr><tr><td><code class="attributeName">JkUnMount</code></td><td><p>
An exclusion mount point from a context to a Tomcat worker.
All exclusion mounts are checked after mapping a request
to a tomcat worker. If the request maps also to an exclusion,
@@ -135,7 +169,7 @@ JkUnMount in Location is typically not t
For inheritance rules, see: JkMountCopy.
<br>
This directive is available in jk1.2.7 version and later.
-</p></td></tr><tr><td align="left" valign="center"><code>JkAutoAlias</code></td><td align="left" valign="center"><p>
+</p></td></tr><tr><td><code class="attributeName">JkAutoAlias</code></td><td><p>
Automatically Alias webapp context directories into the Apache
document space.
<br>
@@ -146,7 +180,7 @@ security constraints defined in the appl
For inheritance rules, see: JkMountCopy.
<br>
There is no default value.
-</p></td></tr><tr><td align="left" valign="center"><code>JkMountCopy</code></td><td align="left" valign="center"><p>
+</p></td></tr><tr><td><code class="attributeName">JkMountCopy</code></td><td><p>
If this directive is set to "On" in some virtual server,
the mounts from the global server will be copied to this
virtual server, more precisely all mounts defined by JkMount
@@ -165,7 +199,7 @@ server to any VirtualHost.
<br>
Starting with version 1.2.26 you can also set it to "All" in the
global virtual server. This will switch the default to On.
-</p></td></tr><tr><td align="left" valign="center"><code>JkWorkerIndicator</code></td><td align="left" valign="center"><p>
+</p></td></tr><tr><td><code class="attributeName">JkWorkerIndicator</code></td><td><p>
Name of the Apache environment variable that can be used to set worker names
in combination with SetHandler jakarta-servlet.
<br>
@@ -173,7 +207,7 @@ This directive is only allowed once per
It is allowed in the global configuration and in VirtualHost.
<br>
The default value is JK_WORKER_NAME.
-</p></td></tr><tr><td align="left" valign="center"><code>JkWatchdogInterval</code></td><td align="left" valign="center"><p>
+</p></td></tr><tr><td><code class="attributeName">JkWatchdogInterval</code></td><td><p>
This directive configures the watchdog thread interval in seconds.
The workers are maintained periodically by a background thread
running periodically every watchdog_interval seconds. Worker maintenance
@@ -181,9 +215,9 @@ checks for idle connections, corrects lo
to detect backend health status.
<br>
The maintenance only happens, if since the last maintenance at
-least <a href="workers.html"><b class="code">worker.maintain</b></a>
+least <a href="workers.html"><code>worker.maintain</code></a>
seconds have passed. So setting the JkWatchdogInterval
-much smaller than <b class="code">worker.maintain</b> is not useful.
+much smaller than <code>worker.maintain</code> is not useful.
<br>
The default value is 0 seconds, meaning the watchdog thread
will not be created, and the maintenance is done in combination
@@ -195,7 +229,7 @@ the global part of the configuration.
This directive has been added in version 1.2.27 of mod_jk.
It is available only for Apache 2.x and above using APR libraries
including thread support.
-</p></td></tr><tr><td align="left" valign="center"><code>JkLogFile</code></td><td align="left" valign="center"><p>
+</p></td></tr><tr><td><code class="attributeName">JkLogFile</code></td><td><p>
Full or server relative path to the mod_jk log file.
It will also work with pipe, by using a value of the form "| ...".
<br>
@@ -203,12 +237,12 @@ The default value is logs/mod_jk.log.
<br>
Pipes are supported for Apache 1.3 only since version 1.2.16.
The default value exists only since version 1.2.20.
-</p></td></tr><tr><td align="left" valign="center"><code>JkLogLevel</code></td><td align="left" valign="center"><p>
+</p></td></tr><tr><td><code class="attributeName">JkLogLevel</code></td><td><p>
The mod_jk log level, can be debug, info, warn
error or trace.
<br>
The default value is info.
-</p></td></tr><tr><td align="left" valign="center"><code>JkLogStampFormat</code></td><td align="left" valign="center"><p>
+</p></td></tr><tr><td><code class="attributeName">JkLogStampFormat</code></td><td><p>
The mod_jk <b>date</b> log format, using an
extended strftime syntax.
This format will be used for the time stamps in the JkLogFile.
@@ -224,19 +258,19 @@ together in the same pattern.
The default value is "[%a %b %d %H:%M:%S %Y] " and beginning
with version 1.2.24 on platforms with a gettimeofday()
function it is "[%a %b %d %H:%M:%S.%Q %Y] ".
-</p></td></tr><tr><td align="left" valign="center"><code>JkRequestLogFormat</code></td><td align="left" valign="center"><p>
+</p></td></tr><tr><td><code class="attributeName">JkRequestLogFormat</code></td><td><p>
Request log format string. See detailed description below.
<br>
There is no default value. Without defining a value, the request logging
is turned off.
-</p></td></tr><tr><td align="left" valign="center"><code>JkExtractSSL</code></td><td align="left" valign="center"><p>
+</p></td></tr><tr><td><code class="attributeName">JkExtractSSL</code></td><td><p>
Turns on SSL processing and information gathering by mod_jk
<br>
The default value is On.
<br>
In order to make SSL data available for mod_jk in Apache, you need to
-set <b class="code">SSLOptions +StdEnvVars</b>. For the certificate information you also need
-to add <b class="code">SSLOptions +ExportCertData</b>.
+set <code>SSLOptions +StdEnvVars</code>. For the certificate information you also need
+to add <code>SSLOptions +ExportCertData</code>.
</p>
<p>
Specifically, mod_jk will export the following environment variables from
@@ -246,25 +280,25 @@ to add <b class="code">SSLOptions +Expor
<table>
<tr><th>Env Var</th><th>Request Attribute Name</th><th>Type</th><th>Example</th></tr>
<tr>
- <td>SSL_CIPHER<br>(or <b class="code">JkKEYSIZEIndicator</b>)</td>
+ <td>SSL_CIPHER<br>(or <code>JkKEYSIZEIndicator</code>)</td>
<td>javax.servlet.request.cipher_suite</td>
<td>java.lang.String</td>
<td>DHE-RSA-AES256-SHA</td>
</tr>
<tr>
- <td>SSL_CIPHER_USEKEYSIZE<br>(or <b class="code">JkKEYSIZEIndicator</b>)</td>
+ <td>SSL_CIPHER_USEKEYSIZE<br>(or <code>JkKEYSIZEIndicator</code>)</td>
<td>javax.servlet.request.key_size</td>
<td>java.lang.Integer</td>
<td>256</td>
</tr>
<tr>
- <td>SSL_SESSION_ID<br>(or <b class="code">JkSESSIONIndicator</b>)</td>
+ <td>SSL_SESSION_ID<br>(or <code>JkSESSIONIndicator</code>)</td>
<td>javax.servlet.request.ssl_session</td>
<td>java.lang.String</td>
<td>905...32E (a hex string)</td>
</tr>
<tr>
- <td>SSL_CLIENT_CERT_CHAIN_<i>n</i><br>(or <b class="code">JkCERTCHAINPrefix</b><i>n</i>)</td>
+ <td>SSL_CLIENT_CERT_CHAIN_<i>n</i><br>(or <code>JkCERTCHAINPrefix</code><i>n</i>)</td>
<td>javax.servlet.request.X509Certificate</td>
<td>java.security.X509Certificate[]</td>
<td>(A chain of certs in ascending order of trust, the first one being
@@ -274,49 +308,49 @@ to add <b class="code">SSLOptions +Expor
</table>
<p>
In addition mod_jk sends the name of the SSL protocol used as a proprietary
- request attribute named <b class="code">AJP_SSL_PROTOCOL</b>. Modern Tomcat
+ request attribute named <code>AJP_SSL_PROTOCOL</code>. Modern Tomcat
versions will expose this attribute under the name
- <b class="code">org.apache.tomcat.util.net.secure_protocol_version</b>.
+ <code>org.apache.tomcat.util.net.secure_protocol_version</code>.
This feature has been added in version 1.2.41 of mod_jk. See also
JkSSLPROTOCOLIndicator.
</p>
<p>
- For all other SSL-related variables, use <b class="code">JkEnvVar</b> for each
- variable you want. Please note that, like <b class="code">JkEnvVar</b>, these
+ For all other SSL-related variables, use <code>JkEnvVar</code> for each
+ variable you want. Please note that, like <code>JkEnvVar</code>, these
variables are available from the request <i><b>attributes</b></i>, not as
environment variables or as request headers.
</p>
-</td></tr><tr><td align="left" valign="center"><code>JkHTTPSIndicator</code></td><td align="left" valign="center"><p>
+</td></tr><tr><td><code class="attributeName">JkHTTPSIndicator</code></td><td><p>
Name of the Apache environment variable that contains SSL indication.
<br>
The default value is "HTTPS".
-</p></td></tr><tr><td align="left" valign="center"><code>JkSSLPROTOCOLIndicator</code></td><td align="left" valign="center"><p>
+</p></td></tr><tr><td><code class="attributeName">JkSSLPROTOCOLIndicator</code></td><td><p>
Name of the Apache environment variable that contains the SSL protocol name.
<br>
The default value is "SSL_PROTOCOL".
<br>
This directive has been added in version 1.2.41 of mod_jk.
-</p></td></tr><tr><td align="left" valign="center"><code>JkCERTSIndicator</code></td><td align="left" valign="center"><p>
+</p></td></tr><tr><td><code class="attributeName">JkCERTSIndicator</code></td><td><p>
Name of the Apache environment variable that contains SSL client certificates.
<br>
The default value is "SSL_CLIENT_CERT".
-</p></td></tr><tr><td align="left" valign="center"><code>JkCIPHERIndicator</code></td><td align="left" valign="center"><p>
+</p></td></tr><tr><td><code class="attributeName">JkCIPHERIndicator</code></td><td><p>
Name of the Apache environment variable that contains SSL client cipher.
<br>
The default value is "SSL_CIPHER".
-</p></td></tr><tr><td align="left" valign="center"><code>JkCERTCHAINPrefix</code></td><td align="left" valign="center"><p>
+</p></td></tr><tr><td><code class="attributeName">JkCERTCHAINPrefix</code></td><td><p>
Name of the Apache environment (prefix) that contains SSL client chain certificates.
<br>
The default value is "SSL_CLIENT_CERT_CHAIN_".
-</p></td></tr><tr><td align="left" valign="center"><code>JkSESSIONIndicator</code></td><td align="left" valign="center"><p>
+</p></td></tr><tr><td><code class="attributeName">JkSESSIONIndicator</code></td><td><p>
Name of the Apache environment variable that contains SSL session.
<br>
The default value is "SSL_SESSION_ID".
-</p></td></tr><tr><td align="left" valign="center"><code>JkKEYSIZEIndicator</code></td><td align="left" valign="center"><p>
+</p></td></tr><tr><td><code class="attributeName">JkKEYSIZEIndicator</code></td><td><p>
Name of the Apache environment variable that contains SSL key size in use.
<br>
The default value is "SSL_CIPHER_USEKEYSIZE".
-</p></td></tr><tr><td align="left" valign="center"><code>JkLocalNameIndicator</code></td><td align="left" valign="center"><p>
+</p></td></tr><tr><td><code class="attributeName">JkLocalNameIndicator</code></td><td><p>
Name of the Apache environment variable which can be used to overwrite
the forwarded local name.
Use this only if you need to adjust the data (see the
@@ -325,7 +359,7 @@ Use this only if you need to adjust the
The default value is "JK_LOCAL_NAME".
<br>
This directive has been added in version 1.2.28 of mod_jk.
-</p></td></tr><tr><td align="left" valign="center"><code>JkIgnoreCLIndicator</code></td><td align="left" valign="center"><p>
+</p></td></tr><tr><td><code class="attributeName">JkIgnoreCLIndicator</code></td><td><p>
Name of the Apache environment variable which forces to
ignore an existing Content-Length request header. This can be
used to make mod_jk conpatible with mod_deflate request body
@@ -334,7 +368,7 @@ inflation (see <a href="#Advanced Enviro
The default value is "JK_IGNORE_CL".
<br>
This directive has been added in version 1.2.41 of mod_jk.
-</p></td></tr><tr><td align="left" valign="center"><code>JkLocalAddrIndicator</code></td><td align="left" valign="center"><p>
+</p></td></tr><tr><td><code class="attributeName">JkLocalAddrIndicator</code></td><td><p>
Name of the Apache environment variable which can be used to overwrite
the forwarded local IP address.
Use this only if you need to adjust the data (see the
@@ -343,7 +377,7 @@ Use this only if you need to adjust the
The default value is "JK_LOCAL_ADDR".
<br>
This directive has been added in version 1.2.41 of mod_jk.
-</p></td></tr><tr><td align="left" valign="center"><code>JkLocalPortIndicator</code></td><td align="left" valign="center"><p>
+</p></td></tr><tr><td><code class="attributeName">JkLocalPortIndicator</code></td><td><p>
Name of the Apache environment variable which can be used to overwrite
the forwarded local port.
Use this only if you need to adjust the data (see the
@@ -352,7 +386,7 @@ Use this only if you need to adjust the
The default value is "JK_LOCAL_PORT".
<br>
This directive has been added in version 1.2.28 of mod_jk.
-</p></td></tr><tr><td align="left" valign="center"><code>JkRemoteHostIndicator</code></td><td align="left" valign="center"><p>
+</p></td></tr><tr><td><code class="attributeName">JkRemoteHostIndicator</code></td><td><p>
Name of the Apache environment variable which can be used to overwrite
the forwarded remote (client) host name.
Use this only if you need to adjust the data (see the
@@ -361,7 +395,7 @@ Use this only if you need to adjust the
The default value is "JK_REMOTE_HOST".
<br>
This directive has been added in version 1.2.28 of mod_jk.
-</p></td></tr><tr><td align="left" valign="center"><code>JkRemoteAddrIndicator</code></td><td align="left" valign="center"><p>
+</p></td></tr><tr><td><code class="attributeName">JkRemoteAddrIndicator</code></td><td><p>
Name of the Apache environment variable which can be used to overwrite
the forwarded remote (client) IP address.
Use this only if you need to adjust the data (see the
@@ -370,7 +404,7 @@ Use this only if you need to adjust the
The default value is "JK_REMOTE_ADDR".
<br>
This directive has been added in version 1.2.28 of mod_jk.
-</p></td></tr><tr><td align="left" valign="center"><code>JkRemotePortIndicator</code></td><td align="left" valign="center"><p>
+</p></td></tr><tr><td><code class="attributeName">JkRemotePortIndicator</code></td><td><p>
Name of the Apache environment variable which can be used to overwrite
the forwarded remote (client) IP address.
Use this only if you need to adjust the data (see the
@@ -379,7 +413,7 @@ Use this only if you need to adjust the
The default value is "JK_REMOTE_PORT".
<br>
This directive has been added in version 1.2.32 of mod_jk.
-</p></td></tr><tr><td align="left" valign="center"><code>JkRemoteUserIndicator</code></td><td align="left" valign="center"><p>
+</p></td></tr><tr><td><code class="attributeName">JkRemoteUserIndicator</code></td><td><p>
Name of the Apache environment variable which can be used to overwrite
the forwarded user name.
Use this only if you need to adjust the data (see the
@@ -388,7 +422,7 @@ Use this only if you need to adjust the
The default value is "JK_REMOTE_USER".
<br>
This directive has been added in version 1.2.28 of mod_jk.
-</p></td></tr><tr><td align="left" valign="center"><code>JkAuthTypeIndicator</code></td><td align="left" valign="center"><p>
+</p></td></tr><tr><td><code class="attributeName">JkAuthTypeIndicator</code></td><td><p>
Name of the Apache environment variable which can be used to overwrite
the forwarded authentication type.
Use this only if you need to adjust the data (see the
@@ -397,7 +431,7 @@ Use this only if you need to adjust the
The default value is "JK_AUTH_TYPE".
<br>
This directive has been added in version 1.2.28 of mod_jk.
-</p></td></tr><tr><td align="left" valign="center"><code>JkOptions</code></td><td align="left" valign="center"><p>
+</p></td></tr><tr><td><code class="attributeName">JkOptions</code></td><td><p>
Set one of more options to configure the mod_jk module. See below for
details about this directive.
<br>
@@ -406,7 +440,7 @@ This directive can be used multiple time
The default value is "ForwardURIProxy" since version 1.2.24.
It was "ForwardURICompatUnparsed" in version 1.2.23 and
"ForwardURICompat" until version 1.2.22.
-</p></td></tr><tr><td align="left" valign="center"><code>JkEnvVar</code></td><td align="left" valign="center"><p>
+</p></td></tr><tr><td><code class="attributeName">JkEnvVar</code></td><td><p>
Adds a name and an optional default value of environment variable
that should be sent to servlet-engine as a request attribute.
If the default value is not given explicitly, the variable
@@ -425,9 +459,9 @@ send via JkEnvVar will not be listed in
Empty default values are supported since version 1.2.20.
Not sending variables with empty defaults and empty runtime value
has been introduced in version 1.2.21.
-</p></td></tr><tr><td align="left" valign="center"><code>JkStripSession</code></td><td align="left" valign="center"><p>
+</p></td></tr><tr><td><code class="attributeName">JkStripSession</code></td><td><p>
If this directive is set to On in some virtual server,
-the session IDs <b class="code">;jsessionid=...</b> will be
+the session IDs <code>;jsessionid=...</code> will be
removed for URLs which are not forwarded but instead are
handled by the local server.
<br>
@@ -438,46 +472,41 @@ The default is Off.
This directive has been introduced in version 1.2.21.
<br>With version 1.2.27 and later this directive can have optional
session ID identifier. If not specified it defaults to
-<b class="code">;jsessionid</b>.
+<code>;jsessionid</code>.
</p>
</td></tr></table>
-</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Configuration Directives Types"><strong>Configuration Directives Types</strong></a></font></td></tr><tr><td><blockquote>
+</div><h3 id="Configuration_Directives_Types">Configuration Directives Types</h3><div class="text">
<p>
We'll discuss here the mod_jk directive types.
</p>
-<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Define workers"><strong>Define workers</strong></a></font></td></tr><tr><td><blockquote>
+<div class="subsection"><h4 id="Define_workers">Define workers</h4><div class="text">
<p>
<b>JkWorkersFile</b> specify the location where mod_jk will find the workers definitions.
Take a look at <a href="workers.html">Workers documentation</a> for detailed description.
-<div class="example"><pre>
- JkWorkersFile /etc/httpd/conf/workers.properties
-</pre></div>
+<div class="codeBox"><pre><code>JkWorkersFile /etc/httpd/conf/workers.properties
+</code></pre></div>
-<br>
-<br>
</p>
-</blockquote></td></tr></table>
+</div></div>
-<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Logging"><strong>Logging</strong></a></font></td></tr><tr><td><blockquote>
+<div class="subsection"><h4 id="Logging">Logging</h4><div class="text">
<p>
<b>JkLogFile</b> specify the location where mod_jk is going to place its log file.
</p>
-<div class="example"><pre>
- JkLogFile /var/log/httpd/mod_jk.log
-</pre></div>
+<div class="codeBox"><pre><code>JkLogFile /var/log/httpd/mod_jk.log
+</code></pre></div>
<p>
Since JK 1.2.3 for Apache 2.x and JK 1.2.16 for Apache 1.3 this can also
be used for piped logging:
</p>
-<div class="example"><pre>
- JkLogFile "|/usr/bin/rotatelogs /var/log/httpd/mod_jk.log 86400"
-</pre></div>
+<div class="codeBox"><pre><code>JkLogFile "|/usr/bin/rotatelogs /var/log/httpd/mod_jk.log 86400"
+</code></pre></div>
<p>
<b>JkLogLevel</b>
@@ -502,14 +531,11 @@ set the log level between:
</li>
</ul>
-<div class="example"><pre>
- JkLogLevel info
-</pre></div>
+<div class="codeBox"><pre><code>JkLogLevel info
+</code></pre></div>
<p>
-<b class="code">info</b> should be your default selection for normal operations.
-<br>
-<br>
+<code>info</code> should be your default selection for normal operations.
</p>
<p>
@@ -517,14 +543,8 @@ set the log level between:
See above for details.
</p>
-<div class="example"><pre>
- JkLogStampFormat "[%Y-%m-%d %H:%M:%S.%Q] "
-</pre></div>
-
-<p>
-<br>
-<br>
-</p>
+<div class="codeBox"><pre><code>JkLogStampFormat "[%Y-%m-%d %H:%M:%S.%Q] "
+</code></pre></div>
<p>
You can log mod_jk information using the Apache standard module <b>mod_log_config</b>.
@@ -533,18 +553,19 @@ Most of them are are only useful in comb
</p>
<p>
-<table border="1" cellpadding="5"><tr><th width="20%" bgcolor="#023264"><font color="#ffffff">Note</font></th><th width="80%" bgcolor="#023264"><font color="#ffffff">Description</font></th></tr><tr><td align="left" valign="center"><code>JK_WORKER_NAME</code></td><td align="left" valign="center">Name of the worker selected by the URI mapping</td></tr><tr><td align="left" valign="center"><code>JK_WORKER_TYPE</code></td><td align="left" valign="center">Type of the worker selected by the URI mapping</td></tr><tr><td align="left" valign="center"><code>JK_WORKER_ROUTE</code></td><td align="left" valign="center">Actual worker name selected by the URI mapping (usually a member of the load balancer).<br>
- Before version 1.2.26 only available if JkRequestLogFormat is set.</td></tr><tr><td align="left" valign="center"><code>JK_REQUEST_DURATION</code></td><td align="left" valign="center">Request duration in seconds and microseconds.<br>
- Before version 1.2.26 only available if JkRequestLogFormat is set.</td></tr><tr><td align="left" valign="center"><code>JK_LB_FIRST_NAME</code></td><td align="left" valign="center">Load balancer: Name of the first worker tried</td></tr><tr><td align="left" valign="center"><code>JK_LB_FIRST_TYPE</code></td><td align="left" valign="center">Load balancer: Type of the first worker tried</td></tr><tr><td align="left" valign="center"><code>JK_LB_FIRST_ACCESSED</code></td><td align="left" valign="center">Load balancer: Access count for the first worker tried</td></tr><tr><td align="left" valign="center"><code>JK_LB_FIRST_SESSIONS</code></td><td align="left" valign="center">Load balancer: Count of created sessions for the first worker tried</td></tr><tr><td align="left" valign="center"><code>JK_LB_FIRST_READ</code></td><td align="left" valign="center">Load balancer: Bytes read for the first worker tried</td></tr><tr><td align="left" va
lign="center"><code>JK_LB_FIRST_TRANSFERRED</code></td><td align="left" valign="center">Load balancer: Bytes transferred for the first worker tried</td></tr><tr><td align="left" valign="center"><code>JK_LB_FIRST_ERRORS</code></td><td align="left" valign="center">Load balancer: Error count for the first worker tried</td></tr><tr><td align="left" valign="center"><code>JK_LB_FIRST_BUSY</code></td><td align="left" valign="center">Load balancer: Busy count for the first worker tried</td></tr><tr><td align="left" valign="center"><code>JK_LB_FIRST_ACTIVATION</code></td><td align="left" valign="center">Load balancer: Activation state for the first worker tried</td></tr><tr><td align="left" valign="center"><code>JK_LB_FIRST_STATE</code></td><td align="left" valign="center">Load balancer: Error state for the first worker tried</td></tr><tr><td align="left" valign="center"><code>JK_LB_LAST_NAME</code></td><td align="left" valign="center">Load balancer: Name of the last worker tried</td></tr><t
r><td align="left" valign="center"><code>JK_LB_LAST_TYPE</code></td><td align="left" valign="center">Load balancer: Type of the last worker tried</td></tr><tr><td align="left" valign="center"><code>JK_LB_LAST_ACCESSED</code></td><td align="left" valign="center">Load balancer: Access count for the last worker tried</td></tr><tr><td align="left" valign="center"><code>JK_LB_LAST_SESSIONS</code></td><td align="left" valign="center">Load balancer: Count of created sessions for the last worker tried</td></tr><tr><td align="left" valign="center"><code>JK_LB_LAST_READ</code></td><td align="left" valign="center">Load balancer: Bytes read for the last worker tried</td></tr><tr><td align="left" valign="center"><code>JK_LB_LAST_TRANSFERRED</code></td><td align="left" valign="center">Load balancer: Bytes transferred for the last worker tried</td></tr><tr><td align="left" valign="center"><code>JK_LB_LAST_ERRORS</code></td><td align="left" valign="center">Load balancer: Error count for the last wo
rker tried</td></tr><tr><td align="left" valign="center"><code>JK_LB_LAST_BUSY</code></td><td align="left" valign="center">Load balancer: Busy count for the last worker tried</td></tr><tr><td align="left" valign="center"><code>JK_LB_LAST_ACTIVATION</code></td><td align="left" valign="center">Load balancer: Activation state for the last worker tried</td></tr><tr><td align="left" valign="center"><code>JK_LB_LAST_STATE</code></td><td align="left" valign="center">Load balancer: Error state for the last worker tried</td></tr></table>
-
-<div class="example"><pre>
- LogFormat "%h %l %u %t \"%r\" %>s %b %{JK_WORKER_NAME}n %{JK_LB_FIRST_NAME}n \
- %{JK_LB_FIRST_BUSY}n %{JK_LB_LAST_NAME}n %{JK_LB_LAST_BUSY}n" mod_jk_log
- CustomLog logs/access_log mod_jk_log
-</pre></div>
+<table class="defaultTable"><tr><th style="width: 15%;">
+ Attribute
+ </th><th style="width: 85%;">
+ Description
+ </th></tr><tr><td><code class="attributeName">JK_WORKER_NAME</code></td><td>Name of the worker selected by the URI mapping</td></tr><tr><td><code class="attributeName">JK_WORKER_TYPE</code></td><td>Type of the worker selected by the URI mapping</td></tr><tr><td><code class="attributeName">JK_WORKER_ROUTE</code></td><td>Actual worker name selected by the URI mapping (usually a member of the load balancer).<br>
+ Before version 1.2.26 only available if JkRequestLogFormat is set.</td></tr><tr><td><code class="attributeName">JK_REQUEST_DURATION</code></td><td>Request duration in seconds and microseconds.<br>
+ Before version 1.2.26 only available if JkRequestLogFormat is set.</td></tr><tr><td><code class="attributeName">JK_LB_FIRST_NAME</code></td><td>Load balancer: Name of the first worker tried</td></tr><tr><td><code class="attributeName">JK_LB_FIRST_TYPE</code></td><td>Load balancer: Type of the first worker tried</td></tr><tr><td><code class="attributeName">JK_LB_FIRST_ACCESSED</code></td><td>Load balancer: Access count for the first worker tried</td></tr><tr><td><code class="attributeName">JK_LB_FIRST_SESSIONS</code></td><td>Load balancer: Count of created sessions for the first worker tried</td></tr><tr><td><code class="attributeName">JK_LB_FIRST_READ</code></td><td>Load balancer: Bytes read for the first worker tried</td></tr><tr><td><code class="attributeName">JK_LB_FIRST_TRANSFERRED</code></td><td>Load balancer: Bytes transferred for the first worker tried</td></tr><tr><td><code class="attributeName">JK_LB_FIRST_ERRORS</cod
e></td><td>Load balancer: Error count for the first worker tried</td></tr><tr><td><code class="attributeName">JK_LB_FIRST_BUSY</code></td><td>Load balancer: Busy count for the first worker tried</td></tr><tr><td><code class="attributeName">JK_LB_FIRST_ACTIVATION</code></td><td>Load balancer: Activation state for the first worker tried</td></tr><tr><td><code class="attributeName">JK_LB_FIRST_STATE</code></td><td>Load balancer: Error state for the first worker tried</td></tr><tr><td><code class="attributeName">JK_LB_LAST_NAME</code></td><td>Load balancer: Name of the last worker tried</td></tr><tr><td><code class="attributeName">JK_LB_LAST_TYPE</code></td><td>Load balancer: Type of the last worker tried</td></tr><tr><td><code class="attributeName">JK_LB_LAST_ACCESSED</code></td><td>Load balancer: Access count for the last worker tried</td></tr><tr><td><code class="attributeName">JK_LB_LAST_SESSIONS</code></td><td>Load balancer: Count of created sessions for the last worker tried</td><
/tr><tr><td><code class="attributeName">JK_LB_LAST_READ</code></td><td>Load balancer: Bytes read for the last worker tried</td></tr><tr><td><code class="attributeName">JK_LB_LAST_TRANSFERRED</code></td><td>Load balancer: Bytes transferred for the last worker tried</td></tr><tr><td><code class="attributeName">JK_LB_LAST_ERRORS</code></td><td>Load balancer: Error count for the last worker tried</td></tr><tr><td><code class="attributeName">JK_LB_LAST_BUSY</code></td><td>Load balancer: Busy count for the last worker tried</td></tr><tr><td><code class="attributeName">JK_LB_LAST_ACTIVATION</code></td><td>Load balancer: Activation state for the last worker tried</td></tr><tr><td><code class="attributeName">JK_LB_LAST_STATE</code></td><td>Load balancer: Error state for the last worker tried</td></tr></table>
+
+<div class="codeBox"><pre><code>LogFormat "%h %l %u %t \"%r\" %>s %b %{JK_WORKER_NAME}n %{JK_LB_FIRST_NAME}n \
+ %{JK_LB_FIRST_BUSY}n %{JK_LB_LAST_NAME}n %{JK_LB_LAST_BUSY}n" mod_jk_log
+CustomLog logs/access_log mod_jk_log
+</code></pre></div>
-<br>
-<br>
</p>
<p>
@@ -558,24 +579,23 @@ here is a list of the available request
</p>
<p>
-<table border="1" cellpadding="5"><tr><th width="20%" bgcolor="#023264"><font color="#ffffff">Options</font></th><th width="80%" bgcolor="#023264"><font color="#ffffff">Description</font></th></tr><tr><td align="left" valign="center"><code>%b</code></td><td align="left" valign="center">Bytes sent, excluding HTTP headers (CLF format)</td></tr><tr><td align="left" valign="center"><code>%B</code></td><td align="left" valign="center">Bytes sent, excluding HTTP headers</td></tr><tr><td align="left" valign="center"><code>%H</code></td><td align="left" valign="center">The request protocol</td></tr><tr><td align="left" valign="center"><code>%m</code></td><td align="left" valign="center">The request method</td></tr><tr><td align="left" valign="center"><code>%p</code></td><td align="left" valign="center">The canonical Port of the server serving the request</td></tr><tr><td align="left" valign="center"><code>%q</code></td><td align="left" valign="center">The query string (prepended with a ? if
a query string exists, otherwise an empty string)</td></tr><tr><td align="left" valign="center"><code>%r</code></td><td align="left" valign="center">First line of request</td></tr><tr><td align="left" valign="center"><code>%s</code></td><td align="left" valign="center">Request HTTP status code</td></tr><tr><td align="left" valign="center"><code>%T</code></td><td align="left" valign="center">Request duration, elapsed time to handle request in seconds '.' micro seconds</td></tr><tr><td align="left" valign="center"><code>%U</code></td><td align="left" valign="center">The URL path requested, not including any query string.</td></tr><tr><td align="left" valign="center"><code>%v</code></td><td align="left" valign="center">The canonical ServerName of the server serving the request</td></tr><tr><td align="left" valign="center"><code>%V</code></td><td align="left" valign="center">The server name according to the UseCanonicalName setting</td></tr><tr><td align="left" valign="center"><code>%w
</code></td><td align="left" valign="center">Tomcat worker name</td></tr><tr><td align="left" valign="center"><code>%R</code></td><td align="left" valign="center">Real worker name</td></tr></table>
+<table class="defaultTable"><tr><th style="width: 15%;">
+ Attribute
+ </th><th style="width: 85%;">
+ Description
+ </th></tr><tr><td><code class="attributeName">%b</code></td><td>Bytes sent, excluding HTTP headers (CLF format)</td></tr><tr><td><code class="attributeName">%B</code></td><td>Bytes sent, excluding HTTP headers</td></tr><tr><td><code class="attributeName">%H</code></td><td>The request protocol</td></tr><tr><td><code class="attributeName">%m</code></td><td>The request method</td></tr><tr><td><code class="attributeName">%p</code></td><td>The canonical Port of the server serving the request</td></tr><tr><td><code class="attributeName">%q</code></td><td>The query string (prepended with a ? if a query string exists, otherwise an empty string)</td></tr><tr><td><code class="attributeName">%r</code></td><td>First line of request</td></tr><tr><td><code class="attributeName">%s</code></td><td>Request HTTP status code</td></tr><tr><td><code class="attributeName">%T</code></td><td>Request duration, elapsed time to handle request in seconds '.' micro seconds</td></tr><tr><td><code class="
attributeName">%U</code></td><td>The URL path requested, not including any query string.</td></tr><tr><td><code class="attributeName">%v</code></td><td>The canonical ServerName of the server serving the request</td></tr><tr><td><code class="attributeName">%V</code></td><td>The server name according to the UseCanonicalName setting</td></tr><tr><td><code class="attributeName">%w</code></td><td>Tomcat worker name</td></tr><tr><td><code class="attributeName">%R</code></td><td>Real worker name</td></tr></table>
-<div class="example"><pre>
- JkRequestLogFormat "%w %V %T"
-</pre></div>
+<div class="codeBox"><pre><code>JkRequestLogFormat "%w %V %T"
+</code></pre></div>
-<br>
-<br>
</p>
-</blockquote></td></tr></table>
+</div></div>
-<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Forwarding"><strong>Forwarding</strong></a></font></td></tr><tr><td><blockquote>
+<div class="subsection"><h4 id="Forwarding">Forwarding</h4><div class="text">
<p>
The directive JkOptions allow you to set many forwarding options which will enable (+)
or disable (-) following option. Without any leading signs, options will be enabled.
-<br>
-<br>
</p>
<p>
@@ -587,8 +607,6 @@ It was "ForwardURICompatUnparsed" in ver
You can turn the default off by switching on one of the other two options.
You should leave this at it's default value, unless you have a very good
reason to change it.
-<br>
-<br>
</p>
<p>
@@ -596,10 +614,7 @@ All options are inherited from the globa
Options that support enabling (plus options) and disabling (minus options),
are inherited in the following way:
<br>
-<br>
options(vhost) = plus_options(global) - minus_options(global) + plus_options(vhost) - minus_options(vhost)
-<br>
-<br>
</p>
<p>
@@ -608,12 +623,9 @@ will be partially reencoded after proces
before forwarding to Tomcat. This will be compatible with local
URL manipulation by mod_rewrite and with URL encoded session ids.
-<div class="example"><pre>
- JkOptions +ForwardURIProxy
-</pre></div>
+<div class="codeBox"><pre><code>JkOptions +ForwardURIProxy
+</code></pre></div>
-<br>
-<br>
</p>
<p>
@@ -623,12 +635,9 @@ It will always forward the original requ
URIs with mod_rewrite and then forwarding the rewritten URI
will not work.
-<div class="example"><pre>
- JkOptions +ForwardURICompatUnparsed
-</pre></div>
+<div class="codeBox"><pre><code>JkOptions +ForwardURICompatUnparsed
+</code></pre></div>
-<br>
-<br>
</p>
<p>
@@ -639,12 +648,9 @@ This is less spec compliant and is <b>no
prefix JkMount. This option will allow to rewrite URIs with
mod_rewrite before forwarding.
-<div class="example"><pre>
- JkOptions +ForwardURICompat
-</pre></div>
+<div class="codeBox"><pre><code>JkOptions +ForwardURICompat
+</code></pre></div>
-<br>
-<br>
</p>
<p>
@@ -654,20 +660,15 @@ Explicit path components like ".." will
This will not work in combination with URL encoded session IDs,
but it will allow to rewrite URIs with mod_rewrite before forwarding.
-<div class="example"><pre>
- JkOptions +ForwardURIEscaped
-</pre></div>
+<div class="codeBox"><pre><code>JkOptions +ForwardURIEscaped
+</code></pre></div>
-<br>
-<br>
</p>
<p>
JkOptions <b>RejectUnsafeURI</b> will block all
URLs, which contain percent signs '%' or backslashes '\'
after decoding.
-<br>
-<br>
</p>
<p>
Most web apps do not use such URLs. Using the option RejectUnsafeURI, you
@@ -678,12 +679,9 @@ is not set.
You can also realise such a check with mod_rewrite, which is more powerful
but also slightly more complicated.
-<div class="example"><pre>
- JkOptions +RejectUnsafeURI
-</pre></div>
+<div class="codeBox"><pre><code>JkOptions +RejectUnsafeURI
+</code></pre></div>
-<br>
-<br>
</p>
<p>
@@ -705,8 +703,6 @@ ignored if used.
JkOptions <b>ForwardDirectories</b> is used in conjunction with <b>DirectoryIndex</b>
directive of Apache. As such mod_dir should be available to Apache,
statically or dynamically (DSO)
-<br>
-<br>
</p>
<p>
@@ -718,7 +714,7 @@ local file that matches (this is done by
<p>
If ForwardDirectories is set to <b>false</b> (default) and Apache doesn't find any
files that match, Apache will serve the content of the directory (if directive
-Options specifies Indexes for that directory) or a <b class="code">403 Forbidden</b> response (if
+Options specifies Indexes for that directory) or a <code>403 Forbidden</code> response (if
directive Options doesn't specify Indexes for that directory).
</p>
@@ -735,11 +731,8 @@ ones visible only to Tomcat (i.e. if Apa
that's going to get served). This is important if there is more then one type of
file that Tomcat normally serves - for instance Velocity pages and JSP pages.
-<div class="example"><pre>
- JkOptions +ForwardDirectories
-</pre></div>
-<br>
-<br>
+<div class="codeBox"><pre><code>JkOptions +ForwardDirectories
+</code></pre></div>
</p>
<p>
@@ -748,11 +741,8 @@ of the Apache HTTP Server instead remote
Tomcat remote address valve for allowing connections only from configured Apache
servers.
-<div class="example"><pre>
- JkOptions +ForwardLocalAddress
-</pre></div>
-<br>
-<br>
+<div class="codeBox"><pre><code>JkOptions +ForwardLocalAddress
+</code></pre></div>
</p>
<p>
@@ -760,13 +750,10 @@ Setting JkOptions <b>ForwardPhysicalAddr
physical peer TCP IP address as the client address. By default mod_jk
uses the logical address as provided by the web server. For example the module
mod_remoteip sets the logical IP address to the client IP forwarded by proxies
-in the <b class="code">X-Forwarded-For</b> header.
+in the <code>X-Forwarded-For</code> header.
-<div class="example"><pre>
- JkOptions +ForwardPhysicalAddress
-</pre></div>
-<br>
-<br>
+<div class="codeBox"><pre><code>JkOptions +ForwardPhysicalAddress
+</code></pre></div>
</p>
<p>
@@ -776,24 +763,18 @@ a strong performance penalty for Apache
more often than would normally be required (ie: at the end of each
response).
-<div class="example"><pre>
- JkOptions +FlushPackets
-</pre></div>
+<div class="codeBox"><pre><code>JkOptions +FlushPackets
+</code></pre></div>
-<br>
-<br>
</p>
<p>
JkOptions <b>FlushHeader</b>, you ask mod_jk to flush Apache's connection
buffer after the response headers have been received from Tomcat.
-<div class="example"><pre>
- JkOptions +FlushHeader
-</pre></div>
+<div class="codeBox"><pre><code>JkOptions +FlushHeader
+</code></pre></div>
-<br>
-<br>
</p>
<p>
@@ -809,12 +790,9 @@ If a firewall between Apache and Tomcat
try to use the worker attribute socket_keepalive in combination with an appropriate
TCP keepalive value in your OS.
-<div class="example"><pre>
- JkOptions +DisableReuse
-</pre></div>
+<div class="codeBox"><pre><code>JkOptions +DisableReuse
+</code></pre></div>
-<br>
-<br>
</p>
<p>
@@ -822,31 +800,25 @@ JkOptions <b>ForwardKeySize</b>, you ask
required by Servlet API 2.3.
This flag shouldn't be set when servlet engine is Tomcat 3.2.x (on by default).
-<div class="example"><pre>
- JkOptions +ForwardKeySize
-</pre></div>
+<div class="codeBox"><pre><code>JkOptions +ForwardKeySize
+</code></pre></div>
-<br>
-<br>
</p>
<p>
JkOptions <b>ForwardSSLCertChain</b>, you ask mod_jk, when using ajp13,
to forward SSL certificate chain (off by default).
-Mod_jk only passes the <b class="code">SSL_CLIENT_CERT</b> to the AJP connector. This is not a
+Mod_jk only passes the <code>SSL_CLIENT_CERT</code> to the AJP connector. This is not a
problem with self-signed certificates or certificates directly signed by the
root CA certificate. However, there's a large number of certificates signed by
an intermediate CA certificate, where this is a significant problem: A servlet
will not have the possibility to validate the client certificate on its own. The
-bug would be fixed by passing on the <b class="code">SSL_CLIENT_CERT_CHAIN</b> to Tomcat via the AJP connector.
+bug would be fixed by passing on the <code>SSL_CLIENT_CERT_CHAIN</code> to Tomcat via the AJP connector.
<br>
This directive exists only since version 1.2.22.
-<div class="example"><pre>
- JkOptions +ForwardSSLCertChain
-</pre></div>
+<div class="codeBox"><pre><code>JkOptions +ForwardSSLCertChain
+</code></pre></div>
-<br>
-<br>
</p>
<p>
@@ -861,19 +833,15 @@ via request.getAttribute(attributeName).
Note that the variables send via JkEnvVar will not be listed
in request.getAttributeNames().
<br>
-<br>
The variables are inherited from the global server to virtual hosts.
-<div class="example"><pre>
- JkEnvVar SSL_CLIENT_V_START undefined
-</pre></div>
-<br>
-<br>
+<div class="codeBox"><pre><code>JkEnvVar SSL_CLIENT_V_START undefined
+</code></pre></div>
</p>
-</blockquote></td></tr></table>
+</div></div>
-<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Assigning URLs to Tomcat"><strong>Assigning URLs to Tomcat</strong></a></font></td></tr><tr><td><blockquote>
+<div class="subsection"><h4 id="Assigning_URLs_to_Tomcat">Assigning URLs to Tomcat</h4><div class="text">
<p>
If you have created a custom or local version of mod_jk.conf-local as noted above,
you can change settings such as the workers or URL prefix.
@@ -883,18 +851,16 @@ you can change settings such as the work
In general the structure of a JkMount directive is:
</p>
-<div class="example"><pre>
- JkMount [URL prefix] [Worker name]
-</pre></div>
-
-<div class="example"><pre>
- # send all requests ending in .jsp to worker1
- JkMount /*.jsp worker1
- # send all requests ending /servlet to worker1
- JkMount /*/servlet/ worker1
- # send all requests jsp requests to files located in /otherworker will go worker2
- JkMount /otherworker/*.jsp worker2
-</pre></div>
+<div class="codeBox"><pre><code>JkMount [URL prefix] [Worker name]
+</code></pre></div>
+
+<div class="codeBox"><pre><code># send all requests ending in .jsp to worker1
+JkMount /*.jsp worker1
+# send all requests ending /servlet to worker1
+JkMount /*/servlet/ worker1
+# send all requests jsp requests to files located in /otherworker will go worker2
+JkMount /otherworker/*.jsp worker2
+</code></pre></div>
<p>
You can use the JkMount directive at the top level or inside <VirtualHost>
@@ -905,12 +871,11 @@ to a particular URL. The purpose is to b
types from mounted context. The following example mounts /servlet/*
context, but all .gif files that belongs to that context are not served.
</p>
-<div class="example"><pre>
- # send all requests ending with /servlet to worker1
- JkMount /servlet/* worker1
- # do not send requests ending with .gif to worker1
- JkUnMount /servlet/*.gif worker1
-</pre></div>
+<div class="codeBox"><pre><code># send all requests ending with /servlet to worker1
+JkMount /servlet/* worker1
+# do not send requests ending with .gif to worker1
+JkUnMount /servlet/*.gif worker1
+</code></pre></div>
<p>
JkUnMount takes precedence over JkMount directives, meaning that the JK
will first try to mount and then checks, if there is an exclusion defined by a
@@ -920,27 +885,25 @@ JkMount and in the JkUnMount are the sam
<p>
The following example will block all .gif files although there is a JkMount for them:
</p>
-<div class="example"><pre>
- # do not send requests ending with .gif to worker1
- JkUnMount /*.gif worker1
- # The .gif files will not be mounted cause JkUnMount takes
- # precedence over JkMount directive
- JkMount /servlet/*.gif worker1
-</pre></div>
+<div class="codeBox"><pre><code># do not send requests ending with .gif to worker1
+JkUnMount /*.gif worker1
+# The .gif files will not be mounted cause JkUnMount takes
+# precedence over JkMount directive
+JkMount /servlet/*.gif worker1
+</code></pre></div>
<p>
Starting with version 1.2.26 of JK you can apply a JkUnMount to any worker,
by using the star character '*' as the worker name in the JkUnMount.
More complex patterns in JkUnMount worker names are not allowed.
</p>
-<div class="example"><pre>
- # Mapping the webapps myapp1 and myapp2:
- /myapp1/*=worker1
- /myapp2/*=worker2
- # Exclude the all subdirectories static for all workers:
- !/*/static/*=*
- # Exclude some suffixes for all workers:
- !*.html=*
-</pre></div>
+<div class="codeBox"><pre><code># Mapping the webapps myapp1 and myapp2:
+/myapp1/*=worker1
+/myapp2/*=worker2
+# Exclude the all subdirectories static for all workers:
+!/*/static/*=*
+# Exclude some suffixes for all workers:
+!*.html=*
+</code></pre></div>
<p>
<b>JkAutoAlias</b> directive automatically <b>Alias</b> webapp context directories into
the Apache document space. It enables Apache to serve a static context while Tomcat
@@ -958,27 +921,25 @@ with a single path element and no versio
<li>parallel deployment (e.g. .../webapps/foo##v00.05.12)</li>
</ul>
</p>
-<div class="example"><pre>
- # enter the full path to the tomcat webapps directory
- JkAutoAlias /opt/tomcat/webapps
-</pre></div>
+<div class="codeBox"><pre><code># enter the full path to the tomcat webapps directory
+JkAutoAlias /opt/tomcat/webapps
+</code></pre></div>
<p>The following example shows how to serve a dynamic context by
Tomcat and static using Apache. The webapps directory has to
be accessible by Apache.</p>
-<div class="example"><pre>
- # enter the full path to the tomcat webapps directory
- JkAutoAlias /opt/tomcat/webapps
-
- # Mount 'examples' directory. It's physical location
- # is assumed to be in the /opt/tomcat/webapps/examples
- # ajp13w is a worker defined in the workers.properties
- JkMount /examples/* ajp13w
-
- # Unmount desired static content from examples webapp.
- # This content will be served by the Apache directly.
- JkUnMount /*.gif ajp13w
-</pre></div>
+<div class="codeBox"><pre><code># enter the full path to the tomcat webapps directory
+JkAutoAlias /opt/tomcat/webapps
+
+# Mount 'examples' directory. It's physical location
+# is assumed to be in the /opt/tomcat/webapps/examples
+# ajp13w is a worker defined in the workers.properties
+JkMount /examples/* ajp13w
+
+# Unmount desired static content from examples webapp.
+# This content will be served by the Apache directly.
+JkUnMount /*.gif ajp13w
+</code></pre></div>
<p>Note that you can have a single JkAutoAlias directive per virtual
host inside your httpd.conf
</p>
@@ -988,26 +949,24 @@ version. It is a convenient method for s
usually set inside <b>workers.propeties</b> file. The parameter for
that directive is raw line from workers.properties file.
</p>
-<div class="example"><pre>
- # Just like workers.properties but exact line is prefixed
- # with JkWorkerProperty
-
- # Minimal jk configuration
- JkWorkerProperty worker.list=ajp13w
- JkWorkerProperty worker.ajp13w.type=ajp13
- JkWorkerProperty worker.ajp13w.host=localhost
- JkWorkerProperty worker.ajp13w.port=8009
-</pre></div>
+<div class="codeBox"><pre><code># Just like workers.properties but exact line is prefixed
+# with JkWorkerProperty
+
+# Minimal jk configuration
+JkWorkerProperty worker.list=ajp13w
+JkWorkerProperty worker.ajp13w.type=ajp13
+JkWorkerProperty worker.ajp13w.host=localhost
+JkWorkerProperty worker.ajp13w.port=8009
+</code></pre></div>
<p>
<b>JkMountFile</b> is a new directive available from JK 1.2.9
version. It is used for dynamic updates of mount points at runtime.
When the mount file is changed, JK will reload it's content.
</p>
-<div class="example"><pre>
- # Load mount points
+<div class="codeBox"><pre><code># Load mount points
- JkMountFile conf/uriworkermap.properties
-</pre></div>
+JkMountFile conf/uriworkermap.properties
+</code></pre></div>
<p>If the mount point uri starts with an exclamation mark '!'
it defines an exclusion in the same way JkUnMount does.
If the mount point uri starts with minus sign '-'
@@ -1015,15 +974,14 @@ the mount point will only be disabled. A
by deleting the minus sign and waiting for the JkMountFile to reload.
An exclusion can be disabled by prefixing it with a minus sign.
</p>
-<div class="example"><pre>
- # Sample uriworkermap.properties file
+<div class="codeBox"><pre><code># Sample uriworkermap.properties file
- /examples/*=ajp13w
- # Do not map .gif files
- !/*.gif=ajp13w
- # Make jsp examples initially disabled
- -/examples/jsp/*=ajp13w
-</pre></div>
+/examples/*=ajp13w
+# Do not map .gif files
+!/*.gif=ajp13w
+# Make jsp examples initially disabled
+-/examples/jsp/*=ajp13w
+</code></pre></div>
<p>At run time you can change the content of this file. For example
removing minus signs will enable the previously disabled uri mappings.
You can add any number of new entries at runtime that reflects the newly deployed
@@ -1033,13 +991,11 @@ points within 60 second interval.
<p>
There is no way to delete entries by dynamic reloading, but you can disable or
exclude mappings.
-<br>
-<br>
</p>
-</blockquote></td></tr></table>
+</div></div>
-<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Using SetHandler and Environment Variables"><strong>Using SetHandler and Environment Variables</strong></a></font></td></tr><tr><td><blockquote>
+<div class="subsection"><h4 id="Using_SetHandler_and_Environment_Variables">Using SetHandler and Environment Variables</h4><div class="text">
<p>
Alternatively to the mod_jk specific directives, you can also use
SetHandler and environment variables to control, which requests
@@ -1073,23 +1029,22 @@ of this variable via the <b>JkWorkerIndi
You can also define exclusions from mod_jk forwards by setting the environment
variable <b>no-jk</b>.
</p>
-<div class="example"><pre>
- # Automatically map all encoded urls
- <Location *;jsessionid=>
- SetHandler jakarta-servlet
- SetEnv JK_WORKER_NAME my_worker
- </Location>
-
- # Map all subdirs to workers via naming rule
- # and exclude static content.
- <Location /apps/>
- SetHandler jakarta-servlet
- SetEnvIf REQUEST_URI ^/apps/([^/]*)/ JK_WORKER_NAME=$1
- SetEnvIf REQUEST_URI ^/apps/([^/]*)/static no-jk
- </Location>
-</pre></div>
-</blockquote></td></tr></table>
-<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Advanced Environment Variables"><strong>Advanced Environment Variables</strong></a></font></td></tr><tr><td><blockquote>
+<div class="codeBox"><pre><code># Automatically map all encoded urls
+<Location *;jsessionid=>
+ SetHandler jakarta-servlet
+ SetEnv JK_WORKER_NAME my_worker
+</Location>
+
+# Map all subdirs to workers via naming rule
+# and exclude static content.
+<Location /apps/>
+ SetHandler jakarta-servlet
+ SetEnvIf REQUEST_URI ^/apps/([^/]*)/ JK_WORKER_NAME=$1
+ SetEnvIf REQUEST_URI ^/apps/([^/]*)/static no-jk
+</Location>
+</code></pre></div>
+</div></div>
+<div class="subsection"><h4 id="Advanced_Environment_Variables">Advanced Environment Variables</h4><div class="text">
<p>
Environment variables allow to overwrite the default behaviour
of mod_jk depending on request properties like e.g. the request URI,
@@ -1167,7 +1122,19 @@ You should only set the <b>JK_IGNORE_CL<
for requests that actually need it. Unfortunately there's no way
for mod_jk to detect the need automatically.
</p>
-</blockquote></td></tr></table>
- </blockquote></td></tr></table></td></tr><!--FOOTER SEPARATOR--><tr><td colspan="2"><hr noshade size="1"></td></tr><!--PAGE FOOTER--><tr><td colspan="2"><div align="center"><font color="#525D76" size="-1"><em>
- Copyright © 1999-2018, Apache Software Foundation
- </em></font></div></td></tr></table></body></html>
\ No newline at end of file
+</div></div>
+ </div><div class="noprint"><h3 id="comments_section">
+ Comments
+ </h3><div class="text"><p class="notice"><strong>Notice:</strong> This comments section collects your suggestions
+ on improving documentation for Apache Tomcat.<br><br>
+ If you have trouble and need help, read
+ <a href="https://tomcat.apache.org/findhelp.html">Find Help</a> page
+ and ask your question on the tomcat-users
+ <a href="https://tomcat.apache.org/lists.html">mailing list</a>.
+ Do not ask such questions here. This is not a Q&A section.<br><br>
+ The Apache Comments System is explained <a href="../comments.html">here</a>.
+ Comments may be removed by our moderators if they are either
+ implemented or considered invalid/off-topic.
+ </p><div id="comments_thread"></div></div></div></div></div></div></div><footer><div id="footer">
+ Copyright © 1999-yyyy, The Apache Software Foundation
+ </div></footer></div></body></html>
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org