<document>
  <header>
    <product>resin</product>
    <title>Resin with Apache</title>
    <description>
      <p>Resin provides a fast servlet runner for Apache 1.3 or greater,
         allowing Apache to run servlets and JSP files.
      </p>

      <p>If you have not yet done so, we suggest you use the <a
      href='install|httpd'>Resin standalone web server</a> option
      first.</p>

    </description>
  </header>

<body>
<summary/>

<section name="standalone" title="Before you integrate Resin with Apache">
<p>
Before integrating Resin with Apache, it is valuable to configure Resin as a
<a href="install|httpd">standalone server</a>, especially with more
complicated setups such as those involving virtual hosts.  Doing so isolates
the steps and makes troubleshooting easier.
</p>
 
<p>
Many users find that the performance, flexibility, and features of Resin
make Resin a desirable replacement for Apache.
</p>
</section>

<section name="dispatch" title="How Resin integrates with Apache">

<p>When used with Apache, Resin serves JSPs and Servlets and Apache serves
static content like html and images.  Apache is a frontend server, it handles
the request from the browser. Resin's <code>mod_caucho</code> plugin integrates
with Apache, it dispatches requests for JSPs and Servlets to one or more
backend Resin servers.</p>

<p> <figure src='apache_srun.gif'/> </p>

<p>
mod_caucho queries the backend server to distinguish the URLs going to Resin
from the URLs handled by Apache.  The backend server uses the
&lt;servlet-mapping> directives to decide which URLs to send.  Also, any *.war
file automatically gets all its URLs.  Other URLs stay with Apache.
</p>

<p>
There's a more complete discussion of the URL dispatching in the
<a href="plugin-dispatch.xtp">How the Plugins Dispatch to Resin</a> page.
</p>

</section> <!-- dispatch -->

<section name="unix" title='Unix Installation'>

<p>Resin needs Apache 1.3.x or greater and DSO support.</p>

<p>To configure Resin with Apache, you must follow the following steps:</p>
<ol>
<li>Compile Apache
<li>Compile mod_caucho.so
<li>Configure Apache
<li>Set up environment
<li>Configure resin.conf
<li>Restart Apache and start the backend Resin server
</ol>

<section title='Compiling Apache'>

<p>You need a version of Apache with DSO support enabled. Apache has
full documentation at <a href="external|apache|dso">their website</a>.
To check if your apache has DSO support, you can check for
<var/mod_so.c/> in your your httpd

<example title="checking apache httpd for mod_so.c">
unix> /usr/local/apache/bin/httpd -l
Compiled-in modules:
  ...
  mod_so.c
  ...
 </example>

<p>Many distributions, e.g. Red Hat Linux, will have Apache preinstalled.
However, because the standard distribution has files all over the
place, some people prefer to recompile Apache from scratch.</p>

<p>Once you untar Apache, build it like:</p>

<example>
unix> ./configure --prefix=/usr/local/apache --enable-module=so
unix> make
unix> make install
</example>

<p>Solaris versions of Apache may need additional flags, otherwise
you'll get some linking errors when trying to load Resin.  You may need
to refer to the Apache documentation if you get linking errors.  Here's an
example configuration on Solaris:</p>

<example>
unix> ./configure --prefix=/usr/local/apache \
                  --enable-rule=SHARED_CORE \
                  --enable-rule=SHARED_CHAIN \
                  --enable-module=so \
                  --enable-module=most \
                  --enable-shared=max
</example>

</section>

<section title='Compiling mod_caucho.so'>

<p>To compile and install <var/mod_caucho/> on Unix, you'll need to run
Resin's <code/configure/> and then make.  This step will create 
mod_caucho.so and put it in the Apache module directory.  Usually,
mod_caucho.so will end up in /usr/local/apache/libexec/mod_caucho.so.</p>

<p>If you know where your <var/apxs/> executable is, you can use --with-apxs.
<var/apxs/> is a little Perl script that the Apache configuration
makes.  It lets modules like Resin know how all the Apache directories
are configured.  It is generally in /usr/local/apache/bin/apxs or
/usr/sbin/apxs.  It's usually easiest to use --with-apxs so you don't
need to worry where all the Apache directories are.</p>

