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