rubbos/app/tomcat-connectors-1.2.32-src/docs/webserver_howto/printer/apache.html

   1 <html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>The Apache Tomcat Connector - Webserver HowTo - Apache HTTP Server HowTo</title><meta name="author" value="Henri Gomez"><meta name="email" value="hgomez@apache.org"><meta name="author" value="Gal Shachor"><meta name="email" value="shachor@il.ibm.com"><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 Logo" border="0"></a></td></tr><!--HEADER SEPARATOR--><tr><td colspan="2"><hr noshade size="1"></td></tr><tr><!--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 Connector - Webserver HowTo</h1><h2>Apache HTTP Server HowTo</h2></td><td align="right" valign="top" nowrap="true"><img src="../../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></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="Introduction"><strong>Introduction</strong></a></font></td></tr><tr><td><blockquote>
   2 <p>
   3 This document explains how to connect Tomcat to the popular open source web server, Apache httpd.
   4 There is actually three versions of Apache HTTP Server, 1.3, 2.0 and 2.2 and all can be used with mod_jk,
   5 the Tomcat redirector module.
   6 </p>
   7
   8 <p>
   9 It is recommended that you also read the
  10 <a href="../../generic_howto/workers.html">Workers HowTo</a> document
  11 to learn how to setup the working entities between your web server and Tomcat Engines.
  12 For more detailed configuration information consult the Reference Guide for
  13 <a href="../../reference/worker.html">workers.properties</a>,
  14 <a href="../../reference/uriworkermap.html">uriworkermap</a>
  15 and <a href="../../reference/apache.html">Apache</a>.
  16 </p>
  17
  18 <p><b>Waring: If Apache HTTP Server and Tomcat are configured to serve content from
  19 the same filing system location then care must be taken to ensure that httpd is
  20 not able to serve inappropriate content such as the contents of the WEB-INF
  21 directory or JSP source code.</b> This could occur if the httpd DocumentRoot
  22 overlaps with a Tomcat Host's appBase or the docBase of any Context. It could
  23 also occur when using the httpd Alias directive with a Tomcat Host's appBase or
  24 the docBase of any Context.
  25 </p>
  26
  27 <p>
  28 This document was originally part of <b>Tomcat: A Minimalistic User's Guide</b> written by Gal Shachor,
  29 but has been split off for organisational reasons.
  30 </p>
  31
  32 <table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Document Conventions and Assumptions"><strong>Document Conventions and Assumptions</strong></a></font></td></tr><tr><td><blockquote>
  33 <p>
  34 ${tomcat_home} is the root directory of tomcat.
  35 Your Tomcat installation should have the following subdirectories:
  36
  37 <ul>
  38 <li>
  39 ${tomcat_home}\conf - Where you can place various configuration files
  40 </li>
  41 <li>
  42 ${tomcat_home}\webapps - Containing example applications
  43 </li>
  44 <li>
  45 ${tomcat_home}\bin - Where you place web server plugins
  46 </li>
  47 </ul>
  48 </p>
  49 <p>
  50 In all the examples in this document ${tomcat_home} will be <b>/var/tomcat3</b>.
  51 A <a href="../../generic_howto/workers.html">worker</a> is defined to be a tomcat process that accepts work from the Apache server.
  52 </p>
  53 </blockquote></td></tr></table>
  54
  55 <table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Supported Configuration"><strong>Supported Configuration</strong></a></font></td></tr><tr><td><blockquote>
  56 <p>
  57 The mod_jk module was developed and tested on:
  58 <ul>
  59 <li>
  60 Linux, FreeBSD, AIX, HP-UX, MacOS X, Solaris and should works on major Unixes platforms
  61 supporting Apache 1.3 and/or 2.0/2.2
  62 </li>
  63 <li>
  64 WinNT4.0-i386 SP4/SP5/SP6a (should be able to work with other service packs), Win2K and WinXP and Win98
  65 </li>
  66 <li>
  67 Cygwin (until you have an apache server and autoconf/automake support tools)
  68 </li>
  69 <li>
  70 Netware
  71 </li>
  72 <li>
  73 i5/OS V5R4 (System I) with Apache HTTP Server 2.0.58. Be sure to have the latest Apache PTF installed.
  74 </li>
  75 <li>
  76 Tomcat 3.2.x, Tomcat 3.3.x, Tomcat 4.0.x, Tomcat 4.1.x, Tomcat 5.0.x, Tomcat 5.5.x and Tomcat 6.
  77 </li>
  78 </ul>
  79 </p>
  80
  81 <p>
  82 The redirector uses <b>ajp12</b> and <b>ajp13</b> to send requests to the Tomcat containers. There is also an option to use Tomcat in process,
  83 more about the in-process mode can be found in the in process howto.
  84 </p>
  85 </blockquote></td></tr></table>
  86
  87 <table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Who support ajp protocols ?"><strong>Who support ajp protocols ?</strong></a></font></td></tr><tr><td><blockquote>
  88 <p>
  89 The ajp12 protocol is only available in Tomcat 3.2.x and 3.3.x.
  90 </p>
  91
  92 <p>
  93 The <b>ajp12</b> has been <b>deprecated</b> with Tomcat 3.3.x and you should use instead
  94 <b>ajp13</b> which is the only ajp protocol known by Tomcat 4.x, 5 and 5.5 and Tomcat 6.
  95 </p>
  96
  97 <p>
  98 Of course Tomcat 3.2.x and 3.3.x also support ajp13 protocol.
  99 </p>
 100
 101 <p>
 102 Others servlet engines such as <b>jetty</b> have support for ajp13 protocol
 103 </p>
 104
 105 </blockquote></td></tr></table>
 106
 107 <table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="How does it work ?"><strong>How does it work ?</strong></a></font></td></tr><tr><td><blockquote>
 108 <p>
 109 In a nutshell a web server is waiting for client HTTP requests.
 110 When these requests arrive the server does whatever is needed to serve the
 111 requests by providing the necessary content.
 112 </p>
 113
 114 <p>
 115 Adding a servlet container may somewhat change this behaviour.
 116 Now the web server needs also to perform the following:
 117 </p>
 118
 119 <ul>
 120 <li>
 121 Load the servlet container adaptor library and initialise it (prior to serving requests).
 122 </li>
 123 <li>
 124 When a request arrives, it needs to check and see if a certain request belongs to a servlet,
 125 if so it needs to let the adaptor take the request and handle it.
 126 </li>
 127 </ul>
 128
 129 <p>
 130 The adaptor on the other hand needs to know what requests it is going to serve,
 131 usually based on some pattern in the request URL, and to where to direct these requests.
 132 </p>
 133
 134 <p>
 135 Things are even more complex when the user wants to set a configuration that uses virtual hosts,
 136 or when they want multiple developers to work on the same web server
 137 but on different servlet container JVMs.
 138 We will cover these two cases in the advanced sections.
 139 </p>
 140
 141 </blockquote></td></tr></table>
 142
 143 </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="Obtaining mod_jk"><strong>Obtaining mod_jk</strong></a></font></td></tr><tr><td><blockquote>
 144 <p>
 145 mod_jk can be obtained in two formats - binary and source.
 146 Depending on the platform you are running your web server on, a binary version of mod_jk may be available.
 147 </p>
 148
 149 <p>
 150 It is recommended to use the binary version if one is available.
 151 If the binary is not available, follow the instructions for building mod_jk from source.
 152 The mod_jk source can be downloaded from a mirror
 153 <a href="http://tomcat.apache.org/download-connectors.cgi">
 154 here</a>
 155 </p>
 156
 157 <p>
 158 The binaries for mod_jk are now available for several platforms.
 159 The binaries are located in subdirectories by platform.
 160 </p>
 161
 162 <p>
 163 For some platforms, such as Windows, this is the typical way of obtaining mod_jk
 164 since most Windows systems do not have C compilers.
 165 </p>
 166
 167 <p>
 168 For others, the binary distribution of mod_jk offers simpler installation.
 169 </p>
 170
 171 <p>
 172 For example JK 1.2.x can be downloaded from a mirror
 173 <a href="http://tomcat.apache.org/download-connectors.cgi">
 174 here</a> (look for JK 1.2 Binary Releases). The "JK 1.2 Binary Releases" link contains binary version for a variety of
 175 operating systems for both Apache 1.3 and Apache 2.
 176 </p>
 177
 178 </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="Installation"><strong>Installation</strong></a></font></td></tr><tr><td><blockquote>
 179 <p>
 180 mod_jk requires two entities:
 181
 182 <ul>
 183 <li>
 184 <b>mod_jk.xxx</b> - The Apache HTTP Server module, depending on your operating system, it will be mod_jk.so, mod_jk.nlm or
 185 or MOD_JK.SRVPGM (see the build section).
 186 </li>
 187 <li>
 188 <b>workers.properties</b> - A file that describes the host(s) and port(s) used by the workers (Tomcat processes).
 189 A sample workers.properties can be found under the conf directory in the source download.
 190 </li>
 191 </ul>
 192 </p>
 193
 194 <p>
 195 Also as with other Apache HTTP Server modules, mod_jk should be first installed on the modules directory of your
 196 Apache webserver, ie : /usr/lib/apache and you should update your <b>httpd.conf</b> file.
 197 </p>
 198
 199
 200 <table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Disabling old mod_jserv"><strong>Disabling old mod_jserv</strong></a></font></td></tr><tr><td><blockquote>
 201 <p>
 202 If you've previously configured Apache to use <b>mod_jserv</b>, remove any <b>ApJServMount</b> directives
 203 from your httpd.conf.
 204 </p>
 205
 206 <p>If you're including <b>tomcat-apache.conf</b> or <b>tomcat.conf</b>, you'll want to remove them as well -
 207 they are specific to <b>mod_jserv</b>.
 208 </p>
 209
 210 <p>
 211 The mod_jserv configuration directives are not compatible with mod_jk !
 212 </p>
 213 </blockquote></td></tr></table>
 214
 215 <table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Using Tomcat auto-configure"><strong>Using Tomcat auto-configure</strong></a></font></td></tr><tr><td><blockquote>
 216 <p>
 217 The auto-configure works only for a single Tomcat running on the same machine where Apache HTTP Server is running.
 218 The simplest way to configure Apache HTTP Server to use mod_jk is to turn on the Apache HTTP Server auto-configure setting
 219 in Tomcat and put the following include directive at the end of your Apache httpd.conf file
 220 (make sure you replace $TOMCAT_HOME with the correct path for your Tomcat installation:
 221 </p>
 222
 223 <div class="example"><pre>
 224     #To be added at the end of your httpd.conf
 225     Include $TOMCAT_HOME/conf/jk/mod_jk.conf-auto
 226 </pre></div>
 227
 228 <p>
 229 Note: this file may also be generated as $TOMCAT_HOME/conf/auto/mod_jk.conf
 230 </p>
 231
 232 <p>
 233 This will tell Apache HTTP Server to use directives in the <b>mod_jk.conf-auto</b> file in
 234 the Apache configuration. This file is created by enabling the Apache
 235 auto-configuration by creating your workers.properties file at
 236 $TOMCAT_HOME/conf/jk/workers.properties and adding the listener to the Engine
 237 element in the server.xml file as per the following example.
 238 <b>Please note that this example is specific to Tomcat 5.x, unlike other sections of this document
 239    which also apply to previous Tomcat branches.</b>
 240 </p>
 241 <div class="example"><pre>
 242   ...
 243   &lt;Engine ...&gt;
 244     ...
 245     &lt;Listener className="org.apache.jk.config.ApacheConfig" modJk="/path/to/mod_jk.so" /&gt;
 246     ...
 247   &lt;/Engine&gt;
 248   ...
 249 </pre></div>
 250
 251 <p>
 252 Then restart Tomcat and mod_jk.conf should be generated. For more information on
 253 this topic, please refer to the API documentation at the
 254 <a href="http://tomcat.apache.org/tomcat-5.5-doc/catalina/docs/api/org/apache/jk/config/ApacheConfig.html">
 255 Tomcat docs website</a>.
 256 </p>
 257
 258 </blockquote></td></tr></table>
 259
 260 <table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Custom mod_jk configuration"><strong>Custom mod_jk configuration</strong></a></font></td></tr><tr><td><blockquote>
 261 <p>
 262 You should use custom configuration when :
 263 </p>
 264 <ul>
 265 <li>
 266 You couldn't use <b>mod_jk.conf-auto</b> since Tomcat engine isn't on the same machine that your Apache web server,
 267 ie when you have an Apache in front of a Tomcat Farm.
 268 </li>
 269 <li>
 270 Another case for custom configuration is when your Apache is in front of many different Tomcat engines,
 271 each one having it's own configuration, a general case in ISP hosting
 272 </li>
 273 <li>
 274 Also all Apache webmaster will retain custom configuration to be able to tune the settings
 275 to their real needs.
 276 </li>
 277 </ul>
 278
 279 </blockquote></td></tr></table>
 280
 281 <table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Simple configuration example"><strong>Simple configuration example</strong></a></font></td></tr><tr><td><blockquote>
 282 <p>
 283 Here is a simple configuration:
 284 </p>
 285
 286 <div class="example"><pre>
 287     # Load mod_jk module
 288     LoadModule    jk_module  libexec/mod_jk.so
 289     # Declare the module for &lt;IfModule directive&gt; (remove this line on Apache 2.0.x)
 290     AddModule     mod_jk.c
 291     # Where to find workers.properties
 292     JkWorkersFile /etc/httpd/conf/workers.properties
 293     # Where to put jk shared memory
 294     JkShmFile     /var/log/httpd/mod_jk.shm
 295     # Where to put jk logs
 296     JkLogFile     /var/log/httpd/mod_jk.log
 297     # Set the jk log level [debug/error/info]
 298     JkLogLevel    info
 299     # Select the timestamp log format
 300     JkLogStampFormat "[%a %b %d %H:%M:%S %Y] "
 301     # Send servlet for context /examples to worker named worker1
 302     JkMount  /examples/servlet/* worker1
 303     # Send JSPs  for context /examples to worker named worker1
 304     JkMount  /examples/*.jsp worker1
 305 </pre></div>
 306
 307 </blockquote></td></tr></table>
 308 </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="mod_jk Directives"><strong>mod_jk Directives</strong></a></font></td></tr><tr><td><blockquote>
 309 <p>
 310 We'll discuss here the mod_jk directives and details behind them
 311 </p>
 312
 313 <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>
 314 <p>
 315 <b>JkWorkersFile</b> specify the location where mod_jk will find the workers definitions.
 316
 317 <div class="example"><pre>
 318   JkWorkersFile     /etc/httpd/conf/workers.properties
 319 </pre></div>
 320
 321 <br>
 322 <br>
 323 </p>
 324 </blockquote></td></tr></table>
 325
 326 <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>
 327 <p>
 328 <b>JkLogFile</b> specify the location where mod_jk is going to place its log file.
 329 </p>
 330
 331 <div class="example"><pre>
 332   JkLogFile     /var/log/httpd/mod_jk.log
 333 </pre></div>
 334
 335 <p>
 336 Since JK 1.2.3 for Apache 2.0/2.2 and JK 1.2.16 for Apache 1.3 this can also
 337 be used for piped logging:
 338 </p>
 339
 340 <div class="example"><pre>
 341   JkLogFile     "|/usr/bin/rotatelogs /var/log/httpd/mod_jk.log 86400"
 342 </pre></div>
 343
 344 <p>
 345 <b>JkLogLevel</b>
 346 set the log level between :
 347 </p>
 348
 349 <ul>
 350 <li>
 351 <b>info</b> log will contains standard mod_jk activity (default).
 352 </li>
 353 <li>
 354 <b>error</b> log will contains also error reports.
 355 </li>
 356 <li>
 357 <b>debug</b> log will contains all information on mod_jk activity
 358 </li>
 359 </ul>
 360
 361 <div class="example"><pre>
 362   JkLogLevel    info
 363 </pre></div>
 364
 365 <p>
 366 <b class="code">info</b> should be your default selection for normal operations.
 367 <br>
 368 <br>
 369 </p>
 370
 371 <p>
 372 <b>JkLogStampFormat</b> will configure the date/time format found on mod_jk logfile.
 373 Using the strftime() format string it's set by default to <b>"[%a %b %d %H:%M:%S %Y]"</b>
 374 </p>
 375
 376 <div class="example"><pre>
 377   JkLogStampFormat "[%a %b %d %H:%M:%S %Y] "
 378 </pre></div>
 379
 380 <p>
 381 <br>
 382 <br>
 383 </p>
 384
 385 <p>
 386 <b>JkRequestLogFormat</b> will configure the format of mod_jk individual request logging.
 387 Request logging is configured and enabled on a per virtual host basis.
 388 To enable request logging for a virtual host just add a JkRequestLogFormat config.
 389 The syntax of the format string is similar to the Apache LogFormat command,
 390 here is a list of the available request log format options:
 391 </p>
 392
 393 <p>
 394 <table>
 395   <tr><th>Options</th><th>Description</th></tr>
 396   <tr><td>%b</td><td>Bytes sent, excluding HTTP headers (CLF format)</td></tr>
 397   <tr><td>%B</td><td>Bytes sent, excluding HTTP headers</td></tr>
 398   <tr><td>%H</td><td>The request protocol</td></tr>
 399   <tr><td>%m</td><td>The request method</td></tr>
 400   <tr><td>%p</td><td>The canonical Port of the server serving the request</td></tr>
 401   <tr><td>%q</td><td>The query string (prepended with a ? if a query string exists, otherwise an empty string)</td></tr>
 402   <tr><td>%r</td><td>First line of request</td></tr>
 403   <tr><td>%s</td><td>Request HTTP status code</td></tr>
 404   <tr><td>%T</td><td>Request duration, elapsed time to handle request in seconds '.' micro seconds</td></tr>
 405   <tr><td>%U</td><td>The URL path requested, not including any query string.</td></tr>
 406   <tr><td>%v</td><td>The canonical ServerName of the server serving the request</td></tr>
 407   <tr><td>%V</td><td>The server name according to the UseCanonicalName setting</td></tr>
 408   <tr><td>%w</td><td>Tomcat worker name</td></tr>
 409   <tr><td>%R</td><td>Session route name (available with 1.2.19 and up)</td></tr>
 410 </table>
 411
 412 <div class="example"><pre>
 413   JkRequestLogFormat     "%w %V %T"
 414 </pre></div>
 415
 416 <br>
 417 <br>
 418 </p>
 419
 420 </blockquote></td></tr></table>
 421
 422 <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>
 423 <p>
 424 The directive JkOptions allow you to set many forwarding options which will enable (+)
 425 or disable (-) following option. Without any leading signs, options will be enabled.
 426 <br>
 427 <br>
 428 </p>
 429
 430 <p>
 431 The four following options <b>+ForwardURIxxx</b> are mutually exclusive.
 432 Exactly one of them is required, a negative sign prefix is not allowed with them.
 433 The default value is "ForwardURIProxy" since version 1.2.24.
 434 It was "ForwardURICompatUnparsed" in version 1.2.23 and
 435 "ForwardURICompat" until version 1.2.22.
 436 You can turn the default off by switching on one of the other two options.
 437 You should leave this at it's default value, unless you have a very good
 438 reason to change it.
 439 <br>
 440 <br>
 441 </p>
 442
 443 <p>
 444 All options are inherited from the global server to virtual hosts.
 445 Options that support enabling (plus options) and disabling (minus options),
 446 are inherited in the following way:
 447 <br>
 448 <br>
 449 options(vhost) = plus_options(global) - minus_options(global) + plus_options(vhost) - minus_options(vhost)
 450 <br>
 451 <br>
 452 </p>
 453
 454 <p>
 455 Using JkOptions <b>ForwardURIProxy</b>, the forwarded URI
 456 will be partially reencoded after processing inside Apache httpd and
 457 before forwarding to Tomcat. This will be compatible with local
 458 URL manipulation by mod_rewrite and with URL encoded session ids.
 459
 460 <div class="example"><pre>
 461   JkOptions     +ForwardURIProxy
 462 </pre></div>
 463
 464 <br>
 465 <br>
 466 </p>
 467
 468 <p>
 469 Using JkOptions <b>ForwardURICompatUnparsed</b>, the forwarded URI
 470 will be unparsed. It's spec compliant and secure.
 471 It will always forward the original request URI, so rewriting
 472 URIs with mod_rewrite and then forwarding the rewritten URI
 473 will not work.
 474
 475 <div class="example"><pre>
 476   JkOptions     +ForwardURICompatUnparsed
 477 </pre></div>
 478
 479 <br>
 480 <br>
 481 </p>
 482 <p>
 483 Using JkOptions <b>ForwardURICompat</b>, the forwarded URI will
 484 be decoded by Apache httpd. Encoded characters will be decoded and
 485 explicit path components like ".." will already be resolved.
 486 This is less spec compliant and is <b>not safe</b> if you are using
 487 prefix JkMount. This option will allow to rewrite URIs with
 488 mod_rewrite before forwarding.
 489
 490 <div class="example"><pre>
 491   JkOptions     +ForwardURICompat
 492 </pre></div>
 493
 494 <br>
 495 <br>
 496 </p>
 497 <p>
 498 Using JkOptions <b>ForwardURIEscaped</b>, the forwarded URI will
 499 be the encoded form of the URI used by ForwardURICompat.
 500 Explicit path components like ".." will already be resolved.
 501 This will not work in combination with URL encoded session IDs,
 502 but it will allow to rewrite URIs with mod_rewrite before forwarding.
 503
 504 <div class="example"><pre>
 505   JkOptions     +ForwardURIEscaped
 506 </pre></div>
 507
 508 <br>
 509 <br>
 510 </p>
 511
 512 <p>
 513 JkOptions <b>RejectUnsafeURI</b> will block all
 514 URLs, which contain percent signs '%' or backslashes '\'
 515 after decoding.
 516 <br>
 517 <br>
 518 </p>
 519 <p>
 520 Most web apps do not use such URLs. Using the option RejectUnsafeURI, you
 521 can block several well known URL encoding attacks. By default, this option
 522 is not set.
 523 </p>
 524 <p>
 525 You can also realise such a check with mod_rewrite, which is more powerful
 526 but also slightly more complicated.
 527
 528 <div class="example"><pre>
 529   JkOptions     +RejectUnsafeURI
 530 </pre></div>
 531
 532 <br>
 533 <br>
 534 </p>
 535
 536 <p>
 537 JkOptions <b>ForwardDirectories</b> is used in conjunction with <b>DirectoryIndex</b>
 538 directive of Apache web server. As such mod_dir should be available to Apache,
 539 statically or dynamically (DSO)
 540 <br>
 541 <br>
 542 </p>
 543
 544 <p>
 545 When DirectoryIndex is configured, Apache will create sub-requests for
 546 each of the local-url's specified in the directive, to determine if there is a
 547 local file that matches (this is done by stat-ing the file).
 548 </p>
 549
 550 <p>
 551 If ForwardDirectories is set to false (default) and Apache doesn't find any
 552 files that match, Apache will serve the content of the directory (if directive
 553 Options specifies Indexes for that directory) or a <b class="code">403 Forbidden</b> response (if
 554 directive Options doesn't specify Indexes for that directory).
 555 </p>
 556
 557 <p>
 558 If ForwarDirectories is set to true and Apache doesn't find any files that
 559 match, the request will be forwarded to Tomcat for resolution. This is used in
 560 cases when Apache cannot see the index files on the file system for various
 561 reasons: Tomcat is running on a different machine, the JSP file has been
 562 precompiled etc.
 563 </p>
 564
 565 <p>Note that locally visible files will take precedence over the
 566 ones visible only to Tomcat (i.e. if Apache can see the file, that's the one
 567 that's going to get served). This is important if there is more then one type of
 568 file that Tomcat normally serves - for instance Velocity pages and JSP pages.
 569
 570 <div class="example"><pre>
 571   JkOptions     +ForwardDirectories
 572 </pre></div>
 573 <br>
 574 <br>
 575 </p>
 576
 577 <p>
 578 JkOptions <b>ForwardLocalAddress</b>, you ask mod_jk to send the local address,
 579 of the Apache web server instead remote client address. This can be used by
 580 Tomcat remote address valve for allowing connections only from registered Apache
 581 web servers.
 582
 583 <div class="example"><pre>
 584   JkOptions     +ForwardLocalAddress
 585 </pre></div>
 586
 587 <br>
 588 <br>
 589 </p>
 590
 591 <p>
 592 JkOptions <b>FlushPackets</b>, you ask mod_jk to flush Apache's connection
 593 buffer after each AJP packet chunk received from Tomcat. This option can have
 594 a strong performance penalty for Apache and Tomcat as writes are performed
 595 more often than would normally be required (ie: at the end of each
 596 response).
 597
 598 <div class="example"><pre>
 599   JkOptions     +FlushPackets
 600 </pre></div>
 601
 602 <br>
 603 <br>
 604 </p>
 605
 606 <p>
 607 JkOptions <b>FlushHeader</b>, you ask mod_jk to flush Apache's connection
 608 buffer after the response headers have been  received from Tomcat.
 609
 610 <div class="example"><pre>
 611   JkOptions     +FlushHeader
 612 </pre></div>
 613
 614 <br>
 615 <br>
 616 </p>
 617
 618 <p>
 619 JkOptions <b>DisableReuse</b>, you ask mod_jk to close connections immediately
 620 after their use. Normally mod_jk uses persistent connections and pools idle
 621 connections to reuse them, when new requests have to be sent to Tomcat.
 622 </p>
 623
 624 <p>
 625 Using this option will have a strong performance penalty for Apache and Tomcat.
 626 Use this only as a last resort in case of unfixable network problems.
 627 If a firewall between Apache and Tomcat silently kills idle connections,
 628 try to use the worker attribute socket_keepalive in combination with an appropriate
 629 TCP keepalive value in your OS.
 630
 631 <div class="example"><pre>
 632   JkOptions     +DisableReuse
 633 </pre></div>
 634
 635 <br>
 636 <br>
 637 </p>
 638
 639 <p>
 640 JkOptions <b>ForwardKeySize</b>, you ask mod_jk, when using ajp13, to forward also the SSL Key Size as
 641 required by Servlet API 2.3.
 642 This flag shouldn't be set when servlet engine is Tomcat 3.2.x (off by default).
 643
 644 <div class="example"><pre>
 645   JkOptions     +ForwardKeySize
 646 </pre></div>
 647
 648 <br>
 649 <br>
 650 </p>
 651
 652 <p>
 653 JkOptions <b>ForwardSSLCertChain</b>,  you ask mod_jk, when using ajp13,
 654 to forward SSL certificate chain (off by default).
 655 Mod_jk only passes the <b class="code">SSL_CLIENT_CERT</b> to the AJP connector. This is not a
 656 problem with self-signed certificates or certificates directly signed by the
 657 root CA certificate. However, there's a large number of certificates signed by
 658 an intermediate CA certificate, where this is a significant problem: A servlet
 659 will not have the possibility to validate the client certificate on its own. The
 660 bug would be fixed by passing on the <b class="code">SSL_CLIENT_CERT_CHAIN</b> to Tomcat via the AJP connector.
 661 <br>
 662 This directive exists only since version 1.2.22.
 663 <div class="example"><pre>
 664   JkOptions     +ForwardSSLCertChain
 665 </pre></div>
 666
 667 <br>
 668 <br>
 669 </p>
 670
 671 <p>
 672 The directive <b>JkEnvVar</b> allows you to forward environment variables
 673 from Apache server to Tomcat engine.
 674 You can add a default value as a second parameter to the directive.
 675 If the default value is not given explicitly, the variable
 676 will only be send, if it is set during runtime.
 677 <br>
 678 The variables can be retrieved on the Tomcat side as request attributes
 679 via request.getAttribute(attributeName).
 680 Note that the variables send via JkEnvVar will not be listed
 681 in request.getAttributeNames().
 682 <br>
 683 <br>
 684 The variables are inherited from the global server to virtual hosts.
 685
 686 <div class="example"><pre>
 687   JkEnvVar     SSL_CLIENT_V_START     undefined
 688 </pre></div>
 689 <br>
 690 <br>
 691 </p>
 692
 693 </blockquote></td></tr></table>
 694
 695 <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>
 696 <p>
 697 If you have created a custom or local version of mod_jk.conf-local as noted above,
 698 you can change settings such as the workers or URL prefix.
 699 </p>
 700
 701 <p>
 702 <b>JkMount</b> directive assign specific URLs to Tomcat.
 703 In general the structure of a JkMount directive is:
 704 </p>
 705
 706 <div class="example"><pre>  JkMount [URL prefix] [Worker name]</pre></div>
 707
 708 <div class="example"><pre>
 709   # send all requests ending in .jsp to worker1
 710   JkMount /*.jsp worker1
 711   # send all requests ending /servlet to worker1
 712   JkMount /*/servlet/ worker1
 713   # send all requests jsp requests to files located in /otherworker will go worker2
 714   JkMount /otherworker/*.jsp worker2
 715 </pre></div>
 716
 717 <p>
 718 You can use the JkMount directive at the top level or inside &lt;VirtualHost&gt; sections of your httpd.conf file.
 719 </p>
 720 </blockquote></td></tr></table>
 721
 722 <table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Configuring Apache to serve static web application files"><strong>Configuring Apache to serve static web application files</strong></a></font></td></tr><tr><td><blockquote>
 723 <p>
 724 If the Tomcat Host appBase (webapps) directory is accessible by the Apache web server,
 725 Apache can be configured to serve web application context directory static files instead
 726 of passing the request to Tomcat.
 727 </p>
 728
 729 <p>
 730 Caution: For security reasons is is strongly recommended that JkMount is used to
 731 pass all requests to Tomcat by default and JkUnMount is used to explicitly
 732 exclude static content to be served by httpd. It should also be noted that
 733 content served by httpd will bypass any security constraints defined in the
 734 application's web.xml.
 735 </p>
 736
 737 <p>Use Apache's <b>Alias</b> directive to map a single web application context directory into Apache's
 738 document space for a VirtualHost:
 739 </p>
 740
 741 <div class="example"><pre>
 742   # Static files in the examples webapp are served by apache
 743   Alias /examples /vat/tomcat3/webapps/examples
 744   # All requests go to worker1 by default
 745   JkMount /* worker1
 746   # Serve html, jpg and gif using httpd
 747   JkUnMount /*.html worker1
 748   JkUnMount /*.jpg  worker1
 749   JkUnMount /*.gif  worker1
 750 </pre></div>
 751
 752 <p>
 753 Starting with mod_jk 1.2.6 for Apache 2.0/2.2 and 1.2.19 for Apache 1.3, it's possible to exclude some URL/URI from
 754 jk processing by setting the env var <b>no-jk</b>, for example with the SetEnvIf Directive.
 755 </p>
 756
 757 <p>
 758 You could use <b>no-jk</b> env var to fix problem with mod_alias or mod_userdir
 759 directive when jk and alias/userdir URLs matches.
 760 </p>
 761
 762 <div class="example"><pre>
 763   # All URL goes to tomcat except the one containing /home
 764   &lt;VirtualHost *:80&gt;
 765       ServerName testxxx.mysys
 766       DocumentRoot /www/testxxx/htdocs
 767
 768   # Use SetEnvIf to st no-jk when /home/ is encountered
 769       SetEnvIf Request_URI "/home/*" no-jk
 770
 771   # Now /home will goes to /home/dataxxx/
 772       Alias /home /home/dataxxx/
 773
 774       &lt;Directory "/home/dataxxx"&gt;
 775           Options Indexes MultiViews
 776           AllowOverride None
 777           Order allow,deny
 778           Allow from all
 779       &lt;/Directory&gt;
 780
 781       JkMount /* myssys-xxx
 782
 783   &lt;/VirtualHost&gt;
 784 </pre></div>
 785
 786
 787 <p>
 788 Use the mod_jk <b>JkAutoAlias</b> directive to map all web application context directories
 789 into Apache's document space.
 790 </p>
 791
 792 <p>
 793 Attempts to access the WEB-INF or META-INF directories within a web application context
 794 or a Web Archive *.war within the Tomcat Host appBase (webapps) directory will fail with an
 795 <b class="code">HTTP 403, Access Forbidden</b>
 796 </p>
 797
 798 <div class="example"><pre>
 799   # Static files in all Tomcat webapp context directories are served by apache
 800   JkAutoAlias /var/tomcat3/webapps
 801
 802   # All requests go to worker1 by default
 803   JkMount /* ajp13
 804   # Serve html, jpg and gif using httpd
 805   JkUnMount /*.html ajp13
 806   JkUnMount /*.jpg  ajp13
 807   JkUnMount /*.gif  ajp13
 808 </pre></div>
 809
 810 <p>
 811 If you encoded all your URLs to contain the session id
 812 (<b class="code">;jsessionid=...</b>), and you later decide, you want to
 813 move part of the content to Apache httpd, you can tell
 814 mod_jk to strip off all session ids from URLs for
 815 those requests, that do not get forwarded via mod_jk.
 816 </p>
 817
 818 <p>
 819 You enable this feature by setting JkStripSession to On.
 820 It can be enabled individually for virtual servers. The default
 821 value is Off.
 822 </p>
 823
 824 </blockquote></td></tr></table>
 825 </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="Building mod_jk on Unix"><strong>Building mod_jk on Unix</strong></a></font></td></tr><tr><td><blockquote>
 826 <p>
 827 The mod_jk build use the widely used configure system.
 828 </p>
 829 <table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Prepare your mod_jk configure from subversion"><strong>Prepare your mod_jk configure from subversion</strong></a></font></td></tr><tr><td><blockquote>
 830 In case you get source from subversion, ie without an existing configure script,
 831 you should have autoconf for configuration and installation.
 832 <p>
 833 To create tomcat-connectors's autoconf script, you will need libtool
 834 1.5.2, automake 1.10 and autoconf 2.59 or newer. The use of more recent
 835 versions is encouraged, e.g. for reliable detection of the features of
 836 recent version of operating systems.
 837 </p><p>
 838 Those tools will not be required if you are just using a package downloaded from apache.org,
 839 they are only required for developers.
 840 </p>
 841 <p>
 842 To create the configure script just type :
 843
 844 <p class="screen"><div align="left"><table width="80%" border="1" cellspacing="0" cellpadding="2" bgcolor="#000000"><tr><td bgcolor="#000000" align="left"><code><nobr><em class="screen">[user@host] ~ $ </em><b class="screen">./buildconf.sh</b></nobr></code><br></td></tr></table></div></p>
 845 </p>
 846 </blockquote></td></tr></table>
 847
 848 <table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Using configure to build mod_jk"><strong>Using configure to build mod_jk</strong></a></font></td></tr><tr><td><blockquote>
 849 <p>Here's how to use configure to prepare mod_jk for building, just type:
 850 <div class="example"><pre>
 851 ./configure [autoconf arguments] [tomcat-connectors arguments]
 852 </pre></div>
 853 </p>
 854
 855 <p>
 856 You could set <b>CFLAGS</b> and <b>LDFLAGS</b> to add some platform specifics:
 857 </p>
 858
 859 <p class="screen"><div align="left"><table width="80%" border="1" cellspacing="0" cellpadding="2" bgcolor="#000000"><tr><td bgcolor="#000000" align="left"><code><nobr><em class="screen">[user@host] ~ $ </em><b class="screen">LDFLAGS=-lc ./configure -with-apxs=/home2/local/apache/bin/apxs</b></nobr></code><br></td></tr></table></div></p>
 860
 861 <p>
 862 If you want to build mod_jk for different version of Apache httpd, like 1.3, 2.0 and 2.2,
 863 you need to go through the full build process for each of them.
 864 Please note, that httpd 2.0 and 2.2 modules are <b>not</b> compatible. The mod_jk directory
 865 used is "apache-2.0" in both cases, but you need to compile separately.
 866 <ul>
 867 <li>
 868 use configure and indicate the correct Apache httpd apxs location (--with-apxs)
 869 </li>
 870 <li>
 871 use make
 872 </li>
 873 <li>
 874 copy the resulting mod_jk.so binary from the apache-1.3 or apache-2.0 subdirectory
 875 to the Apache httpd modules location.
 876 </li>
 877 <li>
 878 make clean (to remove all previously compiled object files)
 879 </li>
 880 <li>
 881 Start over with the apxs location for your next Apache httpd version.
 882 </li>
 883 </ul>
 884
 885 </p>
 886 </blockquote></td></tr></table>
 887
 888 <table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="configure arguments"><strong>configure arguments</strong></a></font></td></tr><tr><td><blockquote>
 889 <p>
 890 <table>
 891   <tr valign="top"><th>Apache related parameters</th><th></th></tr>
 892   <tr valign="top">
 893   <td>--with-apxs[=FILE]</td>
 894   <td>FILE is the location of the apxs tool. Default is finding apxs in PATH.
 895 It builds a shared Apache module. It detects automatically the Apache version.
 896 (2.0/2.2 and 1.3)</td>
 897   </tr>
 898   <tr valign="top"><td>--with-apache=DIR</td>
 899   <td>DIR is the path where apache sources are located.
 900 The apache sources should have been configured before configuring mod_jk.
 901 DIR is something like: /home/apache/apache_1.3.19
 902 It builds a static Apache module.</td>
 903   </tr>
 904   <tr valign="top"><td>--enable-EAPI</td>
 905   <td>This parameter is needed when using Apache-1.3 and mod_ssl, otherwise you will get the error message:
 906 "this module might crash under EAPI!" when loading mod_jk.so in httpd.
 907 Not needed when --with-apxs has been used</td>
 908 </tr>
 909   <tr valign="top"><td>--enable-prefork</td>
 910   <td>
 911 In case you build mod_jk for a multi-threaded Apache httpd 2.0/2.2 MPM (Multi-Processing Module),
 912 some areas of mod_jk code need to be synchronised to make it thread-safe.
 913 Because configure can not easily detect, whether your are using a multi-threaded MPM,
 914 mod_jk by default is always build thread-safe for Apache httpd 2.0/2.2.
 915 If you are sure, that your MPM is not multi-threaded, you can use "--enable-prefork"
 916 to force the removal of the synchronisation code (thus increasing performance a bit).
 917 For instance, the prefork MPM is not multi-threaded. For Apache httpd 1.3
 918 this flag will be set automatically.</td>
 919 </tr>
 920   <tr valign="top"><td>--disable-trace</td>
 921   <td>
 922 When using log level "trace", mod_jk traces a lot of function calls with
 923 "enter" and "exit" log messages. Even if the log level is not "trace",
 924 comparing the log levels to decide about logging has some performance
 925 impact.<br>
 926 If you use "--disable-trace", then the trace log code doesn't get compiled
 927 into the module binary and you might save some cycles during execution.<br>
 928 Even with "--disable-trace" logging debug messages with debug log level
 929 will still be possible.</td>
 930 </tr>
 931   <tr valign="top"><td>--enable-api-compatibility</td>
 932   <td>
 933 Only use httpd API functions available in all httpd production releases
 934 of the chosen major httpd release branch. This improves binary
 935 compatibility of module builds with httpd releases older than the release
 936 against mod_jk is build (only between minor httpd versions).</td>
 937 </tr>
 938   <tr valign="top"><td>--enable-flock</td>
 939   <td>
 940 In case the operating system supports flock system call use this flag to enable this
 941 faster locks that are implemented as system call instead emulated by GNU C library.<br>
 942 However those locks does not work on NFS mounted volumes, so you can use
 943 "--enable-flock" during compile time to force the flocks() calls.</td>
 944 </tr>
 945
 946 </table>
 947 <br>
 948 <table>
 949   <tr valign="top"><th>DEPRECATED: JNI related parameters</th><th></th></tr>
 950   <tr valign="top"><td>--enable-jni</td>
 951   <td>Build the JNI worker and so the build process will require
 952 some information about your Java Environment</td>
 953   </tr>
 954   <tr valign="top"><td>--with-java-home=DIR</td>
 955   <td>DIR is the  patch to the JDK root directory. Something like: /opt/java/jdk12</td>
 956   </tr>
 957   <tr valign="top"><td>--with-os-type=SUBDIR</td><td>SUBDIR is the os-type subdirectory,
 958   configure should guess it correctly.</td>
 959   </tr>
 960   <tr valign="top"><td>--with-arch-type=SUBDIR</td><td>SUBDIR is the arch subdirectory,
 961   configure should guess it correctly.</td>
 962   </tr>
 963   <tr valign="top"><td>--with-java-platform=VAL</td><td>VAL is the Java platform 1 is 1.1.x and 2 is for 1.2 and higher,
 964   configure should guess it correctly.</td>
 965   </tr>
 966 </table>
 967 </p>
 968 <p><font color="#ff0000">The JNI option has been deprecated. It will likely not work. Do not use it.</font></p>
 969 </blockquote></td></tr></table>
 970
 971 <table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Examples of configure use"><strong>Examples of configure use</strong></a></font></td></tr><tr><td><blockquote>
 972
 973 <p class="screen"><div align="left"><table width="80%" border="1" cellspacing="0" cellpadding="2" bgcolor="#000000"><tr><td bgcolor="#000000" align="left"><div class="screen">Apache 1.3 and 2.0/2.2 build</div><code><nobr><em class="screen">[user@host] ~ $ </em><b class="screen">./configure --with-apxs=/usr/sbin/apxs</b></nobr></code><br><code><nobr><em class="screen">[user@host] ~ $ </em><b class="screen">make</b></nobr></code><br><code><nobr><em class="screen">[user@host] ~ $ </em><b class="screen">cp ./apache-1.3/mod_jk.so /usr/lib/apache</b></nobr></code><br><code><nobr><em class="screen">[user@host] ~ $ </em><b class="screen">make clean</b></nobr></code><br><code><nobr><em class="screen">[user@host] ~ $ </em><b class="screen">./configure --with-apxs=/usr/sbin/apxs2</b></nobr></code><br><code><nobr><em class="screen">[user@host] ~ $ </em><b class="screen">make</b></nobr></code><br><code><nobr><em class="screen">[user@host] ~ $ </em><b class="screen">cp ./apache-2.0/mod_jk.so /usr/lib/apache2</b></nobr></code><br></td></tr></table></div></p>
 974
 975 <p class="screen"><div align="left"><table width="80%" border="1" cellspacing="0" cellpadding="2" bgcolor="#000000"><tr><td bgcolor="#000000" align="left"><div class="screen">Apache 2.0/2.2 build with JNI support</div><code><nobr><em class="screen">[user@host] ~ $ </em><b class="screen">./configure --with-apxs2=/opt/apache2/bin/apxs \</b></nobr></code><br><code><nobr><em class="screen"> </em><b class="screen">--with-java-home=${JAVA_HOME} --with-java-platform=2 \</b></nobr></code><br><code><nobr><em class="screen"> </em><b class="screen">--enable-jni</b></nobr></code><br></td></tr></table></div></p>
 976 <p><font color="#ff0000">The JNI option has been deprecated. It will likely not work. Do not use it.</font></p>
 977 </blockquote></td></tr></table>
 978
 979 </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="Building mod_jk for Apache on Windows NT/2K/XP"><strong>Building mod_jk for Apache on Windows NT/2K/XP</strong></a></font></td></tr><tr><td><blockquote>
 980 <p>
 981 The module was developed using Visual C++ version 6.0, so having this environment is a prerequisite
 982 if you want to perform a custom build.
 983 </p>
 984 <p>
 985 The steps that you need to take are:
 986 </p>
 987 <ul>
 988 <li>
 989 Change directory to the apache 1.3 or apache 2.0 source directory depending on your version of Apache.
 990 </li>
 991 <li>
 992 If you want to build mod_jk for Apache 1.3, set an <b>APACHE1_HOME</b> environment variable which points
 993 to where your Apache 1.3 is installed.
 994 A mod_jk module for Apache 2.0 build will require <b>APACHE2_HOME</b> environment variable to be set.
 995 </li>
 996 <li>
 997 Copy mod_jk.so to Apache's modules directory.
 998 </li>
 999 </ul>
1000 <p>
1001 An example on how to build mod_jk for Apache 1.3:
1002 </p>
1003 <p class="screen"><div align="left"><table width="80%" border="1" cellspacing="0" cellpadding="2" bgcolor="#000000"><tr><td bgcolor="#000000" align="left"><div class="screen">Set location for Apache 1.3 sources</div><code><nobr><em class="screen">c:\&gt;</em><b class="screen">set APACHE1_HOME=c:\apache13</b></nobr></code><br><div class="screen">Change directory to the mod_jk module for Apache 1.3</div><code><nobr><em class="screen">c:\&gt;</em><b class="screen">cd c:\home\apache\jk\native\apache-1.3</b></nobr></code><br><div class="screen">Build the sources using MSDEV</div><code><nobr><em class="screen">c:\&gt;</em><b class="screen">MSDEV mod_jk.dsp /MAKE ALL</b></nobr></code><br><div class="screen">Copy the dll to your apache modules directory</div><code><nobr><em class="screen">c:\&gt;</em><b class="screen">cp release\mod_jk.so c:\apache13\modules\</b></nobr></code><br></td></tr></table></div></p>
1004
1005 <p>
1006 An example on how to build mod_jk for Apache 2.0:
1007 </p>
1008 <p class="screen"><div align="left"><table width="80%" border="1" cellspacing="0" cellpadding="2" bgcolor="#000000"><tr><td bgcolor="#000000" align="left"><div class="screen">Set location for Apache 2.0 sources</div><code><nobr><em class="screen">c:\&gt;</em><b class="screen">set APACHE2_HOME=c:\apache20</b></nobr></code><br><div class="screen">Change directory to the mod_jk module for Apache 2.0</div><code><nobr><em class="screen">c:\&gt;</em><b class="screen">cd c:\home\apache\jk\native\apache-2.0</b></nobr></code><br><div class="screen">Build the sources using MSDEV</div><code><nobr><em class="screen">c:\&gt;</em><b class="screen">MSDEV mod_jk.dsp /MAKE ALL</b></nobr></code><br><div class="screen">Copy the dll to your apache modules directory</div><code><nobr><em class="screen">c:\&gt;</em><b class="screen">cp release\mod_jk.so c:\apache20\modules\</b></nobr></code><br></td></tr></table></div></p>
1009
1010 <p>
1011 If msdev is not in your path, enter the full path to msdev.exe.
1012 Also, ApacheCore.lib is expected to exist in the <b>${APACHEX_HOME}\src\CoreD</b> and
1013 <b>${APACHEX_HOME}\src\CoreR</b> directories before linking will succeed.
1014 You will need to build enough of the Apache source to create these libraries.
1015 This will build both release and debug versions of the redirector plug-in (mod_jk).
1016 An alternative will be to open mod_jk.dsp in msdev and build it using the build menu.
1017 </p>
1018 </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="Building mod_jk for Apache on System I - i5/OS (OS400)"><strong>Building mod_jk for Apache on System I - i5/OS (OS400)</strong></a></font></td></tr><tr><td><blockquote>
1019 <p>
1020 Since OS400 V4R5, System I (AS/400) has used Apache 2.0 as their primary web server,
1021 replacing the old IBM webserver.
1022 It's now possible to build mod_jk on System I thanks to the help of the IBM
1023 Rochester Labs which has provided information and patches to adapt mod_jk to i5/OS.
1024 </p>
1025 <p>
1026 You should have at least Apache 2.0.58 (product 5722DG1), a C Compiler and IFS.
1027 Apache 2.0.58 is provided with the most recent set of PTFs for the iSeries Apache
1028 server, which can be found at <a href="http://www.ibm.com/servers/eserver/iseries/software/http/">
1029 http://www.ibm.com/servers/eserver/iseries/software/http/</a>
1030 </p>
1031 <p>
1032 The all latest Apache 2 for i5/OS V5R3 (or V5R4) is now 2.0.58 (as of 2007/04/17).
1033 Be sure to have the latest PTFs loaded if you want to make use of jk 1.2.15 and higher.
1034 NB: The latest mod_jk known to work on i5/OS V5R3 was 1.2.19.
1035 </p>
1036 <p>
1037 New in i5/OS V5R4, UTF is required, also for Apache modules, as such Apache modules do not require
1038 translations to/from EBCDIC but works should be done to port mod_jk 1.2.23 (and higher) to V5R4.
1039
1040 From the V5R4 Infocenter :
1041
1042 As of i5/OS(tm) V5R4, modules must be recompiled with a UTF locale. This creates an environment where locale-dependent C runtime functions assume
1043 that string data is encoded in UTF-8. Any hardcoded constants can be encoded in UTF-8 by adding a #pragma convert(1208) statement in the module.
1044 Additionally, input data from the client will no longer be converted to EBCDIC but will be passed as-is.
1045 Output data sent from the module is not converted either so it must be encoded in ASCII or UTF8 as required.
1046 APR and HTTP APIs as of V5R4, expect data in UTF-8. Note that several APIs have additional functions that allow a CCSID to be set to
1047 indicate the encoding of the parameters being passed. Conversion functions between UTF-8 and EBCDIC have been added.
1048 Be sure to review APIs used by your module to be aware of current changes.
1049
1050 </p>
1051 <p>
1052 To configure mod_jk on System I use the CL source provided with the mod_jk source.
1053 </p>
1054 <ul>
1055 <li>
1056 Get the latest mod_jk source and untar it on a Windows or Unix boxes
1057 </li>
1058 <li>
1059 Create a directory in IFS, ie /home/apache
1060 </li>
1061 <li>
1062 Send the whole jk source directory to System I directory via FTP.
1063 </li>
1064 <li>
1065 Then go to the System I command line :
1066 </li>
1067 </ul>
1068 <p class="screen"><div align="left"><table width="80%" border="1" cellspacing="0" cellpadding="2" bgcolor="#000000"><tr><td bgcolor="#000000" align="left"><div class="screen">Create mod_jk library</div><code><nobr><em class="screen">===&gt;</em><b class="screen">CRTLIB MOD_JK TEXT(&#145;Apache mod'jk tomcat connector module')</b></nobr></code><br><div class="screen">Create service program source file</div><code><nobr><em class="screen">===&gt;</em><b class="screen">CRTSRCPF MOD_JK/QSRVSRC TEXT(&#145;Service program source file&#146;)</b></nobr></code><br><div class="screen">Create the CL build program source file</div><code><nobr><em class="screen">===&gt;</em><b class="screen">CRTSRCPF FILE(MOD_JK/QCLSRC) TEXT(&#145;Build program source file&#146;)</b></nobr></code><br><div class="screen">Edit the service program source file</div><code><nobr><em class="screen">===&gt;</em><b class="screen">STRSEU MOD_JK/QSRVSRC MOD_JK</b></nobr></code><br></td></tr></table></div></p>
1069 <p>
1070 In the edited file, specify that only jk_module should be exported :
1071 <p class="screen"><div align="left"><table width="80%" border="1" cellspacing="0" cellpadding="2" bgcolor="#000000"><tr><td bgcolor="#000000" align="left"><div class="screen"> Columns   . . :    1  71     Edit                               MOD_JK/QSRVSRC </div><div class="screen"> SEU==&gt;                                                                  MOD_JK </div><div class="screen">        *************** Beginning of data ************************************* </div><div class="screen">0001.00 STRPGMEXP PGMLVL(*CURRENT)                                              </div><div class="screen">0002.00 EXPORT SYMBOL("jk_module")                                              </div><div class="screen">0003.00 ENDPGMEXP                                                               </div><div class="screen">        ****************** End of data **************************************** </div></td></tr></table></div></p>
1072 </p>
1073 <p>
1074 You could start to build all the modules of mod_jk (cases for V5R4 or previous releases):
1075 </p>
1076 <p class="screen"><div align="left"><table width="80%" border="1" cellspacing="0" cellpadding="2" bgcolor="#000000"><tr><td bgcolor="#000000" align="left"><div class="screen">Copy the CL build program source for i5/OS before V5R4 from IFS</div><code><nobr><em class="screen">===&gt;</em><b class="screen">CPYFRMSTMF FROMSTMF('/home/apache/jk/native/apache-2.0/bldjk.qclsrc') +</b></nobr></code><br><div class="screen">TOMBR('/QSYS.LIB/MOD_JK.LIB/QCLSRC.FILE/BLDJK.MBR') MBROPT(*REPLACE)</div><div class="screen">Build the CL build program</div><code><nobr><em class="screen">===&gt;</em><b class="screen">CRTCLPGM PGM(MOD_JK/BLDJK) SRCFILE(MOD_JK/QCLSRC) TEXT('Apache mod_jk build program')</b></nobr></code><br><div class="screen">Launch the build</div><code><nobr><em class="screen">===&gt;</em><b class="screen">CALL MOD_JK/BLDJK</b></nobr></code><br><div class="screen">If the build if successfull, copy the new mod_jk module</div><code><nobr><em class="screen">===&gt;</em><b class="screen">CRTDUPOBJ OBJ(MOD_JK) FROMLIB(MOD_JK) OBJTYPE(*SRVPGM) TOLIB(QHTTPSVR) NEWOBJ(MOD_JK)</b></nobr></code><br></td></tr></table></div></p>
1077 <p class="screen"><div align="left"><table width="80%" border="1" cellspacing="0" cellpadding="2" bgcolor="#000000"><tr><td bgcolor="#000000" align="left"><div class="screen">Copy the CL build program source for i5/OS V5R4 from IFS</div><code><nobr><em class="screen">===&gt;</em><b class="screen">CPYFRMSTMF FROMSTMF('/home/apache/jk/native/apache-2.0/bldjk54.qclsrc') +</b></nobr></code><br><div class="screen">TOMBR('/QSYS.LIB/MOD_JK.LIB/QCLSRC.FILE/BLDJK54.MBR') MBROPT(*REPLACE)</div><div class="screen">Build the CL build program for i5/OS V5R4</div><code><nobr><em class="screen">===&gt;</em><b class="screen">CRTCLPGM PGM(MOD_JK/BLDJK54) SRCFILE(MOD_JK/QCLSRC) TEXT('Apache mod_jk build program') TGTRLS(*CURRENT)</b></nobr></code><br><div class="screen">Launch the build for i5/OS V5R4</div><code><nobr><em class="screen">===&gt;</em><b class="screen">CALL MOD_JK/BLDJK54</b></nobr></code><br><div class="screen">If the build if successfull, copy the new mod_jk module</div><code><nobr><em class="screen">===&gt;</em><b class="screen">CRTDUPOBJ OBJ(MOD_JK) FROMLIB(MOD_JK) OBJTYPE(*SRVPGM) TOLIB(QHTTPSVR) NEWOBJ(MOD_JK)</b></nobr></code><br></td></tr></table></div></p>
1078 <p>
1079 Next, you should restart your Apache 2.0 instance and enjoy this piece of OpenSource on System I.
1080 </p>
1081 <p class="screen"><div align="left"><table width="80%" border="1" cellspacing="0" cellpadding="2" bgcolor="#000000"><tr><td bgcolor="#000000" align="left"><div class="screen">ENDTCPSVR SERVER(*HTTP) HTTPSVR(MYSERVER)</div><div class="screen">STRTCPSVR SERVER(*HTTP) HTTPSVR(MYSERVER)</div></td></tr></table></div></p>
1082 </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="Building mod_jk for Apache on MacOS/X"><strong>Building mod_jk for Apache on MacOS/X</strong></a></font></td></tr><tr><td><blockquote>
1083 <p>
1084 Mac OS X (10.2.x) build notes :
1085 </p>
1086 <p>
1087 Assuming that you are root :
1088 </p>
1089 <p class="screen"><div align="left"><table width="80%" border="1" cellspacing="0" cellpadding="2" bgcolor="#000000"><tr><td bgcolor="#000000" align="left"><div class="screen">For Apache 1.3:</div><code><nobr><em class="screen">[user@host] ~ $ </em><b class="screen">./configure --with-apxs=/usr/sbin/apxs</b></nobr></code><br><code><nobr><em class="screen">[user@host] ~ $ </em><b class="screen">cd apache-1.3</b></nobr></code><br><code><nobr><em class="screen">[user@host] ~ $ </em><b class="screen">make -f Makefile.apxs</b></nobr></code><br><code><nobr><em class="screen">[user@host] ~ $ </em><b class="screen">cp mod_jk.so /etc/libexec/httpd</b></nobr></code><br><div class="screen">For Apache 2.0:</div><code><nobr><em class="screen">[user@host] ~ $ </em><b class="screen">./configure --with-apxs=/usr/local/apache2/bin/apxs</b></nobr></code><br><div class="screen">(you should point to the directory where you installed Apache 2.0)</div><code><nobr><em class="screen">[user@host] ~ $ </em><b class="screen">cd apache-2.0</b></nobr></code><br><code><nobr><em class="screen">[user@host] ~ $ </em><b class="screen">make -f Makefile.apxs install</b></nobr></code><br></td></tr></table></div></p>
1090 </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="Getting mod_jk linked statically with Apache"><strong>Getting mod_jk linked statically with Apache</strong></a></font></td></tr><tr><td><blockquote>
1091 <p>
1092 mod_jk allows to install mod_jk in the Apache source tree to get a statically
1093 linked mod_jk. Having mod_jk in the httpd executable brings some performance
1094 improvements. The configure option --with-apache prepare mod_jk to install it
1095 in the Apache source tree.
1096 The option --with-apache works both for Apache-1.3 and Apache-2.0.
1097 The examples below show how to get mod_jk in the httpd process.
1098 </p>
1099
1100 <table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Installation in Apache-2.0"><strong>Installation in Apache-2.0</strong></a></font></td></tr><tr><td><blockquote>
1101 <p class="screen"><div align="left"><table width="80%" border="1" cellspacing="0" cellpadding="2" bgcolor="#000000"><tr><td bgcolor="#000000" align="left"><div class="screen"> /home/apache20/httpd-2.0.43 is the directory where the httpd-2.0 sources
1102 are located. </div><code><nobr><em class="screen">[user@host] ~ $ </em><b class="screen">./configure --with-apache=/home/apache20/httpd-2.0.43</b></nobr></code><br><code><nobr><em class="screen">[user@host] ~ $ </em><b class="screen">make</b></nobr></code><br><div class="screen">Install the mod_jk library and other files in
1103 /home/apache20/httpd-2.0.43/modules: </div><code><nobr><em class="screen">[user@host] ~ $ </em><b class="screen">make install</b></nobr></code><br><div class="screen"> It is not possible to configure Apache directly because the config.m4 of mod_jk must
1104 be added to the configure of httpd-2.0. </div><code><nobr><em class="screen">[user@host] ~ $ </em><b class="screen">cd /home/apache20/httpd-2.0.43</b></nobr></code><br><code><nobr><em class="screen">[user@host] ~ $ </em><b class="screen">sh buildconf</b></nobr></code><br><code><nobr><em class="screen">[user@host] ~ $ </em><b class="screen">configure ... --with-mod_jk</b></nobr></code><br><code><nobr><em class="screen">[user@host] ~ $ </em><b class="screen">make</b></nobr></code><br><code><nobr><em class="screen">[user@host] ~ $ </em><b class="screen">make install</b></nobr></code><br></td></tr></table></div></p>
1105 <p>
1106 The enable-jk=share and enable-jk=static are not supported. --with-mod_jk only
1107 allow static linking of mod_jk.
1108 </p>
1109 </blockquote></td></tr></table>
1110
1111 <table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Installation in Apache-1.3"><strong>Installation in Apache-1.3</strong></a></font></td></tr><tr><td><blockquote>
1112 <p class="screen"><div align="left"><table width="80%" border="1" cellspacing="0" cellpadding="2" bgcolor="#000000"><tr><td bgcolor="#000000" align="left"><div class="screen"> /home/apache/apache_1.3.27 is the directory where the apache-1.3 sources
1113 are located. </div><code><nobr><em class="screen">[user@host] ~ $ </em><b class="screen">./configure --with-apache=/home/apache/apache_1.3.27</b></nobr></code><br><code><nobr><em class="screen">[user@host] ~ $ </em><b class="screen">make</b></nobr></code><br><div class="screen">Install the libjk library, mod_jk.c, includes and other files in
1114 /home/apache/apache_1.3.27/src/modules/jk: </div><code><nobr><em class="screen">[user@host] ~ $ </em><b class="screen">make install</b></nobr></code><br><div class="screen"> Configure in the Apache sources: </div><code><nobr><em class="screen">[user@host] ~ $ </em><b class="screen">cd /home/apache/apache_1.3.27</b></nobr></code><br><code><nobr><em class="screen">[user@host] ~ $ </em><b class="screen">configure ... --enable-module=dir --disable-shared=dir \</b></nobr></code><br><code><nobr><em class="screen"> </em><b class="screen">              --activate-module=src/modules/jk/libjk.a \</b></nobr></code><br><code><nobr><em class="screen"> </em><b class="screen">              --disable-shared=jk</b></nobr></code><br><code><nobr><em class="screen">[user@host] ~ $ </em><b class="screen">make</b></nobr></code><br><code><nobr><em class="screen">[user@host] ~ $ </em><b class="screen">make install</b></nobr></code><br></td></tr></table></div></p>
1115 <p>
1116 The --enable-shared=jk is also working and builds a dso file.
1117 </p>
1118 <p class="screen"><div align="left"><table width="80%" border="1" cellspacing="0" cellpadding="2" bgcolor="#000000"><tr><td bgcolor="#000000" align="left"><div class="screen"> Just change the configure in the Apache sources: </div><code><nobr><em class="screen">[user@host] ~ $ </em><b class="screen">configure ... --enable-module=dir --enable-shared=dir \</b></nobr></code><br><code><nobr><em class="screen"> </em><b class="screen">              --activate-module=src/modules/jk/libjk.a \</b></nobr></code><br><code><nobr><em class="screen"> </em><b class="screen">              --enable-shared=jk</b></nobr></code><br></td></tr></table></div></p>
1119 </blockquote></td></tr></table>
1120
1121 </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>
1122         Copyright &copy; 1999-2011, Apache Software Foundation
1123         </em></font></div></td></tr></table></body></html>