<example>
unix> ./configure --with-apxs=/usr/local/apache/bin/apxs
unix> make
</example>

<p>Even if you don't know where <var/apxs/> is, the configure script
can often find it:</p>

<example>
unix> ./configure --with-apxs
unix> make
</example>

<p>As an alternative to --with-apxs, if you've compiled Apache yourself,
or if you have a simple configuration, you can generally just point to
the Apache directory:</p>

<example>
unix> ./configure --with-apache=/usr/local/apache
unix> make
unix> make install
</example>

<p>The previous --with-apxs or --with-apache should cover most
configurations.  For some unusual configurations, you can have finer control
over each directory with the following arguments to ./configure.
In general, you should use --with-apache or --with-apxs, but the other
variables are there if you know what you're doing.</p>

<deftable>
<tr><td>--with-apache=dir<td>The Apache root directory.
<tr><td>--with-apxs=apxs<td>Pointer to the Apache extension script
<tr><td>--with-apache-include=dir<td>The Apache include directory
<tr><td>--with-apache-libexec=dir<td>The Apache module directory
<tr><td>--with-apache-conf=httpd.conf<td>The Apache config file
</deftable>

</section>

<section title='Configure the Environment'>

<p>If you don't already have Java installed, you'll need to download a
JDK and set some environment variables.</p>

<p>Here's a typical environment that you might put in ~/.profile or
/etc/profile</p>

<example>
# Java Location
JAVA_HOME=/&lt;installdir>/jdk1.4
export JAVA_HOME

# Resin location (optional).  Usually Resin can figure this out.
RESIN_HOME=/&lt;installdir>/resin-3.0.2
export RESIN_HOME

# If you're using additional class libraries, you'll need to put them
# in the classpath.
CLASSPATH=
</example>

</section>

</section> <!-- unix -->

<section name="windows" title='Windows Installation'>
<p>
The <code>setup.exe</code> program installs the mod_caucho.dll
plugin for any Apache it finds, and modifies the Apache httpd.conf file.
</p>

<p>
The httpd.conf file is also easily modified manually:
</p>

<example title=httpd.conf>
LoadModule caucho_module &lt;installdir>/resin-3.0.x/win32/apache-2.0/mod_caucho.dll

ResinConfigServer localhost 6802
&lt;Location /caucho-status>
  SetHandler caucho-status
&lt;/Location>
</example>

</section> <!-- windows -->


<section title='Configuring resin.conf'>

<p>
The communication between <code>mod_caucho</code> and the backend Resin
server takes place using an <var/srun/> port.
</p>

<p>
The <code>resin.conf</code> for the backend server contains
an <code>srun</code> to enable the port.  The default <code>resin.conf</code>
has an srun listener on port 6802.
</p>

<example title='resin.conf'>
&lt;resin xmlns="http://caucho.com/ns/resin"
       xmlns:resin="http://caucho.com/ns/resin/core"&gt;

  ...


  &lt;server&gt;

    ...

    &lt;cluster&gt;
      <b>&lt;srun server-id="" host="127.0.0.1" port="6802"/&gt;</b>
    &lt;/cluster&gt;

    ...

</example>


<p>
The resin.conf and the layout of your webapps should match the
layout that Apache expects.  The mapping of urls to filesystem locations
should be consistent between Apache and the backend Resin server.
</p>


<p>The default resin.conf looks in
<code>resin-3.0.x/webapps/ROOT</code> 
for JSP files and
<code>resin-3.0.x/webapps/ROOT/WEB-INF/classes</code>
for servlets and java source files.  To tell Resin
to use Apache's document area, you configure an explicit 
<var/web-app/> with the appropriate document-directory:
</p>

<example title='resin.conf'>
&lt;resin xmlns="http://caucho.com/ns/resin"
       xmlns:resin="http://caucho.com/ns/resin/core"&gt;

  ...

  &lt;server&gt;

    ...

    &lt;host id=""&gt;
 
      &lt;web-app id='/' document-directory="/usr/local/apache/htdocs"/&gt;

    &lt;/host&gt;

    ...

  &lt;/server&gt;
