| 1 | <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 value="Craig R. McClanahan" name="author"><meta value="craigmcc@apache.org" name="email"></head><body vlink="#525D76" alink="#525D76" link="#525D76" text="#000000" bgcolor="#ffffff"><table cellspacing="0" width="100%" border="0"><!--PAGE HEADER--><tr><td><!--PROJECT LOGO--><a href="http://tomcat.apache.org/"><img border="0" alt=" |
|---|
| 2 | The Apache Tomcat Servlet/JSP Container |
|---|
| 3 | " align="right" src="./../images/tomcat.gif"></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 border="0" alt="Apache Logo" align="right" src="./../images/asf-logo.gif"></a></td></tr></table><table cellspacing="4" width="100%" border="0"><!--HEADER SEPARATOR--><tr><td colspan="2"><hr size="1" noshade></td></tr><tr><!--RIGHT SIDE MAIN BODY--><td align="left" valign="top" width="80%"><table cellspacing="4" width="100%" border="0"><tr><td valign="top" align="left"><h1>Apache Tomcat 6.0</h1><h2>Proxy Support HOW-TO</h2></td><td nowrap="true" valign="top" align="right"><img border="0" hspace="0" vspace="0" height="1" width="1" src="./../images/void.gif"></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Introduction"><strong>Introduction</strong></a></font></td></tr><tr><td><blockquote> |
|---|
| 4 | |
|---|
| 5 | <p>Using standard configurations of Tomcat, web applications can ask for |
|---|
| 6 | the server name and port number to which the request was directed for |
|---|
| 7 | processing. When Tomcat is running standalone with the |
|---|
| 8 | <a href="../config/coyote.html">Coyote HTTP/1.1 Connector</a>, it will generally |
|---|
| 9 | report the server name specified in the request, and the port number on |
|---|
| 10 | which the <strong>Connector</strong> is listening. The servlet API |
|---|
| 11 | calls of interest, for this purpose, are:</p> |
|---|
| 12 | <ul> |
|---|
| 13 | <li><code>ServletRequest.getServerName()</code>: Returns the host name of the server to which the request was sent.</li> |
|---|
| 14 | <li><code>ServletRequest.getServerPort()</code>: Returns the host name of the server to which the request was sent.</li> |
|---|
| 15 | <li><code>ServletRequest.getLocalName()</code>: Returns the host name of the Internet Protocol (IP) interface on which the request was received.</li> |
|---|
| 16 | <li><code>ServletRequest.getLocalPort()</code>: Returns the Internet Protocol (IP) port number of the interface on which the request was received.</li> |
|---|
| 17 | </ul> |
|---|
| 18 | |
|---|
| 19 | <p>When you are running behind a proxy server (or a web server that is |
|---|
| 20 | configured to behave like a proxy server), you will sometimes prefer to |
|---|
| 21 | manage the values returned by these calls. In particular, you will |
|---|
| 22 | generally want the port number to reflect that specified in the original |
|---|
| 23 | request, not the one on which the <strong>Connector</strong> itself is |
|---|
| 24 | listening. You can use the <code>proxyName</code> and <code>proxyPort</code> |
|---|
| 25 | attributes on the <code><Connector></code> element to configure |
|---|
| 26 | these values.</p> |
|---|
| 27 | |
|---|
| 28 | <p>Proxy support can take many forms. The following sections describe |
|---|
| 29 | proxy configurations for several common cases.</p> |
|---|
| 30 | |
|---|
| 31 | </blockquote></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Apache 1.3 Proxy Support"><strong>Apache 1.3 Proxy Support</strong></a></font></td></tr><tr><td><blockquote> |
|---|
| 32 | |
|---|
| 33 | <p>Apache 1.3 supports an optional module (<code>mod_proxy</code>) that |
|---|
| 34 | configures the web server to act as a proxy server. This can be used to |
|---|
| 35 | forward requests for a particular web application to a Tomcat 6 instance, |
|---|
| 36 | without having to configure a web connector such as <code>mod_jk</code>. |
|---|
| 37 | To accomplish this, you need to perform the following tasks:</p> |
|---|
| 38 | <ol> |
|---|
| 39 | <li>Configure your copy of Apache so that it includes the |
|---|
| 40 | <code>mod_proxy</code> module. If you are building from source, |
|---|
| 41 | the easiest way to do this is to include the |
|---|
| 42 | <code>--enable-module=proxy</code> directive on the |
|---|
| 43 | <code>./configure</code> command line.</li> |
|---|
| 44 | <li>If not already added for you, make sure that you are loading the |
|---|
| 45 | <code>mod_proxy</code> module at Apache startup time, by using the |
|---|
| 46 | following directives in your <code>httpd.conf</code> file: |
|---|
| 47 | <div align="left"><table border="0" cellpadding="0" cellspacing="4"><tr><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="./../images/void.gif"></td><td height="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="./../images/void.gif"></td><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="./../images/void.gif"></td></tr><tr><td width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="./../images/void.gif"></td><td height="1" bgcolor="#ffffff"><pre> |
|---|
| 48 | LoadModule proxy_module {path-to-modules}/mod_proxy.so |
|---|
| 49 | AddModule mod_proxy.c |
|---|
| 50 | </pre></td><td width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="./../images/void.gif"></td></tr><tr><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="./../images/void.gif"></td><td height="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="./../images/void.gif"></td><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="./../images/void.gif"></td></tr></table></div></li> |
|---|
| 51 | <li>Include two directives in your <code>httpd.conf</code> file for |
|---|
| 52 | each web application that you wish to forward to Tomcat 6. For |
|---|
| 53 | example, to forward an application at context path <code>/myapp</code>: |
|---|
| 54 | <div align="left"><table border="0" cellpadding="0" cellspacing="4"><tr><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="./../images/void.gif"></td><td height="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="./../images/void.gif"></td><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="./../images/void.gif"></td></tr><tr><td width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="./../images/void.gif"></td><td height="1" bgcolor="#ffffff"><pre> |
|---|
| 55 | ProxyPass /myapp http://localhost:8081/myapp |
|---|
| 56 | ProxyPassReverse /myapp http://localhost:8081/myapp |
|---|
| 57 | </pre></td><td width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="./../images/void.gif"></td></tr><tr><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="./../images/void.gif"></td><td height="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="./../images/void.gif"></td><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="./../images/void.gif"></td></tr></table></div> |
|---|
| 58 | which tells Apache to forward URLs of the form |
|---|
| 59 | <code>http://localhost/myapp/*</code> to the Tomcat 6 connector |
|---|
| 60 | listening on port 8081.</li> |
|---|
| 61 | <li>Configure your copy of Tomcat 6 to include a special |
|---|
| 62 | <code><Connector></code> element, with appropriate |
|---|
| 63 | proxy settings, for example: |
|---|
| 64 | <div align="left"><table border="0" cellpadding="0" cellspacing="4"><tr><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="./../images/void.gif"></td><td height="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="./../images/void.gif"></td><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="./../images/void.gif"></td></tr><tr><td width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="./../images/void.gif"></td><td height="1" bgcolor="#ffffff"><pre> |
|---|
| 65 | <Connector port="8081" ... |
|---|
| 66 | proxyName="www.mycompany.com" |
|---|
| 67 | proxyPort="80"/> |
|---|
| 68 | </pre></td><td width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="./../images/void.gif"></td></tr><tr><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="./../images/void.gif"></td><td height="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="./../images/void.gif"></td><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="./../images/void.gif"></td></tr></table></div> |
|---|
| 69 | which will cause servlets inside this web application to think that |
|---|
| 70 | all proxied requests were directed to <code>www.mycompany.com</code> |
|---|
| 71 | on port 80.</li> |
|---|
| 72 | <li>It is legal to omit the <code>proxyName</code> attribute from the |
|---|
| 73 | <code><Connector></code> element. If you do so, the value |
|---|
| 74 | returned by <code>request.getServerName()</code> will by the host |
|---|
| 75 | name on which Tomcat is running. In the example above, it would be |
|---|
| 76 | <code>localhost</code>.</li> |
|---|
| 77 | <li>If you also have a <code><Connector></code> listening on port |
|---|
| 78 | 8080 (nested within the same <a href="../config/service.html">Service</a> |
|---|
| 79 | element), the requests to either port will share the same set of |
|---|
| 80 | virtual hosts and web applications.</li> |
|---|
| 81 | <li>You might wish to use the IP filtering features of your operating |
|---|
| 82 | system to restrict connections to port 8081 (in this example) to |
|---|
| 83 | be allowed <strong>only</strong> from the server that is running |
|---|
| 84 | Apache.</li> |
|---|
| 85 | <li>Alternatively, you can set up a series of web applications that are |
|---|
| 86 | only available via proxying, as follows: |
|---|
| 87 | <ul> |
|---|
| 88 | <li>Configure another <code><Service></code> that contains |
|---|
| 89 | only a <code><Connector></code> for the proxy port.</li> |
|---|
| 90 | <li>Configure appropriate <a href="../config/engine.html">Engine</a>, |
|---|
| 91 | <a href="../config/host.html">Host</a>, and |
|---|
| 92 | <a href="../config/context.html">Context</a> elements for the virtual hosts |
|---|
| 93 | and web applications accessible via proxying.</li> |
|---|
| 94 | <li>Optionally, protect port 8081 with IP filters as described |
|---|
| 95 | earlier.</li> |
|---|
| 96 | </ul></li> |
|---|
| 97 | <li>When requests are proxied by Apache, the web server will be recording |
|---|
| 98 | these requests in its access log. Therefore, you will generally want to |
|---|
| 99 | disable any access logging performed by Tomcat itself.</li> |
|---|
| 100 | </ol> |
|---|
| 101 | |
|---|
| 102 | <p>When requests are proxied in this manner, <strong>all</strong> requests |
|---|
| 103 | for the configured web applications will be processed by Tomcat (including |
|---|
| 104 | requests for static content). You can improve performance by using the |
|---|
| 105 | <code>mod_jk</code> web connector instead of <code>mod_proxy</code>. |
|---|
| 106 | <code>mod_jk</code> can be configured so that the web server serves static |
|---|
| 107 | content that is not processed by filters or security constraints defined |
|---|
| 108 | within the web application's deployment descriptor |
|---|
| 109 | (<code>/WEB-INF/web.xml</code>).</p> |
|---|
| 110 | |
|---|
| 111 | </blockquote></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Apache 2.0 Proxy Support"><strong>Apache 2.0 Proxy Support</strong></a></font></td></tr><tr><td><blockquote> |
|---|
| 112 | The same instructions hold true as for 1.3. (Except in Apache 2.0, |
|---|
| 113 | you may omit <code>AddModule mod_proxy.c</code>) |
|---|
| 114 | </blockquote></td></tr></table></td></tr><!--FOOTER SEPARATOR--><tr><td colspan="2"><hr size="1" noshade></td></tr><!--PAGE FOOTER--><tr><td colspan="2"><div align="center"><font size="-1" color="#525D76"><em> |
|---|
| 115 | Copyright © 1999-2008, Apache Software Foundation |
|---|
| 116 | </em></font></div></td></tr></table></body></html> |
|---|
