granicus.if.org Git - apache/blob - docs/manual/mod/mod_proxy.html.en

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
   4         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   5               This file is generated from xml source: DO NOT EDIT
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7       -->
   8 <title>mod_proxy - Apache HTTP Server</title>
   9 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  10 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  11 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
  12 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  13 <body>
  14 <div id="page-header">
  15 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  16 <p class="apache">Apache HTTP Server Version 2.3</p>
  17 <img alt="" src="../images/feather.gif" /></div>
  18 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  19 <div id="path">
  20 <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.3</a> &gt; <a href="./">Modules</a></div>
  21 <div id="page-content">
  22 <div id="preamble"><h1>Apache Module mod_proxy</h1>
  23 <div class="toplang">
  24 <p><span>Available Languages: </span><a href="../en/mod/mod_proxy.html" title="English">&nbsp;en&nbsp;</a> |
  25 <a href="../ja/mod/mod_proxy.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a></p>
  26 </div>
  27 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>HTTP/1.1 proxy/gateway server</td></tr>
  28 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  29 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>proxy_module</td></tr>
  30 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_proxy.c</td></tr></table>
  31 <h3>Summary</h3>
  32
  33     <div class="warning"><h3>Warning</h3>
  34       <p>Do not enable proxying with <code class="directive"><a href="#proxyrequests">ProxyRequests</a></code> until you have <a href="#access">secured your server</a>. Open proxy servers are dangerous both to your
  35       network and to the Internet at large.</p>
  36     </div>
  37
  38     <p>This module implements a proxy/gateway for Apache. It implements
  39     proxying capability for <code>AJP13</code> (Apache JServe Protocol
  40     version 1.3), <code>FTP</code>, <code>CONNECT</code> (for SSL),
  41     <code>HTTP/0.9</code>, <code>HTTP/1.0</code>, and <code>HTTP/1.1</code>.
  42     The module can be configured to connect to other proxy modules for these
  43     and other protocols.</p>
  44
  45     <p>Apache's proxy features are divided into several modules in
  46     addition to <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code>:
  47     <code class="module"><a href="../mod/mod_proxy_http.html">mod_proxy_http</a></code>, <code class="module"><a href="../mod/mod_proxy_ftp.html">mod_proxy_ftp</a></code>,
  48     <code class="module"><a href="../mod/mod_proxy_ajp.html">mod_proxy_ajp</a></code>, <code class="module"><a href="../mod/mod_proxy_balancer.html">mod_proxy_balancer</a></code>,
  49     and <code class="module"><a href="../mod/mod_proxy_connect.html">mod_proxy_connect</a></code>.  Thus, if you want to use
  50     one or more of the particular proxy functions, load
  51     <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code> <em>and</em> the appropriate module(s)
  52     into the server (either statically at compile-time or dynamically
  53     via the <code class="directive"><a href="../mod/mod_so.html#loadmodule">LoadModule</a></code>
  54     directive).</p>
  55
  56     <p>In addition, extended features are provided by other modules.
  57     Caching is provided by <code class="module"><a href="../mod/mod_cache.html">mod_cache</a></code> and related
  58     modules.  The ability to contact remote servers using the SSL/TLS
  59     protocol is provided by the <code>SSLProxy*</code> directives of
  60     <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code>.  These additional modules will need
  61     to be loaded and configured to take advantage of these features.</p>
  62 </div>
  63 <div id="quickview"><h3 class="directives">Directives</h3>
  64 <ul id="toc">
  65 <li><img alt="" src="../images/down.gif" /> <a href="#allowconnect">AllowCONNECT</a></li>
  66 <li><img alt="" src="../images/down.gif" /> <a href="#balancermember">BalancerMember</a></li>
  67 <li><img alt="" src="../images/down.gif" /> <a href="#noproxy">NoProxy</a></li>
  68 <li><img alt="" src="../images/down.gif" /> <a href="#proxy">&lt;Proxy&gt;</a></li>
  69 <li><img alt="" src="../images/down.gif" /> <a href="#proxybadheader">ProxyBadHeader</a></li>
  70 <li><img alt="" src="../images/down.gif" /> <a href="#proxyblock">ProxyBlock</a></li>
  71 <li><img alt="" src="../images/down.gif" /> <a href="#proxydomain">ProxyDomain</a></li>
  72 <li><img alt="" src="../images/down.gif" /> <a href="#proxyerroroverride">ProxyErrorOverride</a></li>
  73 <li><img alt="" src="../images/down.gif" /> <a href="#proxyftpdircharset">ProxyFtpDirCharset</a></li>
  74 <li><img alt="" src="../images/down.gif" /> <a href="#proxyiobuffersize">ProxyIOBufferSize</a></li>
  75 <li><img alt="" src="../images/down.gif" /> <a href="#proxymatch">&lt;ProxyMatch&gt;</a></li>
  76 <li><img alt="" src="../images/down.gif" /> <a href="#proxymaxforwards">ProxyMaxForwards</a></li>
  77 <li><img alt="" src="../images/down.gif" /> <a href="#proxypass">ProxyPass</a></li>
  78 <li><img alt="" src="../images/down.gif" /> <a href="#proxypassinterpolateenv">ProxyPassInterpolateEnv</a></li>
  79 <li><img alt="" src="../images/down.gif" /> <a href="#proxypassmatch">ProxyPassMatch</a></li>
  80 <li><img alt="" src="../images/down.gif" /> <a href="#proxypassreverse">ProxyPassReverse</a></li>
  81 <li><img alt="" src="../images/down.gif" /> <a href="#proxypassreversecookiedomain">ProxyPassReverseCookieDomain</a></li>
  82 <li><img alt="" src="../images/down.gif" /> <a href="#proxypassreversecookiepath">ProxyPassReverseCookiePath</a></li>
  83 <li><img alt="" src="../images/down.gif" /> <a href="#proxypreservehost">ProxyPreserveHost</a></li>
  84 <li><img alt="" src="../images/down.gif" /> <a href="#proxyreceivebuffersize">ProxyReceiveBufferSize</a></li>
  85 <li><img alt="" src="../images/down.gif" /> <a href="#proxyremote">ProxyRemote</a></li>
  86 <li><img alt="" src="../images/down.gif" /> <a href="#proxyremotematch">ProxyRemoteMatch</a></li>
  87 <li><img alt="" src="../images/down.gif" /> <a href="#proxyrequests">ProxyRequests</a></li>
  88 <li><img alt="" src="../images/down.gif" /> <a href="#proxyset">ProxySet</a></li>
  89 <li><img alt="" src="../images/down.gif" /> <a href="#proxystatus">ProxyStatus</a></li>
  90 <li><img alt="" src="../images/down.gif" /> <a href="#proxytimeout">ProxyTimeout</a></li>
  91 <li><img alt="" src="../images/down.gif" /> <a href="#proxyvia">ProxyVia</a></li>
  92 </ul>
  93 <h3>Topics</h3>
  94 <ul id="topics">
  95 <li><img alt="" src="../images/down.gif" /> <a href="#forwardreverse">Forward Proxies and Reverse
  96        Proxies/Gateways</a></li>
  97 <li><img alt="" src="../images/down.gif" /> <a href="#examples">Basic Examples</a></li>
  98 <li><img alt="" src="../images/down.gif" /> <a href="#access">Controlling access to your proxy</a></li>
  99 <li><img alt="" src="../images/down.gif" /> <a href="#startup">Slow Startup</a></li>
 100 <li><img alt="" src="../images/down.gif" /> <a href="#intranet">Intranet Proxy</a></li>
 101 <li><img alt="" src="../images/down.gif" /> <a href="#envsettings">Protocol Adjustments</a></li>
 102 <li><img alt="" src="../images/down.gif" /> <a href="#request-bodies">Request Bodies</a></li>
 103 <li><img alt="" src="../images/down.gif" /> <a href="#x-headers">Reverse Proxy Request Headers</a></li>
 104 </ul><h3>See also</h3>
 105 <ul class="seealso">
 106 <li><code class="module"><a href="../mod/mod_cache.html">mod_cache</a></code></li>
 107 <li><code class="module"><a href="../mod/mod_proxy_http.html">mod_proxy_http</a></code></li>
 108 <li><code class="module"><a href="../mod/mod_proxy_ftp.html">mod_proxy_ftp</a></code></li>
 109 <li><code class="module"><a href="../mod/mod_proxy_connect.html">mod_proxy_connect</a></code></li>
 110 <li><code class="module"><a href="../mod/mod_proxy_balancer.html">mod_proxy_balancer</a></code></li>
 111 <li><code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code></li>
 112 </ul></div>
 113 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 114 <div class="section">
 115 <h2><a name="forwardreverse" id="forwardreverse">Forward Proxies and Reverse
 116        Proxies/Gateways</a></h2>
 117       <p>Apache can be configured in both a <dfn>forward</dfn> and
 118       <dfn>reverse</dfn> proxy (also known as <dfn>gateway</dfn>) mode.</p>
 119
 120       <p>An ordinary <dfn>forward proxy</dfn> is an intermediate
 121       server that sits between the client and the <em>origin
 122       server</em>.  In order to get content from the origin server,
 123       the client sends a request to the proxy naming the origin server
 124       as the target and the proxy then requests the content from the
 125       origin server and returns it to the client.  The client must be
 126       specially configured to use the forward proxy to access other
 127       sites.</p>
 128
 129       <p>A typical usage of a forward proxy is to provide Internet
 130       access to internal clients that are otherwise restricted by a
 131       firewall.  The forward proxy can also use caching (as provided
 132       by <code class="module"><a href="../mod/mod_cache.html">mod_cache</a></code>) to reduce network usage.</p>
 133
 134       <p>The forward proxy is activated using the <code class="directive"><a href="#proxyrequests">ProxyRequests</a></code> directive.  Because
 135       forward proxies allow clients to access arbitrary sites through
 136       your server and to hide their true origin, it is essential that
 137       you <a href="#access">secure your server</a> so that only
 138       authorized clients can access the proxy before activating a
 139       forward proxy.</p>
 140
 141       <p>A <dfn>reverse proxy</dfn> (or <dfn>gateway</dfn>), by
 142       contrast, appears to the client just like an ordinary web
 143       server.  No special configuration on the client is necessary.
 144       The client makes ordinary requests for content in the name-space
 145       of the reverse proxy.  The reverse proxy then decides where to
 146       send those requests, and returns the content as if it was itself
 147       the origin.</p>
 148
 149       <p>A typical usage of a reverse proxy is to provide Internet
 150       users access to a server that is behind a firewall.  Reverse
 151       proxies can also be used to balance load among several back-end
 152       servers, or to provide caching for a slower back-end server.
 153       In addition, reverse proxies can be used simply to bring
 154       several servers into the same URL space.</p>
 155
 156       <p>A reverse proxy is activated using the <code class="directive"><a href="#proxypass">ProxyPass</a></code> directive or the
 157       <code>[P]</code> flag to the <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> directive.  It is
 158       <strong>not</strong> necessary to turn <code class="directive"><a href="#proxyrequests">ProxyRequests</a></code> on in order to
 159       configure a reverse proxy.</p>
 160     </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 161 <div class="section">
 162 <h2><a name="examples" id="examples">Basic Examples</a></h2>
 163
 164     <p>The examples below are only a very basic idea to help you
 165     get started.  Please read the documentation on the individual
 166     directives.</p>
 167
 168     <p>In addition, if you wish to have caching enabled, consult
 169     the documentation from <code class="module"><a href="../mod/mod_cache.html">mod_cache</a></code>.</p>
 170
 171     <div class="example"><h3>Forward Proxy</h3><p><code>
 172     ProxyRequests On<br />
 173     ProxyVia On<br />
 174     <br />
 175     &lt;Proxy *&gt;<br />
 176     <span class="indent">
 177       Order deny,allow<br />
 178       Deny from all<br />
 179       Allow from internal.example.com<br />
 180     </span>
 181     &lt;/Proxy&gt;
 182     </code></p></div>
 183
 184     <div class="example"><h3>Reverse Proxy</h3><p><code>
 185     ProxyRequests Off<br />
 186     <br />
 187     &lt;Proxy *&gt;<br />
 188     <span class="indent">
 189       Order deny,allow<br />
 190       Allow from all<br />
 191     </span>
 192     &lt;/Proxy&gt;<br />
 193     <br />
 194     ProxyPass /foo http://foo.example.com/bar<br />
 195     ProxyPassReverse /foo http://foo.example.com/bar
 196     </code></p></div>
 197     </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 198 <div class="section">
 199 <h2><a name="access" id="access">Controlling access to your proxy</a></h2>
 200       <p>You can control who can access your proxy via the <code class="directive"><a href="#proxy">&lt;Proxy&gt;</a></code> control block as in
 201       the following example:</p>
 202
 203       <div class="example"><p><code>
 204         &lt;Proxy *&gt;<br />
 205         <span class="indent">
 206           Order Deny,Allow<br />
 207           Deny from all<br />
 208           Allow from 192.168.0<br />
 209         </span>
 210         &lt;/Proxy&gt;
 211       </code></p></div>
 212
 213       <p>For more information on access control directives, see
 214       <code class="module"><a href="../mod/mod_authz_host.html">mod_authz_host</a></code>.</p>
 215
 216       <p>Strictly limiting access is essential if you are using a
 217       forward proxy (using the <code class="directive"><a href="#proxyrequests">ProxyRequests</a></code> directive).
 218       Otherwise, your server can be used by any client to access
 219       arbitrary hosts while hiding his or her true identity.  This is
 220       dangerous both for your network and for the Internet at large.
 221       When using a reverse proxy (using the <code class="directive"><a href="#proxypass">ProxyPass</a></code> directive with
 222       <code>ProxyRequests Off</code>), access control is less
 223       critical because clients can only contact the hosts that you
 224       have specifically configured.</p>
 225
 226       <p><strong>See Also</strong> the <a href="mod_proxy_http.html#env">Proxy-Chain-Auth</a> environment variable.</p>
 227
 228     </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 229 <div class="section">
 230 <h2><a name="startup" id="startup">Slow Startup</a></h2>
 231       <p>If you're using the <code class="directive"><a href="#proxyblock">ProxyBlock</a></code> directive, hostnames' IP addresses are looked up
 232       and cached during startup for later match test. This may take a few
 233       seconds (or more) depending on the speed with which the hostname lookups
 234       occur.</p>
 235     </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 236 <div class="section">
 237 <h2><a name="intranet" id="intranet">Intranet Proxy</a></h2>
 238       <p>An Apache proxy server situated in an intranet needs to forward
 239       external requests through the company's firewall (for this, configure
 240       the <code class="directive"><a href="#proxyremote">ProxyRemote</a></code> directive
 241       to forward the respective <var>scheme</var> to the firewall proxy).
 242       However, when it has to
 243       access resources within the intranet, it can bypass the firewall when
 244       accessing hosts. The <code class="directive"><a href="#noproxy">NoProxy</a></code>
 245       directive is useful for specifying which hosts belong to the intranet and
 246       should be accessed directly.</p>
 247
 248       <p>Users within an intranet tend to omit the local domain name from their
 249       WWW requests, thus requesting "http://somehost/" instead of
 250       <code>http://somehost.example.com/</code>. Some commercial proxy servers
 251       let them get away with this and simply serve the request, implying a
 252       configured local domain. When the <code class="directive"><a href="#proxydomain">ProxyDomain</a></code> directive is used and the server is <a href="#proxyrequests">configured for proxy service</a>, Apache can return
 253       a redirect response and send the client to the correct, fully qualified,
 254       server address. This is the preferred method since the user's bookmark
 255       files will then contain fully qualified hosts.</p>
 256     </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 257 <div class="section">
 258 <h2><a name="envsettings" id="envsettings">Protocol Adjustments</a></h2>
 259       <p>For circumstances where <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code> is sending
 260       requests to an origin server that doesn't properly implement
 261       keepalives or HTTP/1.1, there are two <a href="../env.html">environment variables</a> that can force the
 262       request to use HTTP/1.0 with no keepalive. These are set via the
 263       <code class="directive"><a href="../mod/mod_env.html#setenv">SetEnv</a></code> directive.</p>
 264
 265       <p>These are the <code>force-proxy-request-1.0</code> and
 266       <code>proxy-nokeepalive</code> notes.</p>
 267
 268       <div class="example"><p><code>
 269         &lt;Location /buggyappserver/&gt;<br />
 270         <span class="indent">
 271           ProxyPass http://buggyappserver:7001/foo/<br />
 272           SetEnv force-proxy-request-1.0 1<br />
 273           SetEnv proxy-nokeepalive 1<br />
 274         </span>
 275         &lt;/Location&gt;
 276       </code></p></div>
 277
 278     </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 279 <div class="section">
 280 <h2><a name="request-bodies" id="request-bodies">Request Bodies</a></h2>
 281
 282     <p>Some request methods such as POST include a request body.
 283     The HTTP protocol requires that requests which include a body
 284     either use chunked transfer encoding or send a
 285     <code>Content-Length</code> request header.  When passing these
 286     requests on to the origin server, <code class="module"><a href="../mod/mod_proxy_http.html">mod_proxy_http</a></code>
 287     will always attempt to send the <code>Content-Length</code>.  But
 288     if the body is large and the original request used chunked
 289     encoding, then chunked encoding may also be used in the upstream
 290     request.  You can control this selection using <a href="../env.html">environment variables</a>.  Setting
 291     <code>proxy-sendcl</code> ensures maximum compatibility with
 292     upstream servers by always sending the
 293     <code>Content-Length</code>, while setting
 294     <code>proxy-sendchunked</code> minimizes resource usage by using
 295     chunked encoding.</p>
 296
 297     </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 298 <div class="section">
 299 <h2><a name="x-headers" id="x-headers">Reverse Proxy Request Headers</a></h2>
 300
 301     <p>When acting in a reverse-proxy mode (using the <code class="directive"><a href="#proxypass">ProxyPass</a></code> directive, for example),
 302     <code class="module"><a href="../mod/mod_proxy_http.html">mod_proxy_http</a></code> adds several request headers in
 303     order to pass information to the origin server. These headers
 304     are:</p>
 305
 306     <dl>
 307       <dt><code>X-Forwarded-For</code></dt>
 308       <dd>The IP address of the client.</dd>
 309       <dt><code>X-Forwarded-Host</code></dt>
 310       <dd>The original host requested by the client in the <code>Host</code>
 311        HTTP request header.</dd>
 312       <dt><code>X-Forwarded-Server</code></dt>
 313       <dd>The hostname of the proxy server.</dd>
 314     </dl>
 315
 316     <p>Be careful when using these headers on the origin server, since
 317     they will contain more than one (comma-separated) value if the
 318     original request already contained one of these headers. For
 319     example, you can use <code>%{X-Forwarded-For}i</code> in the log
 320     format string of the origin server to log the original clients IP
 321     address, but you may get more than one address if the request
 322     passes through several proxies.</p>
 323
 324     <p>See also the <code class="directive"><a href="#proxypreservehost">ProxyPreserveHost</a></code> and <code class="directive"><a href="#proxyvia">ProxyVia</a></code> directives, which control
 325     other request headers.</p>
 326
 327    </div>
 328 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 329 <div class="directive-section"><h2><a name="AllowCONNECT" id="AllowCONNECT">AllowCONNECT</a> <a name="allowconnect" id="allowconnect">Directive</a></h2>
 330 <table class="directive">
 331 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Ports that are allowed to <code>CONNECT</code> through the
 332 proxy</td></tr>
 333 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AllowCONNECT <var>port</var> [<var>port</var>] ...</code></td></tr>
 334 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AllowCONNECT 443 563</code></td></tr>
 335 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 336 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 337 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
 338 </table>
 339     <p>The <code class="directive">AllowCONNECT</code> directive specifies a list
 340     of port numbers to which the proxy <code>CONNECT</code> method may
 341     connect.  Today's browsers use this method when a <code>https</code>
 342     connection is requested and proxy tunneling over HTTP is in effect.</p>
 343
 344     <p>By default, only the default https port (<code>443</code>) and the
 345     default snews port (<code>563</code>) are enabled. Use the
 346     <code class="directive">AllowCONNECT</code> directive to override this default and
 347     allow connections to the listed ports only.</p>
 348
 349     <p>Note that you'll need to have <code class="module"><a href="../mod/mod_proxy_connect.html">mod_proxy_connect</a></code> present
 350     in the server in order to get the support for the <code>CONNECT</code> at
 351     all.</p>
 352
 353 </div>
 354 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 355 <div class="directive-section"><h2><a name="BalancerMember" id="BalancerMember">BalancerMember</a> <a name="balancermember" id="balancermember">Directive</a></h2>
 356 <table class="directive">
 357 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Add a member to a load balancing group</td></tr>
 358 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>BalancerMember <var>url</var> [<var>key=value [key=value ...]]</var></code></td></tr>
 359 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory</td></tr>
 360 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 361 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
 362 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>BalancerMember is only available in Apache 2.2
 363   and later.</td></tr>
 364 </table>
 365     <p>This directive adds a member to a load balancing group. It must be used
 366     within a <code>&lt;Proxy <var>balancer://</var>...&gt;</code> container
 367     directive, and can take any of the parameters available to
 368     <code class="directive"><a href="#proxypass">ProxyPass</a></code> directives.</p>
 369     <p>One additional parameter is available only to <code class="directive"><a href="#balancermember">BalancerMember</a></code> directives:
 370     <var>loadfactor</var>. This is the member load factor - a number between 1
 371     (default) and 100, which defines the weighted load to be applied to the
 372     member in question.</p>
 373
 374 </div>
 375 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 376 <div class="directive-section"><h2><a name="NoProxy" id="NoProxy">NoProxy</a> <a name="noproxy" id="noproxy">Directive</a></h2>
 377 <table class="directive">
 378 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Hosts, domains, or networks that will be connected to
 379 directly</td></tr>
 380 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>NoProxy <var>host</var> [<var>host</var>] ...</code></td></tr>
 381 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 382 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 383 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
 384 </table>
 385     <p>This directive is only useful for Apache proxy servers within
 386     intranets.  The <code class="directive">NoProxy</code> directive specifies a
 387     list of subnets, IP addresses, hosts and/or domains, separated by
 388     spaces. A request to a host which matches one or more of these is
 389     always served directly, without forwarding to the configured
 390     <code class="directive"><a href="#proxyremote">ProxyRemote</a></code> proxy server(s).</p>
 391
 392     <div class="example"><h3>Example</h3><p><code>
 393       ProxyRemote  *  http://firewall.example.com:81<br />
 394       NoProxy         .example.com 192.168.112.0/21
 395     </code></p></div>
 396
 397     <p>The <var>host</var> arguments to the <code class="directive">NoProxy</code>
 398     directive are one of the following type list:</p>
 399
 400     <dl>
 401
 402     <dt><var><a name="domain" id="domain">Domain</a></var></dt>
 403     <dd>
 404     <p>A <dfn>Domain</dfn> is a partially qualified DNS domain name, preceded
 405     by a period. It represents a list of hosts which logically belong to the
 406     same DNS domain or zone (<em>i.e.</em>, the suffixes of the hostnames are
 407     all ending in <var>Domain</var>).</p>
 408
 409     <div class="example"><h3>Examples</h3><p><code>
 410       .com .apache.org.
 411     </code></p></div>
 412
 413     <p>To distinguish <var>Domain</var>s from <var><a href="#hostname">Hostname</a></var>s (both syntactically and semantically; a DNS domain can
 414     have a DNS A record, too!), <var>Domain</var>s are always written with a
 415     leading period.</p>
 416
 417     <div class="note"><h3>Note</h3>
 418       <p>Domain name comparisons are done without regard to the case, and
 419       <var>Domain</var>s are always assumed to be anchored in the root of the
 420       DNS tree, therefore two domains <code>.ExAmple.com</code> and
 421       <code>.example.com.</code> (note the trailing period) are considered
 422       equal. Since a domain comparison does not involve a DNS lookup, it is much
 423       more efficient than subnet comparison.</p>
 424     </div></dd>
 425
 426
 427     <dt><var><a name="subnet" id="subnet">SubNet</a></var></dt>
 428     <dd>
 429     <p>A <dfn>SubNet</dfn> is a partially qualified internet address in
 430     numeric (dotted quad) form, optionally followed by a slash and the netmask,
 431     specified as the number of significant bits in the <var>SubNet</var>. It is
 432     used to represent a subnet of hosts which can be reached over a common
 433     network interface. In the absence of the explicit net mask it is assumed
 434     that omitted (or zero valued) trailing digits specify the mask. (In this
 435     case, the netmask can only be multiples of 8 bits wide.) Examples:</p>
 436
 437     <dl>
 438     <dt><code>192.168</code> or <code>192.168.0.0</code></dt>
 439     <dd>the subnet 192.168.0.0 with an implied netmask of 16 valid bits
 440     (sometimes used in the netmask form <code>255.255.0.0</code>)</dd>
 441     <dt><code>192.168.112.0/21</code></dt>
 442     <dd>the subnet <code>192.168.112.0/21</code> with a netmask of 21
 443     valid bits (also used in the form <code>255.255.248.0</code>)</dd>
 444     </dl>
 445
 446     <p>As a degenerate case, a <em>SubNet</em> with 32 valid bits is the
 447     equivalent to an <var><a href="#ipadr">IPAddr</a></var>, while a <var>SubNet</var> with zero
 448     valid bits (<em>e.g.</em>, 0.0.0.0/0) is the same as the constant
 449     <var>_Default_</var>, matching any IP address.</p></dd>
 450
 451
 452     <dt><var><a name="ipaddr" id="ipaddr">IPAddr</a></var></dt>
 453     <dd>
 454     <p>A <dfn>IPAddr</dfn> represents a fully qualified internet address in
 455     numeric (dotted quad) form. Usually, this address represents a host, but
 456     there need not necessarily be a DNS domain name connected with the
 457     address.</p>
 458     <div class="example"><h3>Example</h3><p><code>
 459       192.168.123.7
 460     </code></p></div>
 461
 462     <div class="note"><h3>Note</h3>
 463       <p>An <var>IPAddr</var> does not need to be resolved by the DNS system, so
 464       it can result in more effective apache performance.</p>
 465     </div></dd>
 466
 467
 468     <dt><var><a name="hostname" id="hostname">Hostname</a></var></dt>
 469     <dd>
 470     <p>A <dfn>Hostname</dfn> is a fully qualified DNS domain name which can
 471     be resolved to one or more <var><a href="#ipaddr">IPAddrs</a></var> via the
 472     DNS domain name service. It represents a logical host (in contrast to
 473     <var><a href="#domain">Domain</a></var>s, see above) and must be resolvable
 474     to at least one <var><a href="#ipaddr">IPAddr</a></var> (or often to a list
 475     of hosts with different <var><a href="#ipaddr">IPAddr</a></var>s).</p>
 476
 477     <div class="example"><h3>Examples</h3><p><code>
 478       prep.ai.example.com<br />
 479       www.apache.org
 480     </code></p></div>
 481
 482     <div class="note"><h3>Note</h3>
 483       <p>In many situations, it is more effective to specify an <var><a href="#ipaddr">IPAddr</a></var> in place of a <var>Hostname</var> since a
 484       DNS lookup can be avoided. Name resolution in Apache can take a remarkable
 485       deal of time when the connection to the name server uses a slow PPP
 486       link.</p>
 487       <p><var>Hostname</var> comparisons are done without regard to the case,
 488       and <var>Hostname</var>s are always assumed to be anchored in the root
 489       of the DNS tree, therefore two hosts <code>WWW.ExAmple.com</code>
 490       and <code>www.example.com.</code> (note the trailing period) are
 491       considered equal.</p>
 492      </div></dd>
 493     </dl>
 494
 495 <h3>See also</h3>
 496 <ul>
 497 <li><a href="../dns-caveats.html">DNS Issues</a></li>
 498 </ul>
 499 </div>
 500 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 501 <div class="directive-section"><h2><a name="Proxy" id="Proxy">&lt;Proxy&gt;</a> <a name="proxy" id="proxy">Directive</a></h2>
 502 <table class="directive">
 503 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Container for directives applied to proxied resources</td></tr>
 504 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;Proxy <var>wildcard-url</var>&gt; ...&lt;/Proxy&gt;</code></td></tr>
 505 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 506 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 507 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
 508 </table>
 509     <p>Directives placed in <code class="directive">&lt;Proxy&gt;</code>
 510     sections apply only to matching proxied content.  Shell-style wildcards are
 511     allowed.</p>
 512
 513     <p>For example, the following will allow only hosts in
 514     <code>yournetwork.example.com</code> to access content via your proxy
 515     server:</p>
 516
 517     <div class="example"><p><code>
 518       &lt;Proxy *&gt;<br />
 519       <span class="indent">
 520         Order Deny,Allow<br />
 521         Deny from all<br />
 522         Allow from yournetwork.example.com<br />
 523       </span>
 524       &lt;/Proxy&gt;
 525     </code></p></div>
 526
 527     <p>The following example will process all files in the <code>foo</code>
 528     directory of <code>example.com</code> through the <code>INCLUDES</code>
 529     filter when they are sent through the proxy server:</p>
 530
 531     <div class="example"><p><code>
 532       &lt;Proxy http://example.com/foo/*&gt;<br />
 533       <span class="indent">
 534         SetOutputFilter INCLUDES<br />
 535       </span>
 536       &lt;/Proxy&gt;
 537     </code></p></div>
 538
 539
 540 </div>
 541 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 542 <div class="directive-section"><h2><a name="ProxyBadHeader" id="ProxyBadHeader">ProxyBadHeader</a> <a name="proxybadheader" id="proxybadheader">Directive</a></h2>
 543 <table class="directive">
 544 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Determines how to handle bad header lines in a
 545 response</td></tr>
 546 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyBadHeader IsError|Ignore|StartBody</code></td></tr>
 547 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ProxyBadHeader IsError</code></td></tr>
 548 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 549 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 550 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
 551 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.0.44 and later</td></tr>
 552 </table>
 553     <p>The <code class="directive">ProxyBadHeader</code> directive determines the
 554     behaviour of <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code> if it receives syntactically invalid
 555     header lines (<em>i.e.</em> containing no colon). The following arguments
 556     are possible:</p>
 557
 558     <dl>
 559     <dt><code>IsError</code></dt>
 560     <dd>Abort the request and end up with a 502 (Bad Gateway) response. This is
 561     the default behaviour.</dd>
 562
 563     <dt><code>Ignore</code></dt>
 564     <dd>Treat bad header lines as if they weren't sent.</dd>
 565
 566     <dt><code>StartBody</code></dt>
 567     <dd>When receiving the first bad header line, finish reading the headers and
 568     treat the remainder as body. This helps to work around buggy backend servers
 569     which forget to insert an empty line between the headers and the body.</dd>
 570     </dl>
 571
 572 </div>
 573 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 574 <div class="directive-section"><h2><a name="ProxyBlock" id="ProxyBlock">ProxyBlock</a> <a name="proxyblock" id="proxyblock">Directive</a></h2>
 575 <table class="directive">
 576 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Words, hosts, or domains that are banned from being
 577 proxied</td></tr>
 578 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyBlock *|<var>word</var>|<var>host</var>|<var>domain</var>
 579 [<var>word</var>|<var>host</var>|<var>domain</var>] ...</code></td></tr>
 580 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 581 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 582 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
 583 </table>
 584     <p>The <code class="directive">ProxyBlock</code> directive specifies a list of
 585     words, hosts and/or domains, separated by spaces.  HTTP, HTTPS, and
 586     FTP document requests to sites whose names contain matched words,
 587     hosts or domains are <em>blocked</em> by the proxy server. The proxy
 588     module will also attempt to determine IP addresses of list items which
 589     may be hostnames during startup, and cache them for match test as
 590     well. That may slow down the startup time of the server.</p>
 591
 592     <div class="example"><h3>Example</h3><p><code>
 593       ProxyBlock joes-garage.com some-host.co.uk rocky.wotsamattau.edu
 594     </code></p></div>
 595
 596     <p><code>rocky.wotsamattau.edu</code> would also be matched if referenced by
 597     IP address.</p>
 598
 599     <p>Note that <code>wotsamattau</code> would also be sufficient to match
 600     <code>wotsamattau.edu</code>.</p>
 601
 602     <p>Note also that</p>
 603
 604     <div class="example"><p><code>
 605       ProxyBlock *
 606     </code></p></div>
 607
 608     <p>blocks connections to all sites.</p>
 609
 610 </div>
 611 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 612 <div class="directive-section"><h2><a name="ProxyDomain" id="ProxyDomain">ProxyDomain</a> <a name="proxydomain" id="proxydomain">Directive</a></h2>
 613 <table class="directive">
 614 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Default domain name for proxied requests</td></tr>
 615 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyDomain <var>Domain</var></code></td></tr>
 616 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 617 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 618 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
 619 </table>
 620     <p>This directive is only useful for Apache proxy servers within
 621     intranets. The <code class="directive">ProxyDomain</code> directive specifies
 622     the default domain which the apache proxy server will belong to. If a
 623     request to a host without a domain name is encountered, a redirection
 624     response to the same host with the configured <var>Domain</var> appended
 625     will be generated.</p>
 626
 627     <div class="example"><h3>Example</h3><p><code>
 628       ProxyRemote  *  http://firewall.example.com:81<br />
 629       NoProxy         .example.com 192.168.112.0/21<br />
 630       ProxyDomain     .example.com
 631     </code></p></div>
 632
 633 </div>
 634 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 635 <div class="directive-section"><h2><a name="ProxyErrorOverride" id="ProxyErrorOverride">ProxyErrorOverride</a> <a name="proxyerroroverride" id="proxyerroroverride">Directive</a></h2>
 636 <table class="directive">
 637 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Override error pages for proxied content</td></tr>
 638 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyErrorOverride On|Off</code></td></tr>
 639 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ProxyErrorOverride Off</code></td></tr>
 640 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 641 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 642 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
 643 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.0 and later</td></tr>
 644 </table>
 645     <p>This directive is useful for reverse-proxy setups, where you want to
 646     have a common look and feel on the error pages seen by the end user.
 647     This also allows for included files (via
 648     <code class="module"><a href="../mod/mod_include.html">mod_include</a></code>'s SSI) to get
 649     the error code and act accordingly (default behavior would display
 650     the error page of the proxied server, turning this on shows the SSI
 651     Error message).</p>
 652
 653     <p>This directive does not affect the processing of informational (1xx),
 654     normal success (2xx), or redirect (3xx) responses.</p>
 655
 656 </div>
 657 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 658 <div class="directive-section"><h2><a name="ProxyFtpDirCharset" id="ProxyFtpDirCharset">ProxyFtpDirCharset</a> <a name="proxyftpdircharset" id="proxyftpdircharset">Directive</a></h2>
 659 <table class="directive">
 660 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Define the character set for proxied FTP listings</td></tr>
 661 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyFtpDirCharset <var>character set</var></code></td></tr>
 662 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ProxyFtpDirCharset ISO-8859-1</code></td></tr>
 663 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
 664 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 665 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
 666 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.2.7 and later</td></tr>
 667 </table>
 668     <p>The <code class="directive">ProxyFtpDirCharset</code> directive defines the
 669     character set to be set for FTP directory listings in HTML generated by
 670     <code class="module"><a href="../mod/mod_proxy_ftp.html">mod_proxy_ftp</a></code>.</p>
 671
 672 </div>
 673 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 674 <div class="directive-section"><h2><a name="ProxyIOBufferSize" id="ProxyIOBufferSize">ProxyIOBufferSize</a> <a name="proxyiobuffersize" id="proxyiobuffersize">Directive</a></h2>
 675 <table class="directive">
 676 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Determine size of internal data throughput buffer</td></tr>
 677 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyIOBufferSize <var>bytes</var></code></td></tr>
 678 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ProxyIOBufferSize 8192</code></td></tr>
 679 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 680 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 681 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
 682 </table>
 683     <p>The <code class="directive">ProxyIOBufferSize</code> directive adjusts the size
 684     of the internal buffer, which is used as a scratchpad for the data between
 685     input and output. The size must be at least <code>512</code>.</p>
 686
 687     <p>In almost every case there's no reason to change that value.</p>
 688     <p>If used with AJP this directive sets the maximum AJP packet size in
 689     bytes. If you change it from the default, you must also change the
 690     <code>packetSize</code> attribute of your AJP connector on the
 691     Tomcat side! The attribute <code>packetSize</code> is only available
 692     in Tomcat <code>5.5.20+</code> and <code>6.0.2+</code></p>
 693     <p>Normally it is not necessary to change the maximum packet size.
 694     Problems with the default value have been reported when sending
 695     certificates or certificate chains.</p>
 696
 697
 698 </div>
 699 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 700 <div class="directive-section"><h2><a name="ProxyMatch" id="ProxyMatch">&lt;ProxyMatch&gt;</a> <a name="proxymatch" id="proxymatch">Directive</a></h2>
 701 <table class="directive">
 702 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Container for directives applied to regular-expression-matched
 703 proxied resources</td></tr>
 704 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;ProxyMatch <var>regex</var>&gt; ...&lt;/ProxyMatch&gt;</code></td></tr>
 705 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 706 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 707 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
 708 </table>
 709     <p>The <code class="directive">&lt;ProxyMatch&gt;</code> directive is
 710     identical to the <code class="directive"><a href="#proxy">&lt;Proxy&gt;</a></code> directive, except it matches URLs
 711     using <a class="glossarylink" href="../glossary.html#regex" title="see glossary">regular expressions</a>.</p>
 712
 713 </div>
 714 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 715 <div class="directive-section"><h2><a name="ProxyMaxForwards" id="ProxyMaxForwards">ProxyMaxForwards</a> <a name="proxymaxforwards" id="proxymaxforwards">Directive</a></h2>
 716 <table class="directive">
 717 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Maximium number of proxies that a request can be forwarded
 718 through</td></tr>
 719 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyMaxForwards <var>number</var></code></td></tr>
 720 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ProxyMaxForwards -1</code></td></tr>
 721 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 722 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 723 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
 724 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.0 and later;
 725         default behaviour changed in 2.2.7/2.3</td></tr>
 726 </table>
 727     <p>The <code class="directive">ProxyMaxForwards</code> directive specifies the
 728     maximum number of proxies through which a request may pass, if there's no
 729     <code>Max-Forwards</code> header supplied with the request. This may
 730     be set to prevent infinite proxy loops, or a DoS attack.</p>
 731
 732     <div class="example"><h3>Example</h3><p><code>
 733       ProxyMaxForwards 15
 734     </code></p></div>
 735
 736     <p>Note that setting <code class="directive">ProxyMaxForwards</code> is a
 737     violation of the HTTP/1.1 protocol (RFC2616), which forbids a Proxy
 738     setting <code>Max-Forwards</code> if the Client didn't set it.
 739     Earlier Apache versions would always set it.  A negative
 740     <code class="directive">ProxyMaxForwards</code> value, including the
 741     default -1, gives you protocol-compliant behaviour, but may
 742     leave you open to loops.</p>
 743
 744 </div>
 745 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 746 <div class="directive-section"><h2><a name="ProxyPass" id="ProxyPass">ProxyPass</a> <a name="proxypass" id="proxypass">Directive</a></h2>
 747 <table class="directive">
 748 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Maps remote servers into the local server URL-space</td></tr>
 749 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyPass [<var>path</var>] !|<var>url</var> [<var>key=value</var>
 750   <var>[key=value</var> ...]] [nocanon] [interpolate]</code></td></tr>
 751 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
 752 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 753 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
 754 </table>
 755     <p>This directive allows remote servers to be mapped into the
 756     space of the local server; the local server does not act as a
 757     proxy in the conventional sense, but appears to be a mirror of the
 758     remote server. The local server is often called a <dfn>reverse
 759     proxy</dfn> or <dfn>gateway</dfn>. The <var>path</var> is the name of
 760     a local virtual path; <var>url</var> is a partial URL for the
 761     remote server and cannot include a query string.</p>
 762
 763     <div class="warning">The <code class="directive"><a href="#proxyrequests">ProxyRequests</a></code> directive should
 764     usually be set <strong>off</strong> when using
 765     <code class="directive">ProxyPass</code>.</div>
 766
 767     <p>Suppose the local server has address <code>http://example.com/</code>;
 768     then</p>
 769
 770     <div class="example"><p><code>
 771       ProxyPass /mirror/foo/ http://backend.example.com/
 772     </code></p></div>
 773
 774     <p>will cause a local request for
 775     <code>http://example.com/mirror/foo/bar</code> to be internally converted
 776     into a proxy request to <code>http://backend.example.com/bar</code>.</p>
 777
 778     <div class="warning">
 779     <p>If the first argument ends with a trailing <strong>/</strong>, the second
 780        argument should also end with a trailing <strong>/</strong> and vice
 781        versa. Otherwise the resulting requests to the backend may miss some
 782        needed slashes and do not deliver the expected results.
 783     </p>
 784     </div>
 785
 786     <p>The <code>!</code> directive is useful in situations where you don't want
 787     to reverse-proxy a subdirectory, <em>e.g.</em></p>
 788
 789     <div class="example"><p><code>
 790       ProxyPass /mirror/foo/i !<br />
 791       ProxyPass /mirror/foo http://backend.example.com
 792     </code></p></div>
 793
 794     <p>will proxy all requests to <code>/mirror/foo</code> to
 795     <code>backend.example.com</code> <em>except</em> requests made to
 796     <code>/mirror/foo/i</code>.</p>
 797
 798     <div class="note"><h3>Note</h3>
 799       <p>Order is important: exclusions must come <em>before</em> the
 800       general <code class="directive">ProxyPass</code> directive.</p>
 801     </div>
 802
 803     <p>As of Apache 2.1, the ability to use pooled connections to a backend
 804     server is available. Using the <code>key=value</code> parameters it is
 805     possible to tune this connection pooling. The default for a <code>Hard
 806     Maximum</code> for the number of connections is the number of threads per
 807     process in the active MPM. In the Prefork MPM, this is always 1, while with
 808     the Worker MPM it is controlled by the
 809     <code class="directive">ThreadsPerChild</code>.</p>
 810
 811     <p>Setting <code>min</code> will determine how many connections will always
 812     be open to the backend server. Upto the Soft Maximum or <code>smax</code>
 813     number of connections will be created on demand. Any connections above
 814     <code>smax</code> are subject to a time to live or <code>ttl</code>.  Apache
 815     will never create more than the Hard Maximum or <code>max</code> connections
 816     to the backend server.</p>
 817
 818     <div class="example"><p><code>
 819         ProxyPass /example http://backend.example.com smax=5 max=20 ttl=120 retry=300
 820     </code></p></div>
 821
 822     <table>
 823     <tr><th>Parameter</th>
 824         <th>Default</th>
 825         <th>Description</th></tr>
 826     <tr><td>min</td>
 827         <td>0</td>
 828         <td>Minimum number of connections that will always
 829             be open to the backend server.</td></tr>
 830     <tr><td>max</td>
 831         <td>1...n</td>
 832         <td>Hard Maximum number of connections that will be
 833     allowed to the backend server. The default for a Hard Maximum
 834     for the number of connections is the number of threads per process in the
 835     active MPM. In the Prefork MPM, this is always 1, while with the Worker MPM
 836     it is controlled by the <code class="directive">ThreadsPerChild</code>.
 837     Apache will never create more than the Hard Maximum connections
 838     to the backend server.</td></tr>
 839     <tr><td>smax</td>
 840         <td>max</td>
 841         <td>Upto the Soft Maximum
 842     number of connections will be created on demand. Any connections above
 843     <code>smax</code> are subject to a time to live or <code>ttl</code>.
 844     </td></tr>
 845     <tr><td>acquire</td>
 846         <td>-</td>
 847         <td>If set this will be the maximum time to wait for a free
 848     connection in the connection pool, in milliseconds. If there are no free
 849     connections in the pool the Apache will return <code>SERVER_BUSY</code>
 850     status to the client.
 851     </td></tr>
 852     <tr><td>connectiontimeout</td>
 853         <td>timeout</td>
 854         <td>Connect timeout in seconds.
 855         The number of seconds Apache waits for the creation of a connection to
 856         the backend to complete. By adding a postfix of ms the timeout can be
 857         also set in milliseconds.
 858     </td></tr>
 859     <tr><td>disablereuse</td>
 860         <td>Off</td>
 861         <td>This parameter should be used when you want to force mod_proxy
 862     to immediately close a connection to the backend after being used, and
 863     thus, disable its persistent connection and pool for that backend.
 864     This helps in various situations where a firewall between Apache and
 865     the backend server (regardless of protocol) tends to silently
 866     drop connections or when backends themselves may be under round-
 867     robin DNS. To disable connection pooling reuse,
 868     set this property value to <code>On</code>.
 869     </td></tr>
 870     <tr><td>flushpackets</td>
 871         <td>off</td>
 872         <td>Determines whether the proxy module will auto-flush the output
 873         brigade after each "chunk" of data. 'off' means that it will flush
 874         only when needed, 'on' means after each chunk is sent and
 875         'auto' means poll/wait for a period of time and flush if
 876         no input has been received for 'flushwait' milliseconds.
 877         Currently this is in effect only for AJP.
 878     </td></tr>
 879     <tr><td>flushwait</td>
 880         <td>10</td>
 881         <td>The time to wait for additional input, in milliseconds, before
 882         flushing the output brigade if 'flushpackets' is 'auto'.
 883     </td></tr>
 884     <tr><td>iobuffersize</td>
 885         <td>8192</td>
 886         <td>Adjusts the size of the internal scratchpad IO buffer. This allows you
 887         to override the <code class="directive">ProxyIOBufferSize</code> for a specific worker.
 888         This must be at least 512 or set to 0 for the system default of 8192.
 889     </td></tr>
 890     <tr><td>keepalive</td>
 891         <td>Off</td>
 892         <td>This parameter should be used when you have a firewall between your
 893     Apache and the backend server, who tend to drop inactive connections.
 894     This flag will tell the Operating System to send <code>KEEP_ALIVE</code>
 895     messages on inactive connections (interval depends on global OS settings,
 896     generally 120ms), and thus prevent the firewall to drop the connection.
 897     To enable keepalive set this property value to <code>On</code>.
 898     </td></tr>
 899     <tr><td>lbset</td>
 900         <td>0</td>
 901         <td>Sets the load balancer cluster set that the worker is a member
 902          of. The load balancer will try all members of a lower numbered
 903          lbset before trying higher numbered ones.
 904     </td></tr>
 905     <tr><td>ping</td>
 906         <td>0</td>
 907         <td>Ping property tells webserver to send a <code>CPING</code>
 908         request on ajp13 connection before forwarding a request.
 909         The parameter is the delay in seconds to wait for the
 910         <code>CPONG</code> reply.
 911         This features has been added to avoid problem with hung and
 912         busy Tomcat's and require ajp13 ping/pong support which has
 913         been implemented on Tomcat 3.3.2+, 4.1.28+ and 5.0.13+.
 914         This will increase the network traffic during the normal operation
 915         which could be an issue, but it will lower the
 916         traffic in case some of the cluster nodes are down or busy.
 917         Currently this has an effect only for AJP.
 918         By adding a postfix of ms the delay can be also set in
 919         milliseconds.
 920     </td></tr>
 921     <tr><td>receivebuffersize</td>
 922         <td>0</td>
 923         <td>Adjusts the size of the explicit (TCP/IP) network buffer size for
 924         proxied connections. This allows you to override the
 925         <code class="directive">ProxyReceiveBufferSize</code> for a specific worker.
 926         This must be at least 512 or set to 0 for the system default.
 927     </td></tr>
 928     <tr><td>redirect</td>
 929         <td>-</td>
 930         <td>Redirection Route of the worker. This value is usually
 931         set dynamically to enable safe removal of the node from
 932         the cluster. If set all requests without session id will be
 933         redirected to the BalancerMember that has route parametar
 934         equal as this value.
 935     </td></tr>
 936     <tr><td>retry</td>
 937         <td>60</td>
 938         <td>Connection pool worker retry timeout in seconds.
 939     If the connection pool worker to the backend server is in the error state,
 940     Apache will not forward any requests to that server until the timeout
 941     expires. This enables to shut down the backend server for maintenance,
 942     and bring it back online later. A value of 0 means always retry workers
 943     in an error state with no timeout.
 944     </td></tr>
 945     <tr><td>route</td>
 946         <td>-</td>
 947         <td>Route of the worker when used inside load balancer.
 948         The route is a value appended to session id.
 949     </td></tr>
 950     <tr><td>status</td>
 951         <td>-</td>
 952         <td>Single letter value defining the initial status of
 953         this worker: 'D' is disabled, 'S' is stopped, 'I' is ignore-errors,
 954         'H' is hot-standby and 'E' is in an error state. Status
 955         can be set (which is the default) by prepending with '+' or
 956         cleared by prepending with '-'.
 957         Thus, a setting of 'S-E' sets this worker to Stopped and
 958         clears the in-error flag.
 959     </td></tr>
 960     <tr><td>timeout</td>
 961         <td><code class="directive"><a href="#proxytimeout">ProxyTimeout</a></code></td>
 962         <td>Connection timeout in seconds.
 963         The number of seconds Apache waits for data sent by / to the backend.
 964     </td></tr>
 965     <tr><td>ttl</td>
 966         <td>-</td>
 967         <td>Time To Live for the inactive connections above the
 968         <code>smax</code> connections in seconds. Apache will close all
 969         connections that has not been used inside that time period.
 970     </td></tr>
 971
 972     </table>
 973
 974     <p>If the Proxy directive scheme starts with the
 975     <code>balancer://</code> then a virtual worker that does not really
 976     communicate with the backend server will be created. Instead it is responsible
 977     for the management of several "real" workers. In that case the special set of
 978     parameters can be add to this virtual worker. See <code class="module"><a href="../mod/mod_proxy_balancer.html">mod_proxy_balancer</a></code>
 979     for more information about how the balancer works.
 980     </p>
 981     <table>
 982     <tr><th>Parameter</th>
 983         <th>Default</th>
 984         <th>Description</th></tr>
 985     <tr><td>lbmethod</td>
 986         <td>byrequests</td>
 987         <td>Balancer load-balance method. Select the load-balancing scheduler
 988         method to use. Either <code>byrequests</code>, to perform weighted
 989         request counting, <code>bytraffic</code>, to perform weighted
 990         traffic byte count balancing, or <code>bybusyness</code>, to perform
 991         pending request balancing. Default is <code>byrequests</code>.
 992     </td></tr>
 993     <tr><td>maxattempts</td>
 994         <td>1</td>
 995         <td>Maximum number of failover attempts before giving up.
 996     </td></tr>
 997     <tr><td>nofailover</td>
 998         <td>Off</td>
 999         <td>If set to <code>On</code> the session will break if the worker is in
1000         error state or disabled. Set this value to On if backend servers do not
1001         support session replication.
1002     </td></tr>
1003     <tr><td>stickysession</td>
1004         <td>-</td>
1005         <td>Balancer sticky session name. The value is usually set to something
1006         like <code>JSESSIONID</code> or <code>PHPSESSIONID</code>,
1007         and it depends on the backend application server that support sessions.
1008         If the backend application server uses different name for cookies
1009         and url encoded id (like servlet containers) use | to to separate them.
1010         The first part is for the cookie the second for the path.
1011     </td></tr>
1012     <tr><td>scolonpathdelim</td>
1013         <td>Off</td>
1014         <td>If set to <code>On</code> the semi-colon character ';' will be
1015         used as an additional sticky session path deliminator/separator. This
1016         is mainly used to emulate mod_jk's behavior when dealing with paths such
1017         as <code>JSESSIONID=6736bcf34;foo=aabfa</code>
1018     </td></tr>
1019     <tr><td>timeout</td>
1020         <td>0</td>
1021         <td>Balancer timeout in seconds. If set this will be the maximum time
1022         to wait for a free worker. Default is not to wait.
1023     </td></tr>
1024
1025     </table>
1026     <p>A sample balancer setup</p>
1027     <div class="example"><p><code>
1028       ProxyPass /special-area http://special.example.com/ smax=5 max=10<br />
1029       ProxyPass / balancer://mycluster/ stickysession=JSESSIONID|jsessionid nofailover=On<br />
1030       &lt;Proxy balancer://mycluster&gt;<br />
1031       <span class="indent">
1032         BalancerMember http://1.2.3.4:8009<br />
1033         BalancerMember http://1.2.3.5:8009 smax=10<br />
1034         # Less powerful server, don't send as many requests there<br />
1035         BalancerMember http://1.2.3.6:8009 smax=1 loadfactor=20<br />
1036       </span>
1037       &lt;/Proxy&gt;
1038     </code></p></div>
1039
1040     <p>Setting up a hot-standby, that will only be used if no other
1041      members are available</p>
1042     <div class="example"><p><code>
1043       ProxyPass / balancer://hotcluster/ <br />
1044       &lt;Proxy balancer://hotcluster&gt;<br />
1045       <span class="indent">
1046         BalancerMember http://1.2.3.4:8009 loadfactor=1<br />
1047         BalancerMember http://1.2.3.5:8009 loadfactor=2<br />
1048         # The below is the hot standby<br />
1049         BalancerMember http://1.2.3.6:8009 status=+H<br />
1050         ProxySet lbmethod=bytraffic
1051       </span>
1052       &lt;/Proxy&gt;
1053     </code></p></div>
1054
1055     <p>Normally, mod_proxy will canonicalise ProxyPassed URLs.
1056     But this may be incompatible with some backends, particularly those
1057     that make use of <var>PATH_INFO</var>.  The optional <var>nocanon</var>
1058     keyword suppresses this, and passes the URL path "raw" to the
1059     backend.  Note that may affect the security of your backend, as it
1060     removes the normal limited protection against URL-based attacks
1061     provided by the proxy.</p>
1062
1063     <p>The optional <var>interpolate</var> keyword (available in
1064     httpd 2.2.9 and later), in combination with
1065     <code class="directive">ProxyPassInterpolateEnv</code> causes the ProxyPass
1066     to interpolate environment variables, using the syntax
1067     <var>${VARNAME}</var>.  Note that many of the standard CGI-derived
1068     environment variables will not exist when this interpolation happens,
1069     so you may still have to resort to <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>
1070     for complex rules.</p>
1071
1072     <p>When used inside a <code class="directive"><a href="../mod/core.html#location">&lt;Location&gt;</a></code> section, the first argument is omitted and the local
1073     directory is obtained from the <code class="directive"><a href="../mod/core.html#location">&lt;Location&gt;</a></code>.</p>
1074
1075     <p>If you require a more flexible reverse-proxy configuration, see the
1076     <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> directive with the
1077     <code>[P]</code> flag.</p>
1078
1079 </div>
1080 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1081 <div class="directive-section"><h2><a name="ProxyPassInterpolateEnv" id="ProxyPassInterpolateEnv">ProxyPassInterpolateEnv</a> <a name="proxypassinterpolateenv" id="proxypassinterpolateenv">Directive</a></h2>
1082 <table class="directive">
1083 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enable Environment Variable interpolation in Reverse Proxy configurations</td></tr>
1084 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyPassInterpolateEnv On|Off</code></td></tr>
1085 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ProxyPassInterpolateEnv Off</code></td></tr>
1086 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
1087 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1088 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
1089 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in httpd 2.2.9 and later</td></tr>
1090 </table>
1091     <p>This directive, together with the <var>interpolate</var> argument to
1092     <code class="directive">ProxyPass</code>, <code class="directive">ProxyPassReverse</code>,
1093     <code class="directive">ProxyPassReverseCookieDomain</code> and
1094     <code class="directive">ProxyPassReverseCookiePath</code>
1095     enables reverse proxies to be dynamically
1096     configured using environment variables, which may be set by
1097     another module such as <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>.
1098     It affects the <code class="directive">ProxyPass</code>,
1099     <code class="directive">ProxyPassReverse</code>,
1100     <code class="directive">ProxyPassReverseCookieDomain</code>, and
1101     <code class="directive">ProxyPassReverseCookiePath</code> directives,
1102     and causes them to substitute the value of an environment
1103     variable <code>varname</code> for the string <code>${varname}</code>
1104     in configuration directives.</p>
1105     <p>Keep this turned off (for server performance) unless you need it!</p>
1106
1107 </div>
1108 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1109 <div class="directive-section"><h2><a name="ProxyPassMatch" id="ProxyPassMatch">ProxyPassMatch</a> <a name="proxypassmatch" id="proxypassmatch">Directive</a></h2>
1110 <table class="directive">
1111 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Maps remote servers into the local server URL-space using regular expressions</td></tr>
1112 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyPassMatch [<var>regex</var>] !|<var>url</var> [<var>key=value</var>
1113         <var>[key=value</var> ...]]</code></td></tr>
1114 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
1115 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1116 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
1117 </table>
1118     <p>This directive is equivalent to <code class="directive"><a href="#proxypass">ProxyPass</a></code>,
1119        but makes use of regular expressions, instead of simple prefix matching. The
1120        supplied regular expression is matched against the <var>url</var>, and if it
1121        matches, the server will substitute any parenthesized matches into the given
1122        string and use it as a new <var>url</var>.</p>
1123
1124     <p>Suppose the local server has address <code>http://example.com/</code>;
1125     then</p>
1126
1127     <div class="example"><p><code>
1128       ProxyPassMatch ^(/.*\.gif)$ http://backend.example.com$1
1129     </code></p></div>
1130
1131     <p>will cause a local request for
1132     <code>http://example.com/foo/bar.gif</code> to be internally converted
1133     into a proxy request to <code>http://backend.example.com/foo/bar.gif</code>.</p>
1134
1135     <p>The <code>!</code> directive is useful in situations where you don't want
1136     to reverse-proxy a subdirectory.</p>
1137
1138 </div>
1139 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1140 <div class="directive-section"><h2><a name="ProxyPassReverse" id="ProxyPassReverse">ProxyPassReverse</a> <a name="proxypassreverse" id="proxypassreverse">Directive</a></h2>
1141 <table class="directive">
1142 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Adjusts the URL in HTTP response headers sent from a reverse
1143 proxied server</td></tr>
1144 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyPassReverse [<var>path</var>] <var>url</var>
1145 [<var>interpolate</var>]</code></td></tr>
1146 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
1147 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1148 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
1149 </table>
1150     <p>This directive lets Apache adjust the URL in the <code>Location</code>,
1151     <code>Content-Location</code> and <code>URI</code> headers on HTTP
1152     redirect responses. This is essential when Apache is used as a
1153     reverse proxy (or gateway) to avoid by-passing the reverse proxy
1154     because of HTTP redirects on the backend servers which stay behind
1155     the reverse proxy.</p>
1156
1157     <p>Only the HTTP response headers specifically mentioned above
1158     will be rewritten.  Apache will not rewrite other response
1159     headers, nor will it rewrite URL references inside HTML pages.
1160     This means that if the proxied content contains absolute URL
1161     references, they will by-pass the proxy.  A third-party module
1162     that will look inside the HTML and rewrite URL references is Nick
1163     Kew's <a href="http://apache.webthing.com/mod_proxy_html/">mod_proxy_html</a>.</p>
1164
1165     <p><var>path</var> is the name of a local virtual path. <var>url</var> is a
1166     partial URL for the remote server - the same way they are used for the
1167     <code class="directive"><a href="#proxypass">ProxyPass</a></code> directive.</p>
1168
1169     <p>For example, suppose the local server has address
1170     <code>http://example.com/</code>; then</p>
1171
1172     <div class="example"><p><code>
1173       ProxyPass         /mirror/foo/ http://backend.example.com/<br />
1174       ProxyPassReverse  /mirror/foo/ http://backend.example.com/<br />
1175       ProxyPassReverseCookieDomain  backend.example.com  public.example.com<br />
1176       ProxyPassReverseCookiePath  /  /mirror/foo/
1177     </code></p></div>
1178
1179     <p>will not only cause a local request for the
1180     <code>http://example.com/mirror/foo/bar</code> to be internally converted
1181     into a proxy request to <code>http://backend.example.com/bar</code>
1182     (the functionality <code>ProxyPass</code> provides here). It also takes care
1183     of redirects the server <code>backend.example.com</code> sends: when
1184     <code>http://backend.example.com/bar</code> is redirected by him to
1185     <code>http://backend.example.com/quux</code> Apache adjusts this to
1186     <code>http://example.com/mirror/foo/quux</code> before forwarding the HTTP
1187     redirect response to the client. Note that the hostname used for
1188     constructing the URL is chosen in respect to the setting of the <code class="directive"><a href="../mod/core.html#usecanonicalname">UseCanonicalName</a></code> directive.</p>
1189
1190     <p>Note that this <code class="directive">ProxyPassReverse</code> directive can
1191     also be used in conjunction with the proxy pass-through feature
1192     (<code>RewriteRule ...  [P]</code>) from <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>
1193     because it doesn't depend on a corresponding <code class="directive"><a href="#proxypass">ProxyPass</a></code> directive.</p>
1194
1195     <p>The optional <var>interpolate</var> keyword (available in
1196     httpd 2.2.9 and later), used together with
1197     <code class="directive">ProxyPassInterpolateEnv</code>, enables interpolation
1198     of environment variables specified using the format <var>${VARNAME}</var>.
1199     </p>
1200
1201     <p>When used inside a <code class="directive"><a href="../mod/core.html#location">&lt;Location&gt;</a></code> section, the first argument is omitted and the local
1202     directory is obtained from the <code class="directive"><a href="../mod/core.html#location">&lt;Location&gt;</a></code>.</p>
1203
1204 </div>
1205 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1206 <div class="directive-section"><h2><a name="ProxyPassReverseCookieDomain" id="ProxyPassReverseCookieDomain">ProxyPassReverseCookieDomain</a> <a name="proxypassreversecookiedomain" id="proxypassreversecookiedomain">Directive</a></h2>
1207 <table class="directive">
1208 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Adjusts the Domain string in Set-Cookie headers from a reverse-
1209 proxied server</td></tr>
1210 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyPassReverseCookieDomain <var>internal-domain</var>
1211 <var>public-domain</var> [<var>interpolate</var>]</code></td></tr>
1212 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
1213 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1214 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
1215 </table>
1216 <p>Usage is basically similar to
1217 <code class="directive"><a href="#proxypassreverse">ProxyPassReverse</a></code>, but instead of
1218 rewriting headers that are a URL, this rewrites the <code>domain</code>
1219 string in <code>Set-Cookie</code> headers.</p>
1220
1221 </div>
1222 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1223 <div class="directive-section"><h2><a name="ProxyPassReverseCookiePath" id="ProxyPassReverseCookiePath">ProxyPassReverseCookiePath</a> <a name="proxypassreversecookiepath" id="proxypassreversecookiepath">Directive</a></h2>
1224 <table class="directive">
1225 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Adjusts the Path string in Set-Cookie headers from a reverse-
1226 proxied server</td></tr>
1227 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyPassReverseCookiePath <var>internal-path</var>
1228 <var>public-path</var> [<var>interpolate</var>]</code></td></tr>
1229 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
1230 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1231 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
1232 </table>
1233 <p>Usage is basically similar to
1234 <code class="directive"><a href="#proxypassreverse">ProxyPassReverse</a></code>, but instead of
1235 rewriting headers that are a URL, this rewrites the <code>path</code>
1236 string in <code>Set-Cookie</code> headers.</p>
1237
1238 </div>
1239 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1240 <div class="directive-section"><h2><a name="ProxyPreserveHost" id="ProxyPreserveHost">ProxyPreserveHost</a> <a name="proxypreservehost" id="proxypreservehost">Directive</a></h2>
1241 <table class="directive">
1242 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Use incoming Host HTTP request header for proxy
1243 request</td></tr>
1244 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyPreserveHost On|Off</code></td></tr>
1245 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ProxyPreserveHost Off</code></td></tr>
1246 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1247 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1248 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
1249 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.0.31 and later.</td></tr>
1250 </table>
1251     <p>When enabled, this option will pass the Host: line from the incoming
1252     request to the proxied host, instead of the hostname specified in the
1253     <code class="directive">ProxyPass</code> line.</p>
1254
1255     <p>This option should normally be turned <code>Off</code>. It is mostly
1256     useful in special configurations like proxied mass name-based virtual
1257     hosting, where the original Host header needs to be evaluated by the
1258     backend server.</p>
1259
1260 </div>
1261 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1262 <div class="directive-section"><h2><a name="ProxyReceiveBufferSize" id="ProxyReceiveBufferSize">ProxyReceiveBufferSize</a> <a name="proxyreceivebuffersize" id="proxyreceivebuffersize">Directive</a></h2>
1263 <table class="directive">
1264 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Network buffer size for proxied HTTP and FTP
1265 connections</td></tr>
1266 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyReceiveBufferSize <var>bytes</var></code></td></tr>
1267 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ProxyReceiveBufferSize 0</code></td></tr>
1268 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1269 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1270 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
1271 </table>
1272     <p>The <code class="directive">ProxyReceiveBufferSize</code> directive specifies an
1273     explicit (TCP/IP) network buffer size for proxied HTTP and FTP connections,
1274     for increased throughput. It has to be greater than <code>512</code> or set
1275     to <code>0</code> to indicate that the system's default buffer size should
1276     be used.</p>
1277
1278     <div class="example"><h3>Example</h3><p><code>
1279       ProxyReceiveBufferSize 2048
1280     </code></p></div>
1281
1282 </div>
1283 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1284 <div class="directive-section"><h2><a name="ProxyRemote" id="ProxyRemote">ProxyRemote</a> <a name="proxyremote" id="proxyremote">Directive</a></h2>
1285 <table class="directive">
1286 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Remote proxy used to handle certain requests</td></tr>
1287 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyRemote <var>match</var> <var>remote-server</var></code></td></tr>
1288 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1289 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1290 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
1291 </table>
1292     <p>This defines remote proxies to this proxy. <var>match</var> is either the
1293     name of a URL-scheme that the remote server supports, or a partial URL
1294     for which the remote server should be used, or <code>*</code> to indicate
1295     the server should be contacted for all requests. <var>remote-server</var> is
1296     a partial URL for the remote server. Syntax:</p>
1297
1298     <div class="example"><p><code>
1299       <dfn>remote-server</dfn> =
1300           <var>scheme</var>://<var>hostname</var>[:<var>port</var>]
1301     </code></p></div>
1302
1303     <p><var>scheme</var> is effectively the protocol that should be used to
1304     communicate with the remote server; only <code>http</code> is supported by
1305     this module.</p>
1306
1307     <div class="example"><h3>Example</h3><p><code>
1308       ProxyRemote http://goodguys.example.com/ http://mirrorguys.example.com:8000<br />
1309       ProxyRemote * http://cleverproxy.localdomain<br />
1310       ProxyRemote ftp http://ftpproxy.mydomain:8080
1311     </code></p></div>
1312
1313     <p>In the last example, the proxy will forward FTP requests, encapsulated
1314     as yet another HTTP proxy request, to another proxy which can handle
1315     them.</p>
1316
1317     <p>This option also supports reverse proxy configuration - a backend
1318     webserver can be embedded within a virtualhost URL space even if that
1319     server is hidden by another forward proxy.</p>
1320
1321 </div>
1322 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1323 <div class="directive-section"><h2><a name="ProxyRemoteMatch" id="ProxyRemoteMatch">ProxyRemoteMatch</a> <a name="proxyremotematch" id="proxyremotematch">Directive</a></h2>
1324 <table class="directive">
1325 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Remote proxy used to handle requests matched by regular
1326 expressions</td></tr>
1327 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyRemoteMatch <var>regex</var> <var>remote-server</var></code></td></tr>
1328 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1329 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1330 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
1331 </table>
1332     <p>The <code class="directive">ProxyRemoteMatch</code> is identical to the
1333     <code class="directive"><a href="#proxyremote">ProxyRemote</a></code> directive, except the
1334     first argument is a <a class="glossarylink" href="../glossary.html#regex" title="see glossary">regular expression</a>
1335     match against the requested URL.</p>
1336
1337 </div>
1338 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1339 <div class="directive-section"><h2><a name="ProxyRequests" id="ProxyRequests">ProxyRequests</a> <a name="proxyrequests" id="proxyrequests">Directive</a></h2>
1340 <table class="directive">
1341 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enables forward (standard) proxy requests</td></tr>
1342 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyRequests On|Off</code></td></tr>
1343 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ProxyRequests Off</code></td></tr>
1344 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1345 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1346 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
1347 </table>
1348     <p>This allows or prevents Apache from functioning as a forward proxy
1349     server. (Setting ProxyRequests to <code>Off</code> does not disable use of
1350     the <code class="directive"><a href="#proxypass">ProxyPass</a></code> directive.)</p>
1351
1352     <p>In a typical reverse proxy or gateway configuration, this
1353     option should be set to
1354     <code>Off</code>.</p>
1355
1356     <p>In order to get the functionality of proxying HTTP or FTP sites, you
1357     need also <code class="module"><a href="../mod/mod_proxy_http.html">mod_proxy_http</a></code> or <code class="module"><a href="../mod/mod_proxy_ftp.html">mod_proxy_ftp</a></code>
1358     (or both) present in the server.</p>
1359
1360     <div class="warning"><h3>Warning</h3>
1361       <p>Do not enable proxying with <code class="directive"><a href="#proxyrequests">ProxyRequests</a></code> until you have <a href="#access">secured your server</a>.  Open proxy servers are dangerous
1362       both to your network and to the Internet at large.</p>
1363     </div>
1364
1365 <h3>See also</h3>
1366 <ul>
1367 <li><a href="#forwardreverse">Forward and Reverse Proxies/Gateways</a></li>
1368 </ul>
1369 </div>
1370 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1371 <div class="directive-section"><h2><a name="ProxySet" id="ProxySet">ProxySet</a> <a name="proxyset" id="proxyset">Directive</a></h2>
1372 <table class="directive">
1373 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set various Proxy balancer or member parameters</td></tr>
1374 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxySet <var>url</var> <var>key=value [key=value ...]</var></code></td></tr>
1375 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory</td></tr>
1376 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1377 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
1378 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>ProxySet is only available in Apache 2.2
1379   and later.</td></tr>
1380 </table>
1381     <p>This directive is used as an alternate method of setting any of the
1382     parameters available to Proxy balancers and workers normally done via the
1383     <code class="directive"><a href="#proxypass">ProxyPass</a></code> directive. If used
1384     within a <code>&lt;Proxy <var>balancer url|worker url</var>&gt;</code>
1385     container directive, the <var>url</var> argument is not required. As a side
1386     effect the respective balancer or worker gets created. This can be useful
1387     when doing reverse proxying via a
1388     <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> instead of a
1389     <code class="directive"><a href="#proxypass">ProxyPass</a></code> directive.</p>
1390
1391     <div class="example"><p><code>
1392       &lt;Proxy balancer://hotcluster&gt;<br />
1393       <span class="indent">
1394         BalancerMember http://www2.example.com:8009 loadfactor=1<br />
1395         BalancerMember http://www3.example.com:8009 loadfactor=2<br />
1396         ProxySet lbmethod=bytraffic<br />
1397       </span>
1398       &lt;/Proxy&gt;
1399     </code></p></div>
1400
1401     <div class="example"><p><code>
1402       &lt;Proxy http://backend&gt;<br />
1403       <span class="indent">
1404         ProxySet keepalive=On<br />
1405       </span>
1406       &lt;/Proxy&gt;
1407     </code></p></div>
1408
1409     <div class="example"><p><code>
1410         ProxySet balancer://foo lbmethod=bytraffic timeout=15
1411     </code></p></div>
1412
1413     <div class="example"><p><code>
1414         ProxySet ajp://backend:7001 timeout=15
1415     </code></p></div>
1416
1417    <div class="warning"><h3>Warning</h3>
1418       <p>Keep in mind that the same parameter key can have a different meaning
1419       depending whether it is applied to a balancer or a worker as shown by the two
1420       examples above regarding timeout.</p>
1421    </div>
1422
1423
1424 </div>
1425 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1426 <div class="directive-section"><h2><a name="ProxyStatus" id="ProxyStatus">ProxyStatus</a> <a name="proxystatus" id="proxystatus">Directive</a></h2>
1427 <table class="directive">
1428 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Show Proxy LoadBalancer status in mod_status</td></tr>
1429 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyStatus Off|On|Full</code></td></tr>
1430 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ProxyStatus Off</code></td></tr>
1431 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1432 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1433 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
1434 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.2 and later</td></tr>
1435 </table>
1436     <p>This directive determines whether or not proxy
1437     loadbalancer status data is displayed via the <code class="module"><a href="../mod/mod_status.html">mod_status</a></code>
1438     server-status page.</p>
1439     <div class="note"><h3>Note</h3>
1440       <p><strong>Full</strong> is synonymous with <strong>On</strong></p>
1441     </div>
1442
1443
1444 </div>
1445 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1446 <div class="directive-section"><h2><a name="ProxyTimeout" id="ProxyTimeout">ProxyTimeout</a> <a name="proxytimeout" id="proxytimeout">Directive</a></h2>
1447 <table class="directive">
1448 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Network timeout for proxied requests</td></tr>
1449 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyTimeout <var>seconds</var></code></td></tr>
1450 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Value of <code class="directive"><a href="../mod/core.html#timeout">Timeout</a></code></code></td></tr>
1451 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1452 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1453 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
1454 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.0.31 and later</td></tr>
1455 </table>
1456     <p>This directive allows a user to specifiy a timeout on proxy requests.
1457     This is useful when you have a slow/buggy appserver which hangs, and you
1458     would rather just return a timeout and fail gracefully instead of waiting
1459     however long it takes the server to return.</p>
1460
1461 </div>
1462 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1463 <div class="directive-section"><h2><a name="ProxyVia" id="ProxyVia">ProxyVia</a> <a name="proxyvia" id="proxyvia">Directive</a></h2>
1464 <table class="directive">
1465 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Information provided in the <code>Via</code> HTTP response
1466 header for proxied requests</td></tr>
1467 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyVia On|Off|Full|Block</code></td></tr>
1468 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ProxyVia Off</code></td></tr>
1469 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1470 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1471 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
1472 </table>
1473     <p>This directive controls the use of the <code>Via:</code> HTTP
1474     header by the proxy. Its intended use is to control the flow of
1475     proxy requests along a chain of proxy servers.  See <a href="http://www.ietf.org/rfc/rfc2616.txt">RFC 2616</a> (HTTP/1.1), section
1476     14.45 for an explanation of <code>Via:</code> header lines.</p>
1477
1478     <ul>
1479     <li>If set to <code>Off</code>, which is the default, no special processing
1480     is performed. If a request or reply contains a <code>Via:</code> header,
1481     it is passed through unchanged.</li>
1482
1483     <li>If set to <code>On</code>, each request and reply will get a
1484     <code>Via:</code> header line added for the current host.</li>
1485
1486     <li>If set to <code>Full</code>, each generated <code>Via:</code> header
1487     line will additionally have the Apache server version shown as a
1488     <code>Via:</code> comment field.</li>
1489
1490     <li>If set to <code>Block</code>, every proxy request will have all its
1491     <code>Via:</code> header lines removed. No new <code>Via:</code> header will
1492     be generated.</li>
1493     </ul>
1494
1495 </div>
1496 </div>
1497 <div class="bottomlang">
1498 <p><span>Available Languages: </span><a href="../en/mod/mod_proxy.html" title="English">&nbsp;en&nbsp;</a> |
1499 <a href="../ja/mod/mod_proxy.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a></p>
1500 </div><div id="footer">
1501 <p class="apache">Copyright 2009 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
1502 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>
1503 </body></html>