&lt;/resin&gt;
</example>

</section>

<section title='Starting the backend Resin server'>

<p>Now you need to start the backend Resin server.  Starting Resin is the same
with Apache or standalone.  See the <a href="httpd.xtp#deploy">httpd</a> page
for a detailed description.</p>

<example>
unix> bin/httpd.sh

win> httpd.exe
</example>

<results>
Resin 3.0.2-beta (built Mon Aug  4 09:26:44 PDT 2003)
Copyright(c) 1998-2003 Caucho Technology.  All rights reserved.
 
Starting Resin on Mon, 04 Aug 2003 09:43:39 -0700 (PDT)
[09:43:40.664] Loaded Socket JNI library.
[09:43:40.664] http listening to *:8080
[09:43:40.664] ServletServer[] starting
[09:43:40.879] hmux listening to *:6802
[09:43:41.073] Host[] starting
[09:43:41.446] Application[http://localhost:8080/resin-doc] starting
[09:43:41.496] Application[http://localhost:8080] starting
</results>

<p>
Resin will print every port it's listening to.  In the above example,
Resin has an http listener on port 8080 and an srun listener on port 6802
(using its custom `hmux' protocol).  mod_caucho establishes connections  to
Resin using port 6802, and a web browser can connect using port 8080.   Usually
the 8080 port will be unused, because web browsers will make requests to Apache,
these requests get dispatched to Resin as needed by mod_caucho.  A Resin
configured http listener on port 8080 is a useful debugging tool, it allows you
to bypass Apache and make a request straight to Resin.
</p>

<p>The following snippet shows the <var/&lt;http>/> and <var/&lt;srun>/>
configuration for the above example.</p>

<example>
&lt;resin xmlns="http://caucho.com/ns/resin">
  &lt;server>
    &lt;http id="" host="*" port="8080"/>

    &lt;cluster>
      &lt;srun id="" host="localhost" port="6802" index="1"/>
    &lt;/cluster>

    ...
  &lt;/server>
&lt;/resin>
</example>

</section>

<section title='Testing the servlet engine'>

<p>Create a test file '/usr/local/apache/htdocs/test.jsp'</p>

<example>
2 + 2 = &lt;%= 2 + 2 %>
</example>

<p>Browse http://localhost/test.jsp again.  You should now get</p>

<results>
2 + 2 = 4
</results>

</section>

<section name="httpd.conf" title='Configuring Apache httpd.conf'>

<p>
The installation process above automatically changes the httpd.conf file.
You can also configure the httpd.conf file manually, or modify the
default configuration created by the installation process.
</p>

<example title="Unix - httpd.conf">
LoadModule caucho_module libexec/mod_caucho.so

ResinConfigServer localhost 6802
&lt;Location /caucho-status>
  SetHandler caucho-status
&lt;/Location>
</example>

<example title="Windows - httpd.conf">
LoadModule caucho_module &lt;installdir>/resin-3.0.x/libexec/apache-2.0/mod_caucho.dll

ResinConfigServer localhost 6802
&lt;Location /caucho-status>
  SetHandler caucho-status
&lt;/Location>
</example>

<p>
The <code>ResinConfigServer</code> is used to tell mod_caucho how to contact
the backend Resin server.  The backend Resin server tell's mod_caucho which urls
should be dispatched.
</p>

<deftable>
<tr><th>Apache Command<th>Meaning
<tr><td>ResinConfigServer <var/host/> <var/port/><td>Specifies the Resin JVM at <var/host:port/> as a configuration server.
</deftable>

<section name="caucho-status" title="caucho-status">

<p>
<code>caucho-status</code> is optional and probably should be avoided in
a production site.  It lets you ask the Caucho Apache module about it's
configuration, and the status of the backend server(s), valuable for
debugging.
</p>

<p>After any change to httpd.conf, restart Apache.  Now browse
http://localhost/caucho-status.</p>

</section>

<section name="manual-dispatch" title="Manual configuration of dispatching">

<p>
You can also dispatch to Resin directly from the httpd.conf.  Instead of
relying on the ResinConfigServer directive to determine which url's to dispatch
to the backend server, Apache handler's are used to specify the url's to
dispatch.
</p>

<example>
CauchoHost 127.0.0.1 6802

&lt;Location /foo/*>
  SetHandler caucho-request
&lt;/Location>
</example>

<deftable>
<tr><th width="30%">Apache Command<th>Meaning
<tr><td>CauchoHost <var/host/> <var/port/><td>Alternative to <var/ResinConfigServer/>, adds the Resin JVM with an srun port at host:port as a backend server.
<tr><td>CauchoBackup <var/host/> <var/port/><td>Alternative to <var/ResinConfigServer/>, adds the Resin JVM with an srun port at host:port as a backup backend server.
</deftable>

<deftable>
<tr><th width="30%">Apache Handler<th>Meaning
<tr><td>caucho-status<td>Handler to display /caucho-status
<tr><td>caucho-request<td>Dispatch a request to Resin
</deftable>

<p>
Requests dispatched directly from the Apache httpd.conf will not
appear in /caucho-status.
</p>

</section>  <!-- manual-dispatch -->

</section>  <!-- httpd.conf -->


<section name="vhosts" title="Virtual Hosts">

<p>
The <a href="doc|config|virtual-host">virtual host</a> topic describes virtual
hosts in detail.  If you're using a single JVM, you only need to configure
the resin.conf.
</p>

<example title="httpd.conf">
LoadModule caucho_module libexec/mod_caucho.so

ResinConfigServer 192.168.0.1 6802
&lt;Location /caucho-status>
  SetHandler caucho-status
&lt;/Location>
</example>

<example title='resin.conf'>
&lt;resin xmlns="http://caucho.com/ns/resin">
&lt;server>
  &lt;cluster>
    &lt;srun id="" host="192.168.0.1" port="6802"/>
  &lt;/cluster>

  &lt;host id='www.gryffindor.com'>
    &lt;host-alias&gt;gryffindor.com&lt;/host-alias&gt;
     ...
  &lt;/host>

  &lt;host id='www.slytherin.com'>
    &lt;host-alias&gt;slytherin.com&lt;/host-alias&gt;
     ...
  &lt;/host>
&lt;/server>
&lt;/resin>
</example>

<section name="vhostperjvm" title="Virtual Host per JVM">

<p>
If you want a different JVM for each virtual host, your
httpd.conf can specify a different srun port for each host.
</p>

<example title='httpd.conf'>
&lt;VirtualHost gryffindor.com>
ServerName gryffindor.com
ServerAlias www.gryffindor.com
ResinConfigServer 192.168.0.1 6802
&lt;/VirtualHost>

&lt;VirtualHost slytherin.com>
ServerName slytherin.com
ServerAlias www.slytherin.com
ResinConfigServer 192.168.0.1 6803
&lt;/VirtualHost>
</example>

<example title='gryffindor.conf'>
&lt;resin xmlns="http://caucho.com/ns/resin">
&lt;server>
  &lt;cluster>
    &lt;srun id="" host="192.168.0.1" port="6802"/>
  &lt;/cluster>

  &lt;host id=''>
     ...
  &lt;/host>
&lt;/server>
&lt;/resin>
</example>

<example title='slytherin.conf'>
&lt;resin xmlns="http://caucho.com/ns/resin">
&lt;server>
  &lt;cluster>
    &lt;srun id="" host="192.168.0.1" port="6803"/>
  &lt;/cluster>

  &lt;host id=''>
     ...
  &lt;/host>
&lt;/server>
&lt;/resin>
</example>

<example>
$ bin/httpd.sh -pid gryffindor.pid -conf conf/gryffindor.conf start
$ bin/httpd.sh -pid slytherin.pid -conf conf/slytherin.conf start

...

$ bin/httpd.sh -pid gryffindor.pid stop

</example>

</section> <!-- vhostperjvm -->

</section>  <!-- vhosts -->


<section name="balance" title="Load Balancing">

<p>The <a href="doc|config|balance">Reliability and Load Balancing</a>
section provides an introduction to the concepts of load balancing.</p>

<p>mod_caucho recognizes cluster configurations for load balancing. 
Requests are distributed to all machines in the cluster, all
requests in a session will go to the same host, and if one host goes down,
Resin will send the request to the next available machine.
Optional backup machines only receive requests if all of the primaries are
down.</p>

<example title="resin.conf">
&lt;resin xmlns="http://caucho.com/ns/resin">
&lt;server>
  &lt;cluster>
    &lt;srun id="a" host="192.168.0.11" port="6802" index="1"/>
    &lt;srun id="b" host="192.168.0.11" port="6803" index="2" backup="true"/>
    &lt;srun id="c" host="192.168.0.12" port="6802" index="3"/>
    &lt;srun id="d" host="192.168.0.12" port="6803" index="4" backup="true"/>
  &lt;/cluster>
  ...
&lt;/server>
&lt;/resin>
</example>

<p>
mod_caucho only needs to know about one of the backend servers. It will query
that backend server, and learn about all of the other members of the cluster.
</p>

<example>
ResinConfigServer 192.168.0.11 6802
</example>

<p>
mod_caucho keeps a local cache of the configuration information, so if the
backend server becomes unavailable then the cached configuration will be used
until the backend server becomes available again.
</p>

<p>
The httpd.conf file can also specify more than one backend server, when
mod_caucho checks for configuration updates, it will check each in turn, and
only if none of them are available will it use the local cached copy.
</p>

<example>
ResinConfigServer 192.168.0.11 6802
ResinConfigServer 192.168.0.12 6802
</example>

<section name="manual-dispatch-balance" title="Manual configuration of load balanced dispatching">
<p>
Manual dispatching in httpd.conf can also specify the backend hosts and the backend backup hosts, as an alternative to using <code>ResinConfigServer</code>.
</p>

<example>
CauchoHost 192.168.0.11 6802
CauchoBackup 192.168.0.11 6803
CauchoHost 192.168.0.12 6802
CauchoBackup 192.168.0.12 6803

&lt;Location /foo/*>
  SetHandler caucho-request
&lt;/Location>
</example>

</section> <!-- manual-dispatch-balance -->

<section name="manual-dispatch-location" title="Manual configuration of location based dispatching">

<example>
&lt;Location /applicationA/*&gt;
  ResinConfigServer 192.168.0.11 6802
&lt;/Location&gt;

&lt;Location /applicationB/*&gt;
  ResinConfigServer 192.168.0.12 6802
&lt;/Location&gt;
</example>

</section> <!-- manual-dispatch-location -->

</section> <!-- balance -->

<section title='Troubleshooting'>

<ol>
<li>First, check your configuration with Resin standalone.sh.
In other words, add a &lt;http port='8080'/> and check port 8080.
<li>Check http://localhost/caucho-status.  That will tell if
mod_caucho has properly connected to the backend Resin server.
<li>Each srun host should be green and the mappings should
match your resin.conf.
<li>If caucho-status fails entirely, the problem is in the mod_caucho
installation and the Apache httpd.conf.
<li>If caucho-status shows the wrong mappings, there's something wrong
with the resin.conf or the pointer to the backend server in httpd.conf.
<li>If caucho-status shows a red servlet runner, then Resin hasn't
properly started.
<li>If you get a "cannot connect to servlet engine", caucho-status
will show red, and Resin hasn't started properly.
<li>If Resin doesn't start properly, you should look at the logs
in resin-3.0.x/log.  You should start <var/httpd.sh -verbose/> or
<var/httpd.exe -verbose/> to get more information.
<li>If Resin never shows a "srun listening to *:6802" line,
it's not listening for connections from mod_caucho.
 You'll need to add a &lt;srun> line.
<li>If you get Resin's "file not found", the Apache configuration
is good but the resin.conf probably points to the wrong directories.
</ol>

</section>
  </body>
</document>
