| <html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Apache Tomcat 7 (7.0.77) - Proxy Support HOW-TO</title><meta name="author" content="Craig R. McClanahan"><style type="text/css" media="print"> | |
| .noPrint {display: none;} | |
| td#mainBody {width: 100%;} | |
| </style><style type="text/css"> | |
| code {background-color:rgb(224,255,255);padding:0 0.1em;} | |
| code.attributeName, code.propertyName {background-color:transparent;} | |
| table { | |
| border-collapse: collapse; | |
| text-align: left; | |
| } | |
| table *:not(table) { | |
| /* Prevent border-collapsing for table child elements like <div> */ | |
| border-collapse: separate; | |
| } | |
| th { | |
| text-align: left; | |
| } | |
| div.codeBox pre code, code.attributeName, code.propertyName, code.noHighlight, .noHighlight code { | |
| background-color: transparent; | |
| } | |
| div.codeBox { | |
| overflow: auto; | |
| margin: 1em 0; | |
| } | |
| div.codeBox pre { | |
| margin: 0; | |
| padding: 4px; | |
| border: 1px solid #999; | |
| border-radius: 5px; | |
| background-color: #eff8ff; | |
| display: table; /* To prevent <pre>s from taking the complete available width. */ | |
| /* | |
| When it is officially supported, use the following CSS instead of display: table | |
| to prevent big <pre>s from exceeding the browser window: | |
| max-width: available; | |
| width: min-content; | |
| */ | |
| } | |
| div.codeBox pre.wrap { | |
| white-space: pre-wrap; | |
| } | |
| table.defaultTable tr, table.detail-table tr { | |
| border: 1px solid #CCC; | |
| } | |
| table.defaultTable tr:nth-child(even), table.detail-table tr:nth-child(even) { | |
| background-color: #FAFBFF; | |
| } | |
| table.defaultTable tr:nth-child(odd), table.detail-table tr:nth-child(odd) { | |
| background-color: #EEEFFF; | |
| } | |
| table.defaultTable th, table.detail-table th { | |
| background-color: #88b; | |
| color: #fff; | |
| } | |
| table.defaultTable th, table.defaultTable td, table.detail-table th, table.detail-table td { | |
| padding: 5px 8px; | |
| } | |
| p.notice { | |
| border: 1px solid rgb(255, 0, 0); | |
| background-color: rgb(238, 238, 238); | |
| color: rgb(0, 51, 102); | |
| padding: 0.5em; | |
| margin: 1em 2em 1em 1em; | |
| } | |
| </style></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><h1><font face="arial,helvetica,sanserif">Apache Tomcat 7</font></h1><font face="arial,helvetica,sanserif">Version 7.0.77, Mar 28 2017</font></td><td><!--APACHE LOGO--><a href="http://www.apache.org/"><img src="./images/asf-logo.svg" align="right" alt="Apache Logo" border="0" style="width: 266px;height: 83px;"></a></td></tr></table><table border="0" width="100%" cellspacing="4"><!--HEADER SEPARATOR--><tr><td colspan="2"><hr noshade size="1"></td></tr><tr><!--LEFT SIDE NAVIGATION--><td width="20%" valign="top" nowrap class="noPrint"><p><strong>Links</strong></p><ul><li><a href="index.html">Docs Home</a></li><li><a href="http://wiki.apache.org/tomcat/FAQ">FAQ</a></li><li><a href="#comments_section">User Comments</a></li></ul><p><strong>User Guide</strong></p><ul><li><a href="introduction.html">1) Introduction</a></li><li><a href="setup.html">2) Setup</a></li><li><a href="appdev/index.html">3) First webapp</a></li><li><a href="deployer-howto.html">4) Deployer</a></li><li><a href="manager-howto.html">5) Manager</a></li><li><a href="realm-howto.html">6) Realms and AAA</a></li><li><a href="security-manager-howto.html">7) Security Manager</a></li><li><a href="jndi-resources-howto.html">8) JNDI Resources</a></li><li><a href="jndi-datasource-examples-howto.html">9) JDBC DataSources</a></li><li><a href="class-loader-howto.html">10) Classloading</a></li><li><a href="jasper-howto.html">11) JSPs</a></li><li><a href="ssl-howto.html">12) SSL/TLS</a></li><li><a href="ssi-howto.html">13) SSI</a></li><li><a href="cgi-howto.html">14) CGI</a></li><li><a href="proxy-howto.html">15) Proxy Support</a></li><li><a href="mbeans-descriptors-howto.html">16) MBeans Descriptors</a></li><li><a href="default-servlet.html">17) Default Servlet</a></li><li><a href="cluster-howto.html">18) Clustering</a></li><li><a href="balancer-howto.html">19) Load Balancer</a></li><li><a href="connectors.html">20) Connectors</a></li><li><a href="monitoring.html">21) Monitoring and Management</a></li><li><a href="logging.html">22) Logging</a></li><li><a href="apr.html">23) APR/Native</a></li><li><a href="virtual-hosting-howto.html">24) Virtual Hosting</a></li><li><a href="aio.html">25) Advanced IO</a></li><li><a href="extras.html">26) Additional Components</a></li><li><a href="maven-jars.html">27) Mavenized</a></li><li><a href="security-howto.html">28) Security Considerations</a></li><li><a href="windows-service-howto.html">29) Windows Service</a></li><li><a href="windows-auth-howto.html">30) Windows Authentication</a></li><li><a href="jdbc-pool.html">31) Tomcat's JDBC Pool</a></li><li><a href="web-socket-howto.html">32) WebSocket</a></li></ul><p><strong>Reference</strong></p><ul><li><a href="RELEASE-NOTES.txt">Release Notes</a></li><li><a href="config/index.html">Configuration</a></li><li><a href="api/index.html">Tomcat Javadocs</a></li><li><a href="servletapi/index.html">Servlet Javadocs</a></li><li><a href="jspapi/index.html">JSP 2.2 Javadocs</a></li><li><a href="elapi/index.html">EL 2.2 Javadocs</a></li><li><a href="websocketapi/index.html">WebSocket 1.1 Javadocs</a></li><li><a href="http://tomcat.apache.org/connectors-doc/">JK 1.2 Documentation</a></li></ul><p><strong>Apache Tomcat Development</strong></p><ul><li><a href="building.html">Building</a></li><li><a href="changelog.html">Changelog</a></li><li><a href="http://wiki.apache.org/tomcat/TomcatVersions">Status</a></li><li><a href="developers.html">Developers</a></li><li><a href="architecture/index.html">Architecture</a></li><li><a href="funcspecs/index.html">Functional Specs.</a></li><li><a href="tribes/introduction.html">Tribes</a></li></ul></td><!--RIGHT SIDE MAIN BODY--><td width="80%" valign="top" align="left" id="mainBody"><h1>Proxy Support HOW-TO</h1><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Table of Contents"><!--()--></a><a name="Table_of_Contents"><strong>Table of Contents</strong></a></font></td></tr><tr><td><blockquote> | |
| <ul><li><a href="#Introduction">Introduction</a></li><li><a href="#Apache_1.3_Proxy_Support">Apache 1.3 Proxy Support</a></li><li><a href="#Apache_2.0_Proxy_Support">Apache 2.0 Proxy Support</a></li></ul> | |
| </blockquote></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/http.html">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 port number 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"><!--()--></a><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 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 class="codeBox"><pre><code> | |
| LoadModule proxy_module {path-to-modules}/mod_proxy.so | |
| AddModule mod_proxy.c | |
| </code></pre></div></li> | |
| <li>Include two directives in your <code>httpd.conf</code> file for | |
| each web application that you wish to forward to Tomcat. For | |
| example, to forward an application at context path <code>/myapp</code>: | |
| <div class="codeBox"><pre><code> | |
| ProxyPass /myapp http://localhost:8081/myapp | |
| ProxyPassReverse /myapp http://localhost:8081/myapp | |
| </code></pre></div> | |
| which tells Apache to forward URLs of the form | |
| <code>http://localhost/myapp/*</code> to the Tomcat connector | |
| listening on port 8081.</li> | |
| <li>Configure your copy of Tomcat to include a special | |
| <code><Connector></code> element, with appropriate | |
| proxy settings, for example: | |
| <div class="codeBox"><pre><code> | |
| <Connector port="8081" ... | |
| proxyName="www.mycompany.com" | |
| proxyPort="80"/> | |
| </code></pre></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"><!--()--></a><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><tr class="noPrint"><td width="20%" valign="top" nowrap class="noPrint"></td><td width="80%" valign="top" align="left"><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="comments_section" id="comments_section"><strong>Comments</strong></a></font></td></tr><tr><td><blockquote><p class="notice"><strong>Notice: </strong>This comments section collects your suggestions | |
| on improving documentation for Apache Tomcat.<br><br> | |
| If you have trouble and need help, read | |
| <a href="http://tomcat.apache.org/findhelp.html">Find Help</a> page | |
| and ask your question on the tomcat-users | |
| <a href="http://tomcat.apache.org/lists.html">mailing list</a>. | |
| Do not ask such questions here. This is not a Q&A section.<br><br> | |
| The Apache Comments System is explained <a href="./comments.html">here</a>. | |
| Comments may be removed by our moderators if they are either | |
| implemented or considered invalid/off-topic.</p><script type="text/javascript"><!--//--><![CDATA[//><!-- | |
| var comments_shortname = 'tomcat'; | |
| var comments_identifier = 'http://tomcat.apache.org/tomcat-7.0-doc/proxy-howto.html'; | |
| (function(w, d) { | |
| if (w.location.hostname.toLowerCase() == "tomcat.apache.org") { | |
| d.write('<div id="comments_thread"><\/div>'); | |
| var s = d.createElement('script'); | |
| s.type = 'text/javascript'; | |
| s.async = true; | |
| s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier; | |
| (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s); | |
| } | |
| else { | |
| d.write('<div id="comments_thread"><strong>Comments are disabled for this page at the moment.<\/strong><\/div>'); | |
| } | |
| })(window, document); | |
| //--><!]]></script></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> | |
| Copyright © 1999-2017, Apache Software Foundation | |
| </em></font></div></td></tr></table></body></html> |