The Apache Tomcat Connector - Webserver HowTo - Apache HTTP Server HowTo

Links Docs Home Reference Guide workers.properties uriworkermap.properties Status Worker Apache HTTP Server IIS Generic HowTo For the impatient All about workers Timeouts Load Balancing Reverse Proxy Webserver HowTo Apache HTTP Server IIS Netscape/SunOne/Sun AJP Protocol Reference AJPv13 AJPv13 Extension Proposal Miscellaneous Documentation Frequently asked questions Changelog Current Tomcat Connectors bugs Contribute documentation JK Status Ant Tasks Reporting Tools Old JK/JK2 documentation News 2012 2011 2010 2009 2008 2007 2006 2005 2004 |
# The Apache Tomcat Connector - Webserver HowTo ## Apache HTTP Server HowTo | print-friendly version
Introduction
> This document explains how to connect Tomcat to the popular open source web server, Apache httpd. There is actually three versions of Apache HTTP Server, 1.3, 2.0 and 2.2 and all can be used with mod_jk, the Tomcat redirector module. It is recommended that you also read the Workers HowTo document to learn how to setup the working entities between your web server and Tomcat Engines. For more detailed configuration information consult the Reference Guide for workers.properties, uriworkermap and Apache. Waring: If Apache HTTP Server and Tomcat are configured to serve content from the same filing system location then care must be taken to ensure that httpd is not able to serve inappropriate content such as the contents of the WEB-INF directory or JSP source code. This could occur if the httpd DocumentRoot overlaps with a Tomcat Host's appBase or the docBase of any Context. It could also occur when using the httpd Alias directive with a Tomcat Host's appBase or the docBase of any Context. This document was originally part of Tomcat: A Minimalistic User's Guide written by Gal Shachor, but has been split off for organisational reasons.
> Document Conventions and Assumptions
> ${tomcat_home} is the root directory of tomcat. Your Tomcat installation should have the following subdirectories: ${tomcat_home}\conf - Where you can place various configuration files ${tomcat_home}\webapps - Containing example applications ${tomcat_home}\bin - Where you place web server plugins In all the examples in this document ${tomcat_home} will be /var/tomcat3. A worker is defined to be a tomcat process that accepts work from the Apache server.
> Supported Configuration
> The mod_jk module was developed and tested on: Linux, FreeBSD, AIX, HP-UX, MacOS X, Solaris and should works on major Unixes platforms supporting Apache 1.3 and/or 2.x WinNT4.0-i386 SP4/SP5/SP6a (should be able to work with other service packs), Win2K and WinXP and Win98 Cygwin (until you have an apache server and autoconf/automake support tools) Netware i5/OS V5R4 (System I) with Apache HTTP Server 2.0.58. Be sure to have the latest Apache PTF installed. 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. The redirector uses ajp12 and ajp13 to send requests to the Tomcat containers. There is also an option to use Tomcat in process, more about the in-process mode can be found in the in process howto.
> Who support ajp protocols ?
> The ajp12 protocol is only available in Tomcat 3.2.x and 3.3.x. The ajp12 has been deprecated with Tomcat 3.3.x and you should use instead ajp13 which is the only ajp protocol known by Tomcat 4.x, 5 and 5.5 and Tomcat 6. Of course Tomcat 3.2.x and 3.3.x also support ajp13 protocol. Others servlet engines such as jetty have support for ajp13 protocol
> How does it work ?
> In a nutshell a web server is waiting for client HTTP requests. When these requests arrive the server does whatever is needed to serve the requests by providing the necessary content. Adding a servlet container may somewhat change this behaviour. Now the web server needs also to perform the following: Load the servlet container adaptor library and initialise it (prior to serving requests). When a request arrives, it needs to check and see if a certain request belongs to a servlet, if so it needs to let the adaptor take the request and handle it. The adaptor on the other hand needs to know what requests it is going to serve, usually based on some pattern in the request URL, and to where to direct these requests. Things are even more complex when the user wants to set a configuration that uses virtual hosts, or when they want multiple developers to work on the same web server but on different servlet container JVMs. We will cover these two cases in the advanced sections.
Obtaining mod_jk
mod_jk can be obtained in two formats - binary and source. Depending on the platform you are running your web server on, a binary version of mod_jk may be available. It is recommended to use the binary version if one is available. If the binary is not available, follow the instructions for building mod_jk from source. The mod_jk source can be downloaded from a mirror here The binaries for mod_jk are now available for several platforms. The binaries are located in subdirectories by platform. For some platforms, such as Windows, this is the typical way of obtaining mod_jk since most Windows systems do not have C compilers. For others, the binary distribution of mod_jk offers simpler installation. For example JK 1.2.x can be downloaded from a mirror here (look for JK 1.2 Binary Releases). The "JK 1.2 Binary Releases" link contains binary version for a variety of operating systems for both Apache 1.3 and Apache 2.x.
Installation
> mod_jk requires two entities: mod_jk.xxx - The Apache HTTP Server module, depending on your operating system, it will be mod_jk.so, mod_jk.nlm or MOD_JK.SRVPGM (see the build section). workers.properties - A file that describes the host(s) and port(s) used by the workers (Tomcat processes). A sample workers.properties can be found under the conf directory in the source download. Also as with other Apache HTTP Server modules, mod_jk should be first installed on the modules directory of your Apache webserver, ie : /usr/lib/apache and you should update your httpd.conf file.
> Disabling old mod_jserv
> If you've previously configured Apache to use mod_jserv, remove any ApJServMount directives from your httpd.conf. If you're including tomcat-apache.conf or tomcat.conf, you'll want to remove them as well - they are specific to mod_jserv. The mod_jserv configuration directives are not compatible with mod_jk !
> Using Tomcat auto-configure
> > The auto-configure works only for a single Tomcat running on the same machine where Apache HTTP Server is running. The simplest way to configure Apache HTTP Server to use mod_jk is to turn on the Apache HTTP Server auto-configure setting in Tomcat and put the following include directive at the end of your Apache httpd.conf file (make sure you replace $TOMCAT_HOME with the correct path for your Tomcat installation:
> >         #To be added at the end of your httpd.conf
> >         Include $TOMCAT_HOME/conf/jk/mod_jk.conf-auto
> > Note: this file may also be generated as $TOMCAT_HOME/conf/auto/mod_jk.conf This will tell Apache HTTP Server to use directives in the mod_jk.conf-auto file in the Apache configuration. This file is created by enabling the Apache auto-configuration by creating your workers.properties file at $TOMCAT_HOME/conf/jk/workers.properties and adding the listener to the Engine element in the server.xml file as per the following example. Please note that this example is specific to Tomcat 5.x, unlike other sections of this document which also apply to previous Tomcat branches.
> >       ...
> >       <Engine ...>
> >         ...
> >         <Listener className="org.apache.jk.config.ApacheConfig" modJk="/path/to/mod_jk.so" />
> >         ...
> >       </Engine>
> >       ...
> Then restart Tomcat and mod_jk.conf should be generated. For more information on this topic, please refer to the API documentation at the Tomcat docs website.
> Custom mod_jk configuration
> You should use custom configuration when : You couldn't use mod_jk.conf-auto since Tomcat engine isn't on the same machine that your Apache web server, ie when you have an Apache in front of a Tomcat Farm. Another case for custom configuration is when your Apache is in front of many different Tomcat engines, each one having it's own configuration, a general case in ISP hosting Also all Apache webmaster will retain custom configuration to be able to tune the settings to their real needs.
> Simple configuration example
> > Here is a simple configuration:
> >         # Load mod_jk module
> >         LoadModule    jk_module  libexec/mod_jk.so
> >         # Declare the module for <IfModule directive> (remove this line on Apache 2.x)
> >         AddModule     mod_jk.c
> >         # Where to find workers.properties
> >         JkWorkersFile /etc/httpd/conf/workers.properties
> >         # Where to put jk shared memory
> >         JkShmFile     /var/log/httpd/mod_jk.shm
> >         # Where to put jk logs
> >         JkLogFile     /var/log/httpd/mod_jk.log
> >         # Set the jk log level [debug/error/info]
> >         JkLogLevel    info
> >         # Select the timestamp log format
> >         JkLogStampFormat "[%a %b %d %H:%M:%S %Y] "
> >         # Send servlet for context /examples to worker named worker1
> >         JkMount  /examples/servlet/* worker1
> >         # Send JSPs  for context /examples to worker named worker1
> >         JkMount  /examples/*.jsp worker1
mod_jk Directives
> We'll discuss here the mod_jk directives and details behind them
> Define workers
> > JkWorkersFile specify the location where mod_jk will find the workers definitions.
> >       JkWorkersFile     /etc/httpd/conf/workers.properties
> Logging
> > JkLogFile specify the location where mod_jk is going to place its log file.
> >       JkLogFile     /var/log/httpd/mod_jk.log
> > 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:
> >       JkLogFile     "|/usr/bin/rotatelogs /var/log/httpd/mod_jk.log 86400"
> > JkLogLevel set the log level between : info log will contains standard mod_jk activity (default). error log will contains also error reports. debug log will contains all information on mod_jk activity
> >       JkLogLevel    info
> > info should be your default selection for normal operations. JkLogStampFormat will configure the date/time format found on mod_jk logfile. Using the strftime() format string it's set by default to "[%a %b %d %H:%M:%S %Y]"
> >       JkLogStampFormat "[%a %b %d %H:%M:%S %Y] "
> > JkRequestLogFormat will configure the format of mod_jk individual request logging. Request logging is configured and enabled on a per virtual host basis. To enable request logging for a virtual host just add a JkRequestLogFormat config. The syntax of the format string is similar to the Apache LogFormat command, here is a list of the available request log format options:
> > Options | Description
> > --- | ---
> > %b | Bytes sent, excluding HTTP headers (CLF format)
> > %B | Bytes sent, excluding HTTP headers
> > %H | The request protocol
> > %m | The request method
> > %p | The canonical Port of the server serving the request
> > %q | The query string (prepended with a ? if a query string exists, otherwise an empty string)
> > %r | First line of request
> > %s | Request HTTP status code
> > %T | Request duration, elapsed time to handle request in seconds '.' micro seconds
> > %U | The URL path requested, not including any query string.
> > %v | The canonical ServerName of the server serving the request
> > %V | The server name according to the UseCanonicalName setting
> > %w | Tomcat worker name
> > %R | Session route name (available with 1.2.19 and up)
> >       JkRequestLogFormat     "%w %V %T"
> Forwarding
> > 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. The four following options +ForwardURIxxx are mutually exclusive. Exactly one of them is required, a negative sign prefix is not allowed with them. 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. 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. All options are inherited from the global server to virtual hosts. Options that support enabling (plus options) and disabling (minus options), are inherited in the following way: options(vhost) = plus_options(global) - minus_options(global) + plus_options(vhost) - minus_options(vhost) Using JkOptions ForwardURIProxy, the forwarded URI will be partially reencoded after processing inside Apache httpd and before forwarding to Tomcat. This will be compatible with local URL manipulation by mod_rewrite and with URL encoded session ids.
> >       JkOptions     +ForwardURIProxy
> > Using JkOptions ForwardURICompatUnparsed, the forwarded URI will be unparsed. It's spec compliant and secure. It will always forward the original request URI, so rewriting URIs with mod_rewrite and then forwarding the rewritten URI will not work.
> >       JkOptions     +ForwardURICompatUnparsed
> > Using JkOptions ForwardURICompat, the forwarded URI will be decoded by Apache httpd. Encoded characters will be decoded and explicit path components like ".." will already be resolved. This is less spec compliant and is not safe if you are using prefix JkMount. This option will allow to rewrite URIs with mod_rewrite before forwarding.
> >       JkOptions     +ForwardURICompat
> > Using JkOptions ForwardURIEscaped, the forwarded URI will be the encoded form of the URI used by ForwardURICompat. Explicit path components like ".." will already be resolved. This will not work in combination with URL encoded session IDs, but it will allow to rewrite URIs with mod_rewrite before forwarding.
> >       JkOptions     +ForwardURIEscaped
> > JkOptions RejectUnsafeURI will block all URLs, which contain percent signs '%' or backslashes '\' after decoding. Most web apps do not use such URLs. Using the option RejectUnsafeURI, you can block several well known URL encoding attacks. By default, this option is not set. You can also realise such a check with mod_rewrite, which is more powerful but also slightly more complicated.
> >       JkOptions     +RejectUnsafeURI
> > JkOptions ForwardDirectories is used in conjunction with DirectoryIndex directive of Apache web server. As such mod_dir should be available to Apache, statically or dynamically (DSO) When DirectoryIndex is configured, Apache will create sub-requests for each of the local-url's specified in the directive, to determine if there is a local file that matches (this is done by stat-ing the file). If ForwardDirectories is set to false (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 403 Forbidden response (if directive Options doesn't specify Indexes for that directory). If ForwarDirectories is set to true and Apache doesn't find any files that match, the request will be forwarded to Tomcat for resolution. This is used in cases when Apache cannot see the index files on the file system for various reasons: Tomcat is running on a different machine, the JSP file has been precompiled etc. Note that locally visible files will take precedence over the ones visible only to Tomcat (i.e. if Apache can see the file, that's the one 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.
> >       JkOptions     +ForwardDirectories
> > JkOptions ForwardLocalAddress, you ask mod_jk to send the local address, of the Apache web server instead remote client address. This can be used by Tomcat remote address valve for allowing connections only from registered Apache web servers.
> >       JkOptions     +ForwardLocalAddress
> > JkOptions FlushPackets, you ask mod_jk to flush Apache's connection buffer after each AJP packet chunk received from Tomcat. This option can have a strong performance penalty for Apache and Tomcat as writes are performed more often than would normally be required (ie: at the end of each response).
> >       JkOptions     +FlushPackets
> > JkOptions FlushHeader, you ask mod_jk to flush Apache's connection buffer after the response headers have been received from Tomcat.
> >       JkOptions     +FlushHeader
> > JkOptions DisableReuse, you ask mod_jk to close connections immediately after their use. Normally mod_jk uses persistent connections and pools idle connections to reuse them, when new requests have to be sent to Tomcat. Using this option will have a strong performance penalty for Apache and Tomcat. Use this only as a last resort in case of unfixable network problems. If a firewall between Apache and Tomcat silently kills idle connections, try to use the worker attribute socket_keepalive in combination with an appropriate TCP keepalive value in your OS.
> >       JkOptions     +DisableReuse
> > JkOptions ForwardKeySize, you ask mod_jk, when using ajp13, to forward also the SSL Key Size as required by Servlet API 2.3. This flag shouldn't be set when servlet engine is Tomcat 3.2.x (off by default).
> >       JkOptions     +ForwardKeySize
> > JkOptions ForwardSSLCertChain, you ask mod_jk, when using ajp13, to forward SSL certificate chain (off by default). Mod_jk only passes the SSL_CLIENT_CERT 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 SSL_CLIENT_CERT_CHAIN to Tomcat via the AJP connector. This directive exists only since version 1.2.22.
> >       JkOptions     +ForwardSSLCertChain
> > The directive JkEnvVar allows you to forward environment variables from Apache server to Tomcat engine. You can add a default value as a second parameter to the directive. If the default value is not given explicitly, the variable will only be send, if it is set during runtime. The variables can be retrieved on the Tomcat side as request attributes via request.getAttribute(attributeName). Note that the variables send via JkEnvVar will not be listed in request.getAttributeNames(). The variables are inherited from the global server to virtual hosts.
> >       JkEnvVar     SSL_CLIENT_V_START     undefined
> Assigning URLs to Tomcat
> > 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. JkMount directive assign specific URLs to Tomcat. In general the structure of a JkMount directive is:
> >       JkMount [URL prefix] [Worker name]
> >       # 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
> You can use the JkMount directive at the top level or inside <VirtualHost> sections of your httpd.conf file.
> Configuring Apache to serve static web application files
> > If the Tomcat Host appBase (webapps) directory is accessible by the Apache web server, Apache can be configured to serve web application context directory static files instead of passing the request to Tomcat. Caution: For security reasons it is strongly recommended that JkMount is used to pass all requests to Tomcat by default and JkUnMount is used to explicitly exclude static content to be served by httpd. It should also be noted that content served by httpd will bypass any security constraints defined in the application's web.xml. Use Apache's Alias directive to map a single web application context directory into Apache's document space for a VirtualHost:
> >       # Static files in the examples webapp are served by apache
> >       Alias /examples /vat/tomcat3/webapps/examples
> >       # All requests go to worker1 by default
> >       JkMount /* worker1
> >       # Serve html, jpg and gif using httpd
> >       JkUnMount /*.html worker1
> >       JkUnMount /*.jpg  worker1
> >       JkUnMount /*.gif  worker1
> > Starting with mod_jk 1.2.6 for Apache 2.x and 1.2.19 for Apache 1.3, it's possible to exclude some URL/URI from jk processing by setting the env var no-jk, for example with the SetEnvIf Directive. You could use no-jk env var to fix problem with mod_alias or mod_userdir directive when jk and alias/userdir URLs matches.
> >       # All URL goes to tomcat except the one containing /home
> >       <VirtualHost *:80>
> >           ServerName testxxx.mysys
> >           DocumentRoot /www/testxxx/htdocs

> >       # Use SetEnvIf to st no-jk when /home/ is encountered
> >           SetEnvIf Request_URI "/home/*" no-jk

> >       # Now /home will goes to /home/dataxxx/
> >           Alias /home /home/dataxxx/

> >           <Directory "/home/dataxxx">
> >               Options Indexes MultiViews
> >               AllowOverride None
> >               Order allow,deny
> >               Allow from all
> >           </Directory>

> >           JkMount /* myssys-xxx

> >       </VirtualHost>
> > Use the mod_jk JkAutoAlias directive to map all web application context directories into Apache's document space. Attempts to access the WEB-INF or META-INF directories within a web application context or a Web Archive *.war within the Tomcat Host appBase (webapps) directory will fail with an HTTP 403, Access Forbidden
> >       # Static files in all Tomcat webapp context directories are served by apache
> >       JkAutoAlias /var/tomcat3/webapps

> >       # All requests go to worker1 by default
> >       JkMount /* ajp13
> >       # Serve html, jpg and gif using httpd
> >       JkUnMount /*.html ajp13
> >       JkUnMount /*.jpg  ajp13
> >       JkUnMount /*.gif  ajp13
> If you encoded all your URLs to contain the session id (;jsessionid=...), and you later decide, you want to move part of the content to Apache httpd, you can tell mod_jk to strip off all session ids from URLs for those requests, that do not get forwarded via mod_jk. You enable this feature by setting JkStripSession to On. It can be enabled individually for virtual servers. The default value is Off.
Building mod_jk on Unix
> The mod_jk build use the widely used configure system.
> Prepare your mod_jk configure from subversion
> > In case you get source from subversion, ie without an existing configure script, you should have autoconf for configuration and installation. To create tomcat-connectors's autoconf script, you will need libtool 1.5.2, automake 1.10 and autoconf 2.59 or newer. The use of more recent versions is encouraged, e.g. for reliable detection of the features of recent version of operating systems. Those tools will not be required if you are just using a package downloaded from apache.org, they are only required for developers. To create the configure script just type :
> > `[user@host] ~ $ ./buildconf.sh`
> Using configure to build mod_jk
> > Here's how to use configure to prepare mod_jk for building, just type:
> >     ./configure [autoconf arguments] [tomcat-connectors arguments]
> > You could set CFLAGS and LDFLAGS to add some platform specifics:
> > `[user@host] ~ $ LDFLAGS=-lc ./configure -with-apxs=/home2/local/apache/bin/apxs`
> If you want to build mod_jk for different version of Apache httpd, like 1.3, 2.x, you need to go through the full build process for each of them. Please note, that httpd 2.0 and 2.2 or 2.3 modules are not compatible. The mod_jk directory used is "apache-2.0" in both cases, but you need to compile separately. use configure and indicate the correct Apache httpd apxs location (--with-apxs) use make copy the resulting mod_jk.so binary from the apache-1.3 or apache-2.0 subdirectory to the Apache httpd modules location. make clean (to remove all previously compiled object files) Start over with the apxs location for your next Apache httpd version.
> configure arguments
> > Apache related parameters |
> > --- | ---
> > --with-apxs[=FILE] | FILE is the location of the apxs tool. Default is finding apxs in PATH. It builds a shared Apache module. It detects automatically the Apache version. (2.x and 1.3)
> > --with-apache=DIR | DIR is the path where apache sources are located. The apache sources should have been configured before configuring mod_jk. DIR is something like: /home/apache/apache_1.3.19 It builds a static Apache module.
> > --enable-EAPI | This parameter is needed when using Apache-1.3 and mod_ssl, otherwise you will get the error message: "this module might crash under EAPI!" when loading mod_jk.so in httpd. Not needed when --with-apxs has been used
> > --enable-prefork | In case you build mod_jk for a multi-threaded Apache httpd 2.x MPM (Multi-Processing Module), some areas of mod_jk code need to be synchronised to make it thread-safe. Because configure can not easily detect, whether your are using a multi-threaded MPM, mod_jk by default is always build thread-safe for Apache httpd 2.x. If you are sure, that your MPM is not multi-threaded, you can use "--enable-prefork" to force the removal of the synchronisation code (thus increasing performance a bit). For instance, the prefork MPM is not multi-threaded. For Apache httpd 1.3 this flag will be set automatically.
> > --disable-trace | When using log level "trace", mod_jk traces a lot of function calls with "enter" and "exit" log messages. Even if the log level is not "trace", comparing the log levels to decide about logging has some performance impact. If you use "--disable-trace", then the trace log code doesn't get compiled into the module binary and you might save some cycles during execution. Even with "--disable-trace" logging debug messages with debug log level will still be possible.
> > --enable-api-compatibility | Only use httpd API functions available in all httpd production releases of the chosen major httpd release branch. This improves binary compatibility of module builds with httpd releases older than the release against mod_jk is build (only between minor httpd versions).
> > --enable-flock | In case the operating system supports flock system call use this flag to enable this faster locks that are implemented as system call instead emulated by GNU C library. However those locks does not work on NFS mounted volumes, so you can use "--enable-flock" during compile time to force the flocks() calls.
> Examples of configure use
> > Apache 1.3 and 2.x build `[user@host] ~ $ ./configure --with-apxs=/usr/sbin/apxs` `[user@host] ~ $ make` `[user@host] ~ $ cp ./apache-1.3/mod_jk.so /usr/lib/apache` `[user@host] ~ $ make clean` `[user@host] ~ $ ./configure --with-apxs=/usr/sbin/apxs2` `[user@host] ~ $ make` `[user@host] ~ $ cp ./apache-2.0/mod_jk.so /usr/lib/apache2`
Building mod_jk for Apache on Windows NT/2K/XP
> The module was developed using Visual C++ version 6.0, so having this environment is a prerequisite if you want to perform a custom build. The steps that you need to take are: Change directory to the apache-1.3 or apache-2.0 source directory depending on your version of Apache. If you want to build mod_jk for Apache 1.3, set an APACHE1_HOME environment variable which points to where your Apache 1.3 is installed. A mod_jk module for Apache 2.x build will require APACHE2_HOME environment variable to be set. Copy mod_jk.so to Apache's modules directory. An example on how to build mod_jk for Apache 1.3:
> Set location for Apache 1.3 sources `c:\>set APACHE1_HOME=c:\apache13` Change directory to the mod_jk module for Apache 1.3 `c:\>cd c:\home\apache\jk\native\apache-1.3` Build the sources using MSDEV `c:\>MSDEV mod_jk.dsp /MAKE ALL` Copy the dll to your apache modules directory `c:\>cp release\mod_jk.so c:\apache13\modules\`
> An example on how to build mod_jk for Apache 2.x:
> Set location for Apache 2.x sources `c:\>set APACHE2_HOME=c:\apache20` Change directory to the mod_jk module for Apache 2.x `c:\>cd c:\home\apache\jk\native\apache-2.0` Build the sources using MSDEV `c:\>MSDEV mod_jk.dsp /MAKE ALL` Copy the dll to your apache modules directory `c:\>cp release\mod_jk.so c:\apache20\modules\`
If msdev is not in your path, enter the full path to msdev.exe. Also, ApacheCore.lib is expected to exist in the ${APACHEX_HOME}\src\CoreD and ${APACHEX_HOME}\src\CoreR directories before linking will succeed. You will need to build enough of the Apache source to create these libraries. This will build both release and debug versions of the redirector plug-in (mod_jk). An alternative will be to open mod_jk.dsp in msdev and build it using the build menu.
Building mod_jk for Apache on System I - i5/OS (OS400)
> Since OS400 V4R5, System I (AS/400) has used Apache 2.0 as their primary web server, replacing the old IBM webserver. It's now possible to build mod_jk on System I thanks to the help of the IBM Rochester Labs which has provided information and patches to adapt mod_jk to i5/OS. You should have at least Apache 2.0.58 (product 5722DG1), a C Compiler and IFS. Apache 2.0.58 is provided with the most recent set of PTFs for the iSeries Apache server, which can be found at http://www.ibm.com/servers/eserver/iseries/software/http/ The all latest Apache 2 for i5/OS V5R3 (or V5R4) is now 2.0.58 (as of 2007/04/17). Be sure to have the latest PTFs loaded if you want to make use of jk 1.2.15 and higher. NB: The latest mod_jk known to work on i5/OS V5R3 was 1.2.19. New in i5/OS V5R4, UTF is required, also for Apache modules, as such Apache modules do not require translations to/from EBCDIC but works should be done to port mod_jk 1.2.23 (and higher) to V5R4. From the V5R4 Infocenter : 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 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. Additionally, input data from the client will no longer be converted to EBCDIC but will be passed as-is. Output data sent from the module is not converted either so it must be encoded in ASCII or UTF8 as required. 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 indicate the encoding of the parameters being passed. Conversion functions between UTF-8 and EBCDIC have been added. Be sure to review APIs used by your module to be aware of current changes. To configure mod_jk on System I use the CL source provided with the mod_jk source. Get the latest mod_jk source and untar it on a Windows or Unix boxes Create a directory in IFS, ie /home/apache Send the whole jk source directory to System I directory via FTP. Then go to the System I command line :
> Create mod_jk library `===>CRTLIB MOD_JK TEXT(‘Apache mod'jk tomcat connector module')` Create service program source file `===>CRTSRCPF MOD_JK/QSRVSRC TEXT(‘Service program source file’)` Create the CL build program source file `===>CRTSRCPF FILE(MOD_JK/QCLSRC) TEXT(‘Build program source file’)` Edit the service program source file `===>STRSEU MOD_JK/QSRVSRC MOD_JK`
> In the edited file, specify that only jk_module should be exported :
> Columns . . : 1 71 Edit MOD_JK/QSRVSRC SEU==> MOD_JK *************** Beginning of data ************************************* 0001.00 STRPGMEXP PGMLVL(*CURRENT) 0002.00 EXPORT SYMBOL("jk_module") 0003.00 ENDPGMEXP ****************** End of data ****************************************
> You could start to build all the modules of mod_jk (cases for V5R4 or previous releases):
> Copy the CL build program source for i5/OS before V5R4 from IFS `===>CPYFRMSTMF FROMSTMF('/home/apache/jk/native/apache-2.0/bldjk.qclsrc') +` TOMBR('/QSYS.LIB/MOD_JK.LIB/QCLSRC.FILE/BLDJK.MBR') MBROPT(*REPLACE) Build the CL build program `===>CRTCLPGM PGM(MOD_JK/BLDJK) SRCFILE(MOD_JK/QCLSRC) TEXT('Apache mod_jk build program')` Launch the build `===>CALL MOD_JK/BLDJK` If the build if successfull, copy the new mod_jk module `===>CRTDUPOBJ OBJ(MOD_JK) FROMLIB(MOD_JK) OBJTYPE(*SRVPGM) TOLIB(QHTTPSVR) NEWOBJ(MOD_JK)`
> Copy the CL build program source for i5/OS V5R4 from IFS `===>CPYFRMSTMF FROMSTMF('/home/apache/jk/native/apache-2.0/bldjk54.qclsrc') +` TOMBR('/QSYS.LIB/MOD_JK.LIB/QCLSRC.FILE/BLDJK54.MBR') MBROPT(*REPLACE) Build the CL build program for i5/OS V5R4 `===>CRTCLPGM PGM(MOD_JK/BLDJK54) SRCFILE(MOD_JK/QCLSRC) TEXT('Apache mod_jk build program') TGTRLS(*CURRENT)` Launch the build for i5/OS V5R4 `===>CALL MOD_JK/BLDJK54` If the build if successfull, copy the new mod_jk module `===>CRTDUPOBJ OBJ(MOD_JK) FROMLIB(MOD_JK) OBJTYPE(*SRVPGM) TOLIB(QHTTPSVR) NEWOBJ(MOD_JK)`
> Next, you should restart your Apache 2.0 instance and enjoy this piece of OpenSource on System I.
> ENDTCPSVR SERVER(*HTTP) HTTPSVR(MYSERVER) STRTCPSVR SERVER(*HTTP) HTTPSVR(MYSERVER)
Building mod_jk for Apache on MacOS/X
> Mac OS X (10.2.x) build notes : Assuming that you are root :
> For Apache 1.3: `[user@host] ~ $ ./configure --with-apxs=/usr/sbin/apxs` `[user@host] ~ $ cd apache-1.3` `[user@host] ~ $ make -f Makefile.apxs` `[user@host] ~ $ cp mod_jk.so /etc/libexec/httpd` For Apache 2.x: `[user@host] ~ $ ./configure --with-apxs=/usr/local/apache2/bin/apxs` (you should point to the directory where you installed Apache 2.x) `[user@host] ~ $ cd apache-2.0` `[user@host] ~ $ make -f Makefile.apxs install`
Getting mod_jk linked statically with Apache
> mod_jk allows to install mod_jk in the Apache source tree to get a statically linked mod_jk. Having mod_jk in the httpd executable brings some performance improvements. The configure option --with-apache prepare mod_jk to install it in the Apache source tree. The option --with-apache works both for Apache 1.3 and Apache 2.x. The examples below show how to get mod_jk in the httpd process.
> Installation in Apache-2.x
> > /home/apache20/httpd-2.0.43 is the directory where the httpd-2.0 sources are located. `[user@host] ~ $ ./configure --with-apache=/home/apache20/httpd-2.0.43` `[user@host] ~ $ make` Install the mod_jk library and other files in /home/apache20/httpd-2.0.43/modules: `[user@host] ~ $ make install` It is not possible to configure Apache directly because the config.m4 of mod_jk must be added to the configure of httpd-2.x. `[user@host] ~ $ cd /home/apache20/httpd-2.0.43` `[user@host] ~ $ sh buildconf` `[user@host] ~ $ configure ... --with-mod_jk` `[user@host] ~ $ make` `[user@host] ~ $ make install`
> The enable-jk=share and enable-jk=static are not supported. --with-mod_jk only allow static linking of mod_jk.
> Installation in Apache-1.3
> > /home/apache/apache_1.3.27 is the directory where the apache-1.3 sources are located. `[user@host] ~ $ ./configure --with-apache=/home/apache/apache_1.3.27` `[user@host] ~ $ make` Install the libjk library, mod_jk.c, includes and other files in /home/apache/apache_1.3.27/src/modules/jk: `[user@host] ~ $ make install` Configure in the Apache sources: `[user@host] ~ $ cd /home/apache/apache_1.3.27` `[user@host] ~ $ configure ... --enable-module=dir --disable-shared=dir \` `--activate-module=src/modules/jk/libjk.a \` `--disable-shared=jk` `[user@host] ~ $ make` `[user@host] ~ $ make install`
> > The --enable-shared=jk is also working and builds a dso file.
> > Just change the configure in the Apache sources: `[user@host] ~ $ configure ... --enable-module=dir --enable-shared=dir \` `--activate-module=src/modules/jk/libjk.a \` `--enable-shared=jk`
Copyright © 1999-2012, Apache Software Foundation