116 lines
12 KiB
HTML
116 lines
12 KiB
HTML
|
<html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Apache Tomcat 6.0 - Proxy Support HOW-TO</title><meta name="author" value="Craig R. McClanahan"><meta name="email" value="craigmcc@apache.org"></head><body bgcolor="#ffffff" text="#000000" link="#525D76" alink="#525D76" vlink="#525D76"><table border="0" width="100%" cellspacing="0"><!--PAGE HEADER--><tr><td><!--PROJECT LOGO--><a href="http://tomcat.apache.org/"><img src="./../images/tomcat.gif" align="right" alt="
|
||
|
|
The Apache Tomcat Servlet/JSP Container
|
||
|
|
" border="0"></a></td><td><font face="arial,helvetica,sanserif"><h1>Apache Tomcat 6.0</h1></font></td><td><!--APACHE LOGO--><a href="http://www.apache.org/"><img src="./../images/asf-logo.gif" align="right" alt="Apache Logo" border="0"></a></td></tr></table><table border="0" width="100%" cellspacing="4"><!--HEADER SEPARATOR--><tr><td colspan="2"><hr noshade="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>Apache Tomcat 6.0</h1><h2>Proxy Support HOW-TO</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"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Introduction"><strong>Introduction</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
|
||
|
|
<p>Using standard configurations of Tomcat, web applications can ask for
|
||
|
|
the server name and port number to which the request was directed for
|
||
|
|
processing. When Tomcat is running standalone with the
|
||
|
|
<a href="../config/coyote.html">Coyote HTTP/1.1 Connector</a>, it will generally
|
||
|
|
report the server name specified in the request, and the port number on
|
||
|
|
which the <strong>Connector</strong> is listening. The servlet API
|
||
|
|
calls of interest, for this purpose, are:</p>
|
||
|
|
<ul>
|
||
|
|
<li><code>ServletRequest.getServerName()</code>: Returns the host name of the server to which the request was sent.</li>
|
||
|
|
<li><code>ServletRequest.getServerPort()</code>: Returns the host name of the server to which the request was sent.</li>
|
||
|
|
<li><code>ServletRequest.getLocalName()</code>: Returns the host name of the Internet Protocol (IP) interface on which the request was received.</li>
|
||
|
|
<li><code>ServletRequest.getLocalPort()</code>: Returns the Internet Protocol (IP) port number of the interface on which the request was received.</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<p>When you are running behind a proxy server (or a web server that is
|
||
|
|
configured to behave like a proxy server), you will sometimes prefer to
|
||
|
|
manage the values returned by these calls. In particular, you will
|
||
|
|
generally want the port number to reflect that specified in the original
|
||
|
|
request, not the one on which the <strong>Connector</strong> itself is
|
||
|
|
listening. You can use the <code>proxyName</code> and <code>proxyPort</code>
|
||
|
|
attributes on the <code><Connector></code> element to configure
|
||
|
|
these values.</p>
|
||
|
|
|
||
|
|
<p>Proxy support can take many forms. The following sections describe
|
||
|
|
proxy configurations for several common cases.</p>
|
||
|
|
|
||
|
|
</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Apache 1.3 Proxy Support"><strong>Apache 1.3 Proxy Support</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
|
||
|
|
<p>Apache 1.3 supports an optional module (<code>mod_proxy</code>) that
|
||
|
|
configures the web server to act as a proxy server. This can be used to
|
||
|
|
forward requests for a particular web application to a Tomcat 6 instance,
|
||
|
|
without having to configure a web connector such as <code>mod_jk</code>.
|
||
|
|
To accomplish this, you need to perform the following tasks:</p>
|
||
|
|
<ol>
|
||
|
|
<li>Configure your copy of Apache so that it includes the
|
||
|
|
<code>mod_proxy</code> module. If you are building from source,
|
||
|
|
the easiest way to do this is to include the
|
||
|
|
<code>--enable-module=proxy</code> directive on the
|
||
|
|
<code>./configure</code> command line.</li>
|
||
|
|
<li>If not already added for you, make sure that you are loading the
|
||
|
|
<code>mod_proxy</code> module at Apache startup time, by using the
|
||
|
|
following directives in your <code>httpd.conf</code> file:
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
LoadModule proxy_module {path-to-modules}/mod_proxy.so
|
||
|
|
AddModule mod_proxy.c
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="./../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="./../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div></li>
|
||
|
|
<li>Include two directives in your <code>httpd.conf</code> file for
|
||
|
|
each web application that you wish to forward to Tomcat 5. For
|
||
|
|
example, to forward an application at context path <code>/myapp</code>:
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
ProxyPass /myapp http://localhost:8081/myapp
|
||
|
|
ProxyPassReverse /myapp http://localhost:8081/myapp
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="./../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="./../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
which tells Apache to forward URLs of the form
|
||
|
|
<code>http://localhost/myapp/*</code> to the Tomcat 5 connector
|
||
|
|
listening on port 8081.</li>
|
||
|
|
<li>Configure your copy of Tomcat 5 to include a special
|
||
|
|
<code><Connector></code> element, with appropriate
|
||
|
|
proxy settings, for example:
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
<Connector port="8081" ...
|
||
|
|
proxyName="www.mycompany.com"
|
||
|
|
proxyPort="80"/>
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="./../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="./../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
which will cause servlets inside this web application to think that
|
||
|
|
all proxied requests were directed to <code>www.mycompany.com</code>
|
||
|
|
on port 80.</li>
|
||
|
|
<li>It is legal to omit the <code>proxyName</code> attribute from the
|
||
|
|
<code><Connector></code> element. If you do so, the value
|
||
|
|
returned by <code>request.getServerName()</code> will by the host
|
||
|
|
name on which Tomcat is running. In the example above, it would be
|
||
|
|
<code>localhost</code>.</li>
|
||
|
|
<li>If you also have a <code><Connector></code> listening on port
|
||
|
|
8080 (nested within the same <a href="../config/service.html">Service</a>
|
||
|
|
element), the requests to either port will share the same set of
|
||
|
|
virtual hosts and web applications.</li>
|
||
|
|
<li>You might wish to use the IP filtering features of your operating
|
||
|
|
system to restrict connections to port 8081 (in this example) to
|
||
|
|
be allowed <strong>only</strong> from the server that is running
|
||
|
|
Apache.</li>
|
||
|
|
<li>Alternatively, you can set up a series of web applications that are
|
||
|
|
only available via proxying, as follows:
|
||
|
|
<ul>
|
||
|
|
<li>Configure another <code><Service></code> that contains
|
||
|
|
only a <code><Connector></code> for the proxy port.</li>
|
||
|
|
<li>Configure appropriate <a href="../config/engine.html">Engine</a>,
|
||
|
|
<a href="../config/host.html">Host</a>, and
|
||
|
|
<a href="../config/context.html">Context</a> elements for the virtual hosts
|
||
|
|
and web applications accessible via proxying.</li>
|
||
|
|
<li>Optionally, protect port 8081 with IP filters as described
|
||
|
|
earlier.</li>
|
||
|
|
</ul></li>
|
||
|
|
<li>When requests are proxied by Apache, the web server will be recording
|
||
|
|
these requests in its access log. Therefore, you will generally want to
|
||
|
|
disable any access logging performed by Tomcat itself.</li>
|
||
|
|
</ol>
|
||
|
|
|
||
|
|
<p>When requests are proxied in this manner, <strong>all</strong> requests
|
||
|
|
for the configured web applications will be processed by Tomcat (including
|
||
|
|
requests for static content). You can improve performance by using the
|
||
|
|
<code>mod_jk</code> web connector instead of <code>mod_proxy</code>.
|
||
|
|
<code>mod_jk</code> can be configured so that the web server serves static
|
||
|
|
content that is not processed by filters or security constraints defined
|
||
|
|
within the web application's deployment descriptor
|
||
|
|
(<code>/WEB-INF/web.xml</code>).</p>
|
||
|
|
|
||
|
|
</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Apache 2.0 Proxy Support"><strong>Apache 2.0 Proxy Support</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
The same instructions hold true as for 1.3. (Except in Apache 2.0,
|
||
|
|
you may omit <code>AddModule mod_proxy.c</code>)
|
||
|
|
</blockquote></td></tr></table></td></tr><!--FOOTER SEPARATOR--><tr><td colspan="2"><hr noshade="noshade" size="1"></td></tr><!--PAGE FOOTER--><tr><td colspan="2"><div align="center"><font color="#525D76" size="-1"><em>
|
||
|
|
Copyright © 1999-2006, Apache Software Foundation
|
||
|
|
</em></font></div></td></tr></table></body></html>
|