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
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" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
12 <script src="../style/scripts/prettify.min.js" type="text/javascript">
15 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
17 <div id="page-header">
18 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
19 <p class="apache">Apache HTTP Server Version 2.5</p>
20 <img alt="" src="../images/feather.gif" /></div>
21 <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
23 <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.5</a> > <a href="./">Modules</a></div>
24 <div id="page-content">
25 <div id="preamble"><h1>Apache Module mod_proxy</h1>
27 <p><span>Available Languages: </span><a href="../en/mod/mod_proxy.html" title="English"> en </a> |
28 <a href="../fr/mod/mod_proxy.html" hreflang="fr" rel="alternate" title="Français"> fr </a> |
29 <a href="../ja/mod/mod_proxy.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a></p>
31 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Multi-protocol proxy/gateway server</td></tr>
32 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
33 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>proxy_module</td></tr>
34 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_proxy.c</td></tr></table>
37 <div class="warning"><h3>Warning</h3>
38 <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
39 network and to the Internet at large.</p>
42 <p><code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code> and related modules implement a
43 proxy/gateway for Apache HTTP Server, supporting a number of popular
44 protocols as well as several different load balancing algorithms.
45 Third-party modules can add support for additional protocols and
46 load balancing algorithms.</p>
48 <p>A set of modules must be loaded into the server to provide the
49 necessary features. These modules can be included statically at
50 build time or dynamically via the
51 <code class="directive"><a href="../mod/mod_so.html#loadmodule">LoadModule</a></code> directive).
52 The set must include:</p>
55 <li><code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code>, which provides basic proxy
58 <li><code class="module"><a href="../mod/mod_proxy_balancer.html">mod_proxy_balancer</a></code> and one or more
59 balancer modules, if load balancing is required. (See
60 <code class="module"><a href="../mod/mod_proxy_balancer.html">mod_proxy_balancer</a></code> for more information.)</li>
62 <li>one or more proxy scheme, or protocol, modules:
64 <table class="bordered">
65 <tr><th>Protocol</th><th>Module</th></tr>
66 <tr><td>AJP13 (Apache JServe Protocol version
67 1.3)</td><td><code class="module"><a href="../mod/mod_proxy_ajp.html">mod_proxy_ajp</a></code></td></tr>
69 SSL)</td><td><code class="module"><a href="../mod/mod_proxy_connect.html">mod_proxy_connect</a></code></td></tr>
70 <tr><td>FastCGI</td><td><code class="module"><a href="../mod/mod_proxy_fcgi.html">mod_proxy_fcgi</a></code></td></tr>
71 <tr><td>ftp</td><td><code class="module"><a href="../mod/mod_proxy_ftp.html">mod_proxy_ftp</a></code></td></tr>
72 <tr><td>HTTP/0.9, HTTP/1.0, and
73 HTTP/1.1</td><td><code class="module"><a href="../mod/mod_proxy_http.html">mod_proxy_http</a></code></td></tr>
74 <tr><td>SCGI</td><td><code class="module"><a href="../mod/mod_proxy_scgi.html">mod_proxy_scgi</a></code></td></tr>
75 <tr><td>WS and WSS (Web-sockets)</td><td><code class="module"><a href="../mod/mod_proxy_wstunnel.html">mod_proxy_wstunnel</a></code></td></tr>
80 <p>In addition, extended features are provided by other modules.
81 Caching is provided by <code class="module"><a href="../mod/mod_cache.html">mod_cache</a></code> and related
82 modules. The ability to contact remote servers using the SSL/TLS
83 protocol is provided by the <code>SSLProxy*</code> directives of
84 <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code>. These additional modules will need
85 to be loaded and configured to take advantage of these features.</p>
87 <div id="quickview"><h3 class="directives">Directives</h3>
89 <li><img alt="" src="../images/down.gif" /> <a href="#balancergrowth">BalancerGrowth</a></li>
90 <li><img alt="" src="../images/down.gif" /> <a href="#balancerinherit">BalancerInherit</a></li>
91 <li><img alt="" src="../images/down.gif" /> <a href="#balancermember">BalancerMember</a></li>
92 <li><img alt="" src="../images/down.gif" /> <a href="#balancerpersist">BalancerPersist</a></li>
93 <li><img alt="" src="../images/down.gif" /> <a href="#noproxy">NoProxy</a></li>
94 <li><img alt="" src="../images/down.gif" /> <a href="#proxy"><Proxy></a></li>
95 <li><img alt="" src="../images/down.gif" /> <a href="#proxyaddheaders">ProxyAddHeaders</a></li>
96 <li><img alt="" src="../images/down.gif" /> <a href="#proxybadheader">ProxyBadHeader</a></li>
97 <li><img alt="" src="../images/down.gif" /> <a href="#proxyblock">ProxyBlock</a></li>
98 <li><img alt="" src="../images/down.gif" /> <a href="#proxydomain">ProxyDomain</a></li>
99 <li><img alt="" src="../images/down.gif" /> <a href="#proxyerroroverride">ProxyErrorOverride</a></li>
100 <li><img alt="" src="../images/down.gif" /> <a href="#proxyiobuffersize">ProxyIOBufferSize</a></li>
101 <li><img alt="" src="../images/down.gif" /> <a href="#proxymatch"><ProxyMatch></a></li>
102 <li><img alt="" src="../images/down.gif" /> <a href="#proxymaxforwards">ProxyMaxForwards</a></li>
103 <li><img alt="" src="../images/down.gif" /> <a href="#proxypass">ProxyPass</a></li>
104 <li><img alt="" src="../images/down.gif" /> <a href="#proxypassinherit">ProxyPassInherit</a></li>
105 <li><img alt="" src="../images/down.gif" /> <a href="#proxypassinterpolateenv">ProxyPassInterpolateEnv</a></li>
106 <li><img alt="" src="../images/down.gif" /> <a href="#proxypassmatch">ProxyPassMatch</a></li>
107 <li><img alt="" src="../images/down.gif" /> <a href="#proxypassreverse">ProxyPassReverse</a></li>
108 <li><img alt="" src="../images/down.gif" /> <a href="#proxypassreversecookiedomain">ProxyPassReverseCookieDomain</a></li>
109 <li><img alt="" src="../images/down.gif" /> <a href="#proxypassreversecookiepath">ProxyPassReverseCookiePath</a></li>
110 <li><img alt="" src="../images/down.gif" /> <a href="#proxypreservehost">ProxyPreserveHost</a></li>
111 <li><img alt="" src="../images/down.gif" /> <a href="#proxyreceivebuffersize">ProxyReceiveBufferSize</a></li>
112 <li><img alt="" src="../images/down.gif" /> <a href="#proxyremote">ProxyRemote</a></li>
113 <li><img alt="" src="../images/down.gif" /> <a href="#proxyremotematch">ProxyRemoteMatch</a></li>
114 <li><img alt="" src="../images/down.gif" /> <a href="#proxyrequests">ProxyRequests</a></li>
115 <li><img alt="" src="../images/down.gif" /> <a href="#proxyset">ProxySet</a></li>
116 <li><img alt="" src="../images/down.gif" /> <a href="#proxysourceaddress">ProxySourceAddress</a></li>
117 <li><img alt="" src="../images/down.gif" /> <a href="#proxystatus">ProxyStatus</a></li>
118 <li><img alt="" src="../images/down.gif" /> <a href="#proxytimeout">ProxyTimeout</a></li>
119 <li><img alt="" src="../images/down.gif" /> <a href="#proxyvia">ProxyVia</a></li>
123 <li><img alt="" src="../images/down.gif" /> <a href="#forwardreverse">Forward Proxies and Reverse
124 Proxies/Gateways</a></li>
125 <li><img alt="" src="../images/down.gif" /> <a href="#examples">Basic Examples</a></li>
126 <li><img alt="" src="../images/down.gif" /> <a href="#handler">Access via Handler</a></li>
127 <li><img alt="" src="../images/down.gif" /> <a href="#workers">Workers</a></li>
128 <li><img alt="" src="../images/down.gif" /> <a href="#access">Controlling access to your proxy</a></li>
129 <li><img alt="" src="../images/down.gif" /> <a href="#startup">Slow Startup</a></li>
130 <li><img alt="" src="../images/down.gif" /> <a href="#intranet">Intranet Proxy</a></li>
131 <li><img alt="" src="../images/down.gif" /> <a href="#envsettings">Protocol Adjustments</a></li>
132 <li><img alt="" src="../images/down.gif" /> <a href="#request-bodies">Request Bodies</a></li>
133 <li><img alt="" src="../images/down.gif" /> <a href="#x-headers">Reverse Proxy Request Headers</a></li>
134 </ul><h3>See also</h3>
136 <li><code class="module"><a href="../mod/mod_cache.html">mod_cache</a></code></li>
137 <li><code class="module"><a href="../mod/mod_proxy_ajp.html">mod_proxy_ajp</a></code></li>
138 <li><code class="module"><a href="../mod/mod_proxy_connect.html">mod_proxy_connect</a></code></li>
139 <li><code class="module"><a href="../mod/mod_proxy_fcgi.html">mod_proxy_fcgi</a></code></li>
140 <li><code class="module"><a href="../mod/mod_proxy_ftp.html">mod_proxy_ftp</a></code></li>
141 <li><code class="module"><a href="../mod/mod_proxy_http.html">mod_proxy_http</a></code></li>
142 <li><code class="module"><a href="../mod/mod_proxy_scgi.html">mod_proxy_scgi</a></code></li>
143 <li><code class="module"><a href="../mod/mod_proxy_wstunnel.html">mod_proxy_wstunnel</a></code></li>
144 <li><code class="module"><a href="../mod/mod_proxy_balancer.html">mod_proxy_balancer</a></code></li>
145 <li><code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code></li>
146 </ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
147 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
148 <div class="section">
149 <h2><a name="forwardreverse" id="forwardreverse">Forward Proxies and Reverse
150 Proxies/Gateways</a></h2>
151 <p>Apache HTTP Server can be configured in both a <dfn>forward</dfn> and
152 <dfn>reverse</dfn> proxy (also known as <dfn>gateway</dfn>) mode.</p>
154 <p>An ordinary <dfn>forward proxy</dfn> is an intermediate
155 server that sits between the client and the <em>origin
156 server</em>. In order to get content from the origin server,
157 the client sends a request to the proxy naming the origin server
158 as the target and the proxy then requests the content from the
159 origin server and returns it to the client. The client must be
160 specially configured to use the forward proxy to access other
163 <p>A typical usage of a forward proxy is to provide Internet
164 access to internal clients that are otherwise restricted by a
165 firewall. The forward proxy can also use caching (as provided
166 by <code class="module"><a href="../mod/mod_cache.html">mod_cache</a></code>) to reduce network usage.</p>
168 <p>The forward proxy is activated using the <code class="directive"><a href="#proxyrequests">ProxyRequests</a></code> directive. Because
169 forward proxies allow clients to access arbitrary sites through
170 your server and to hide their true origin, it is essential that
171 you <a href="#access">secure your server</a> so that only
172 authorized clients can access the proxy before activating a
175 <p>A <dfn>reverse proxy</dfn> (or <dfn>gateway</dfn>), by
176 contrast, appears to the client just like an ordinary web
177 server. No special configuration on the client is necessary.
178 The client makes ordinary requests for content in the name-space
179 of the reverse proxy. The reverse proxy then decides where to
180 send those requests, and returns the content as if it was itself
183 <p>A typical usage of a reverse proxy is to provide Internet
184 users access to a server that is behind a firewall. Reverse
185 proxies can also be used to balance load among several back-end
186 servers, or to provide caching for a slower back-end server.
187 In addition, reverse proxies can be used simply to bring
188 several servers into the same URL space.</p>
190 <p>A reverse proxy is activated using the <code class="directive"><a href="#proxypass">ProxyPass</a></code> directive or the
191 <code>[P]</code> flag to the <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> directive. It is
192 <strong>not</strong> necessary to turn <code class="directive"><a href="#proxyrequests">ProxyRequests</a></code> on in order to
193 configure a reverse proxy.</p>
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="examples" id="examples">Basic Examples</a></h2>
198 <p>The examples below are only a very basic idea to help you
199 get started. Please read the documentation on the individual
202 <p>In addition, if you wish to have caching enabled, consult
203 the documentation from <code class="module"><a href="../mod/mod_cache.html">mod_cache</a></code>.</p>
205 <div class="example"><h3>Reverse Proxy</h3><pre class="prettyprint lang-config">ProxyPass /foo http://foo.example.com/bar
206 ProxyPassReverse /foo http://foo.example.com/bar</pre>
209 <div class="example"><h3>Forward Proxy</h3><pre class="prettyprint lang-config">ProxyRequests On
213 Require host internal.example.com
216 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
217 <div class="section">
218 <h2><a name="handler" id="handler">Access via Handler</a></h2>
220 <p>You can also force a request to be handled as a reverse-proxy
221 request, by creating a suitable Handler pass-thru. For example,
222 the below will pass all PHP scripts to the specified
223 reverse-proxy FCGI server:
226 <div class="example"><h3>Reverse Proxy PHP scripts</h3><pre class="prettyprint lang-config"><FilesMatch \.php$>
227 SetHandler "proxy:unix:/path/to/app.sock|fcgi://localhost/"
228 </FilesMatch></pre>
230 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
231 <div class="section">
232 <h2><a name="workers" id="workers">Workers</a></h2>
233 <p>The proxy manages the configuration of origin servers and their
234 communication parameters in objects called <dfn>workers</dfn>.
235 There are two built-in workers, the default forward proxy worker and the
236 default reverse proxy worker. Additional workers can be configured
239 <p>The two default workers have a fixed configuration
240 and will be used if no other worker matches the request.
241 They do not use HTTP Keep-Alive or connection pooling.
242 The TCP connections to the origin server will instead be
243 opened and closed for each request.</p>
245 <p>Explicitly configured workers are identified by their URL.
246 They are usually created and configured using
247 <code class="directive"><a href="#proxypass">ProxyPass</a></code> or
248 <code class="directive"><a href="#proxypassmatch">ProxyPassMatch</a></code> when used
249 for a reverse proxy:</p>
251 <pre class="prettyprint lang-config">ProxyPass /example http://backend.example.com connectiontimeout=5 timeout=30</pre>
254 <p>This will create a worker associated with the origin server URL
255 <code>http://backend.example.com</code> and using the given timeout
256 values. When used in a forward proxy, workers are usually defined
257 via the <code class="directive"><a href="#proxyset">ProxySet</a></code> directive:</p>
259 <pre class="prettyprint lang-config">ProxySet http://backend.example.com connectiontimeout=5 timeout=30</pre>
262 <p>or alternatively using <code class="directive"><a href="#proxy">Proxy</a></code>
263 and <code class="directive"><a href="#proxyset">ProxySet</a></code>:</p>
265 <pre class="prettyprint lang-config"><Proxy http://backend.example.com>
266 ProxySet connectiontimeout=5 timeout=30
270 <p>Using explicitly configured workers in the forward mode is
271 not very common, because forward proxies usually communicate with many
272 different origin servers. Creating explicit workers for some of the
273 origin servers can still be useful, if they are used very often.
274 Explicitly configured workers have no concept of forward or reverse
275 proxying by themselves. They encapsulate a common concept of
276 communication with origin servers. A worker created by
277 <code class="directive"><a href="#proxypass">ProxyPass</a></code> for use in a
278 reverse proxy will be also used for forward proxy requests whenever
279 the URL to the origin server matches the worker URL and vice versa.</p>
281 <p>The URL identifying a direct worker is the URL of its
282 origin server including any path components given:</p>
284 <pre class="prettyprint lang-config">ProxyPass /examples http://backend.example.com/examples
285 ProxyPass /docs http://backend.example.com/docs</pre>
288 <p>This example defines two different workers, each using a separate
289 connection pool and configuration.</p>
291 <div class="warning"><h3>Worker Sharing</h3>
292 <p>Worker sharing happens if the worker URLs overlap, which occurs when
293 the URL of some worker is a leading substring of the URL of another
294 worker defined later in the configuration file. In the following example</p>
296 <pre class="prettyprint lang-config">ProxyPass /apps http://backend.example.com/ timeout=60
297 ProxyPass /examples http://backend.example.com/examples timeout=10</pre>
300 <p>the second worker isn't actually created. Instead the first
301 worker is used. The benefit is, that there is only one connection pool,
302 so connections are more often reused. Note that all configuration attributes
303 given explicitly for the later worker will be ignored. This will be logged
304 as a warning. In the above example the resulting timeout value
305 for the URL <code>/examples</code> will be <code>60</code> instead
306 of <code>10</code>!</p>
308 <p>If you want to avoid worker sharing, sort your worker definitions
309 by URL length, starting with the longest worker URLs. If you want to maximize
310 worker sharing use the reverse sort order. See also the related warning about
311 ordering <code class="directive"><a href="#proxypass">ProxyPass</a></code> directives.</p>
315 <p>Explicitly configured workers come in two flavors:
316 <dfn>direct workers</dfn> and <dfn>(load) balancer workers</dfn>.
317 They support many important configuration attributes which are
318 described below in the <code class="directive"><a href="#proxypass">ProxyPass</a></code>
319 directive. The same attributes can also be set using
320 <code class="directive"><a href="#proxyset">ProxySet</a></code>.</p>
322 <p>The set of options available for a direct worker
323 depends on the protocol, which is specified in the origin server URL.
324 Available protocols include <code>ajp</code>, <code>fcgi</code>,
325 <code>ftp</code>, <code>http</code> and <code>scgi</code>.</p>
327 <p>Balancer workers are virtual workers that use direct workers known
328 as their members to actually handle the requests. Each balancer can
329 have multiple members. When it handles a request, it chooses a member
330 based on the configured load balancing algorithm.</p>
332 <p>A balancer worker is created if its worker URL uses
333 <code>balancer</code> as the protocol scheme.
334 The balancer URL uniquely identifies the balancer worker.
335 Members are added to a balancer using
336 <code class="directive"><a href="#balancermember">BalancerMember</a></code>.</p>
338 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
339 <div class="section">
340 <h2><a name="access" id="access">Controlling access to your proxy</a></h2>
341 <p>You can control who can access your proxy via the <code class="directive"><a href="#proxy"><Proxy></a></code> control block as in
342 the following example:</p>
344 <pre class="prettyprint lang-config"><Proxy *>
349 <p>For more information on access control directives, see
350 <code class="module"><a href="../mod/mod_authz_host.html">mod_authz_host</a></code>.</p>
352 <p>Strictly limiting access is essential if you are using a
353 forward proxy (using the <code class="directive"><a href="#proxyrequests">ProxyRequests</a></code> directive).
354 Otherwise, your server can be used by any client to access
355 arbitrary hosts while hiding his or her true identity. This is
356 dangerous both for your network and for the Internet at large.
357 When using a reverse proxy (using the <code class="directive"><a href="#proxypass">ProxyPass</a></code> directive with
358 <code>ProxyRequests Off</code>), access control is less
359 critical because clients can only contact the hosts that you
360 have specifically configured.</p>
362 <p><strong>See Also</strong> the <a href="mod_proxy_http.html#env">Proxy-Chain-Auth</a> environment variable.</p>
364 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
365 <div class="section">
366 <h2><a name="startup" id="startup">Slow Startup</a></h2>
367 <p>If you're using the <code class="directive"><a href="#proxyblock">ProxyBlock</a></code> directive, hostnames' IP addresses are looked up
368 and cached during startup for later match test. This may take a few
369 seconds (or more) depending on the speed with which the hostname lookups
371 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
372 <div class="section">
373 <h2><a name="intranet" id="intranet">Intranet Proxy</a></h2>
374 <p>An Apache httpd proxy server situated in an intranet needs to forward
375 external requests through the company's firewall (for this, configure
376 the <code class="directive"><a href="#proxyremote">ProxyRemote</a></code> directive
377 to forward the respective <var>scheme</var> to the firewall proxy).
378 However, when it has to
379 access resources within the intranet, it can bypass the firewall when
380 accessing hosts. The <code class="directive"><a href="#noproxy">NoProxy</a></code>
381 directive is useful for specifying which hosts belong to the intranet and
382 should be accessed directly.</p>
384 <p>Users within an intranet tend to omit the local domain name from their
385 WWW requests, thus requesting "http://somehost/" instead of
386 <code>http://somehost.example.com/</code>. Some commercial proxy servers
387 let them get away with this and simply serve the request, implying a
388 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 httpd can return
389 a redirect response and send the client to the correct, fully qualified,
390 server address. This is the preferred method since the user's bookmark
391 files will then contain fully qualified hosts.</p>
392 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
393 <div class="section">
394 <h2><a name="envsettings" id="envsettings">Protocol Adjustments</a></h2>
395 <p>For circumstances where <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code> is sending
396 requests to an origin server that doesn't properly implement
397 keepalives or HTTP/1.1, there are two <a href="../env.html">environment variables</a> that can force the
398 request to use HTTP/1.0 with no keepalive. These are set via the
399 <code class="directive"><a href="../mod/mod_env.html#setenv">SetEnv</a></code> directive.</p>
401 <p>These are the <code>force-proxy-request-1.0</code> and
402 <code>proxy-nokeepalive</code> notes.</p>
404 <pre class="prettyprint lang-config"><Location /buggyappserver/>
405 ProxyPass http://buggyappserver:7001/foo/
406 SetEnv force-proxy-request-1.0 1
407 SetEnv proxy-nokeepalive 1
408 </Location></pre>
411 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
412 <div class="section">
413 <h2><a name="request-bodies" id="request-bodies">Request Bodies</a></h2>
415 <p>Some request methods such as POST include a request body.
416 The HTTP protocol requires that requests which include a body
417 either use chunked transfer encoding or send a
418 <code>Content-Length</code> request header. When passing these
419 requests on to the origin server, <code class="module"><a href="../mod/mod_proxy_http.html">mod_proxy_http</a></code>
420 will always attempt to send the <code>Content-Length</code>. But
421 if the body is large and the original request used chunked
422 encoding, then chunked encoding may also be used in the upstream
423 request. You can control this selection using <a href="../env.html">environment variables</a>. Setting
424 <code>proxy-sendcl</code> ensures maximum compatibility with
425 upstream servers by always sending the
426 <code>Content-Length</code>, while setting
427 <code>proxy-sendchunked</code> minimizes resource usage by using
428 chunked encoding.</p>
430 <p>Under some circumstances, the server must spool request bodies
431 to disk to satisfy the requested handling of request bodies. For
432 example, this spooling will occur if the original body was sent with
433 chunked encoding (and is large), but the administrator has
434 asked for backend requests to be sent with Content-Length or as HTTP/1.0.
435 This spooling can also occur if the request body already has a
436 Content-Length header, but the server is configured to filter incoming
439 <p><code class="directive"><a href="../mod/core.html#limitrequestbody">LimitRequestBody</a></code> only applies to
440 request bodies that the server will spool to disk</p>
442 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
443 <div class="section">
444 <h2><a name="x-headers" id="x-headers">Reverse Proxy Request Headers</a></h2>
446 <p>When acting in a reverse-proxy mode (using the <code class="directive"><a href="#proxypass">ProxyPass</a></code> directive, for example),
447 <code class="module"><a href="../mod/mod_proxy_http.html">mod_proxy_http</a></code> adds several request headers in
448 order to pass information to the origin server. These headers
452 <dt><code>X-Forwarded-For</code></dt>
453 <dd>The IP address of the client.</dd>
454 <dt><code>X-Forwarded-Host</code></dt>
455 <dd>The original host requested by the client in the <code>Host</code>
456 HTTP request header.</dd>
457 <dt><code>X-Forwarded-Server</code></dt>
458 <dd>The hostname of the proxy server.</dd>
461 <p>Be careful when using these headers on the origin server, since
462 they will contain more than one (comma-separated) value if the
463 original request already contained one of these headers. For
464 example, you can use <code>%{X-Forwarded-For}i</code> in the log
465 format string of the origin server to log the original clients IP
466 address, but you may get more than one address if the request
467 passes through several proxies.</p>
469 <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
470 other request headers.</p>
472 <p>Note: If you need to specify custom request headers to be
473 added to the forwarded request, use the
474 <code class="directive"><a href="../mod/mod_headers.html#requestheader">RequestHeader</a></code>
478 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
479 <div class="directive-section"><h2><a name="BalancerGrowth" id="BalancerGrowth">BalancerGrowth</a> <a name="balancergrowth" id="balancergrowth">Directive</a></h2>
480 <table class="directive">
481 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Number of additional Balancers that can be added Post-configuration</td></tr>
482 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>BalancerGrowth <var>#</var></code></td></tr>
483 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>BalancerGrowth 5</code></td></tr>
484 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
485 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
486 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
487 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>BalancerGrowth is only available in Apache HTTP Server 2.3.13
490 <p>This directive allows for growth potential in the number of
491 Balancers available for a virtualhost in addition to the
492 number pre-configured. It only takes effect if there is at
493 least 1 pre-configured Balancer.</p>
496 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
497 <div class="directive-section"><h2><a name="BalancerInherit" id="BalancerInherit">BalancerInherit</a> <a name="balancerinherit" id="balancerinherit">Directive</a></h2>
498 <table class="directive">
499 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Inherit proxy Balancers/Workers defined from the main server</td></tr>
500 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>BalancerInherit On|Off</code></td></tr>
501 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>BalancerInherit On</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 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>BalancerInherit is only available in Apache HTTP Server 2.4.5 and later.</td></tr>
507 <p>This directive will cause the current server/vhost to "inherit"
508 Balancers and Workers defined in the main server. This can cause issues and
509 inconsistent behavior if using the Balancer Manager for dynamic changes
510 and so should be disabled if using that feature.</p>
511 <p>The setting in the global server defines the default for all vhosts.</p>
512 <p>Disabling <code class="directive"><a href="#proxypassinherit">ProxyPassInherit</a></code> also disables BalancerInherit.</p>
515 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
516 <div class="directive-section"><h2><a name="BalancerMember" id="BalancerMember">BalancerMember</a> <a name="balancermember" id="balancermember">Directive</a></h2>
517 <table class="directive">
518 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Add a member to a load balancing group</td></tr>
519 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>BalancerMember [<var>balancerurl</var>] <var>url</var> [<var>key=value [key=value ...]]</var></code></td></tr>
520 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory</td></tr>
521 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
522 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
524 <p>This directive adds a member to a load balancing group. It could be used
525 within a <code><Proxy <var>balancer://</var>...></code> container
526 directive, and can take any of the key value pair parameters available to
527 <code class="directive"><a href="#proxypass">ProxyPass</a></code> directives.</p>
528 <p>One additional parameter is available only to <code class="directive">BalancerMember</code> directives:
529 <var>loadfactor</var>. This is the member load factor - a number between 1
530 (default) and 100, which defines the weighted load to be applied to the
531 member in question.</p>
532 <p>The <var>balancerurl</var> is only needed when not in <code><Proxy <var>balancer://</var>...></code>
533 container directive. It corresponds to the url of a balancer defined in
534 <code class="directive"><a href="#proxypass">ProxyPass</a></code> directive.</p>
535 <p>The path component of the balancer URL in any
536 <code><Proxy <var>balancer://</var>...></code> container directive
538 <p>Trailing slashes should typically be removed from the URL of a
539 <code class="directive">BalancerMember</code>.</p>
542 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
543 <div class="directive-section"><h2><a name="BalancerPersist" id="BalancerPersist">BalancerPersist</a> <a name="balancerpersist" id="balancerpersist">Directive</a></h2>
544 <table class="directive">
545 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Attempt to persist changes made by the Balancer Manager across restarts.</td></tr>
546 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>BalancerPersist On|Off</code></td></tr>
547 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>BalancerPersist Off</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>BalancerPersist is only available in Apache HTTP Server 2.4.4 and later.</td></tr>
553 <p>This directive will cause the shared memory storage associated
554 with the balancers and balancer members to be persisted across
555 restarts. This allows these local changes to not be lost during the
556 normal restart/graceful state transitions.</p>
559 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
560 <div class="directive-section"><h2><a name="NoProxy" id="NoProxy">NoProxy</a> <a name="noproxy" id="noproxy">Directive</a></h2>
561 <table class="directive">
562 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Hosts, domains, or networks that will be connected to
564 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>NoProxy <var>host</var> [<var>host</var>] ...</code></td></tr>
565 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
566 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
567 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
569 <p>This directive is only useful for Apache httpd proxy servers within
570 intranets. The <code class="directive">NoProxy</code> directive specifies a
571 list of subnets, IP addresses, hosts and/or domains, separated by
572 spaces. A request to a host which matches one or more of these is
573 always served directly, without forwarding to the configured
574 <code class="directive"><a href="#proxyremote">ProxyRemote</a></code> proxy server(s).</p>
576 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">ProxyRemote * http://firewall.example.com:81
577 NoProxy .example.com 192.168.112.0/21</pre>
580 <p>The <var>host</var> arguments to the <code class="directive">NoProxy</code>
581 directive are one of the following type list:</p>
585 <dt><var><a name="domain" id="domain">Domain</a></var></dt>
587 <p>A <dfn>Domain</dfn> is a partially qualified DNS domain name, preceded
588 by a period. It represents a list of hosts which logically belong to the
589 same DNS domain or zone (<em>i.e.</em>, the suffixes of the hostnames are
590 all ending in <var>Domain</var>).</p>
592 <div class="example"><h3>Examples</h3><p><code>
596 <p>To distinguish <var>Domain</var>s from <var><a href="#hostname">Hostname</a></var>s (both syntactically and semantically; a DNS domain can
597 have a DNS A record, too!), <var>Domain</var>s are always written with a
600 <div class="note"><h3>Note</h3>
601 <p>Domain name comparisons are done without regard to the case, and
602 <var>Domain</var>s are always assumed to be anchored in the root of the
603 DNS tree, therefore two domains <code>.ExAmple.com</code> and
604 <code>.example.com.</code> (note the trailing period) are considered
605 equal. Since a domain comparison does not involve a DNS lookup, it is much
606 more efficient than subnet comparison.</p>
610 <dt><var><a name="subnet" id="subnet">SubNet</a></var></dt>
612 <p>A <dfn>SubNet</dfn> is a partially qualified internet address in
613 numeric (dotted quad) form, optionally followed by a slash and the netmask,
614 specified as the number of significant bits in the <var>SubNet</var>. It is
615 used to represent a subnet of hosts which can be reached over a common
616 network interface. In the absence of the explicit net mask it is assumed
617 that omitted (or zero valued) trailing digits specify the mask. (In this
618 case, the netmask can only be multiples of 8 bits wide.) Examples:</p>
621 <dt><code>192.168</code> or <code>192.168.0.0</code></dt>
622 <dd>the subnet 192.168.0.0 with an implied netmask of 16 valid bits
623 (sometimes used in the netmask form <code>255.255.0.0</code>)</dd>
624 <dt><code>192.168.112.0/21</code></dt>
625 <dd>the subnet <code>192.168.112.0/21</code> with a netmask of 21
626 valid bits (also used in the form <code>255.255.248.0</code>)</dd>
629 <p>As a degenerate case, a <em>SubNet</em> with 32 valid bits is the
630 equivalent to an <var><a href="#ipaddr">IPAddr</a></var>, while a <var>SubNet</var> with zero
631 valid bits (<em>e.g.</em>, 0.0.0.0/0) is the same as the constant
632 <var>_Default_</var>, matching any IP address.</p></dd>
635 <dt><var><a name="ipaddr" id="ipaddr">IPAddr</a></var></dt>
637 <p>A <dfn>IPAddr</dfn> represents a fully qualified internet address in
638 numeric (dotted quad) form. Usually, this address represents a host, but
639 there need not necessarily be a DNS domain name connected with the
641 <div class="example"><h3>Example</h3><p><code>
645 <div class="note"><h3>Note</h3>
646 <p>An <var>IPAddr</var> does not need to be resolved by the DNS system, so
647 it can result in more effective apache performance.</p>
651 <dt><var><a name="hostname" id="hostname">Hostname</a></var></dt>
653 <p>A <dfn>Hostname</dfn> is a fully qualified DNS domain name which can
654 be resolved to one or more <var><a href="#ipaddr">IPAddrs</a></var> via the
655 DNS domain name service. It represents a logical host (in contrast to
656 <var><a href="#domain">Domain</a></var>s, see above) and must be resolvable
657 to at least one <var><a href="#ipaddr">IPAddr</a></var> (or often to a list
658 of hosts with different <var><a href="#ipaddr">IPAddr</a></var>s).</p>
660 <div class="example"><h3>Examples</h3><p><code>
661 prep.ai.example.edu<br />
665 <div class="note"><h3>Note</h3>
666 <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
667 DNS lookup can be avoided. Name resolution in Apache httpd can take a remarkable
668 deal of time when the connection to the name server uses a slow PPP
670 <p><var>Hostname</var> comparisons are done without regard to the case,
671 and <var>Hostname</var>s are always assumed to be anchored in the root
672 of the DNS tree, therefore two hosts <code>WWW.ExAmple.com</code>
673 and <code>www.example.com.</code> (note the trailing period) are
674 considered equal.</p>
680 <li><a href="../dns-caveats.html">DNS Issues</a></li>
683 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
684 <div class="directive-section"><h2><a name="Proxy" id="Proxy"><Proxy></a> <a name="proxy" id="proxy">Directive</a></h2>
685 <table class="directive">
686 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Container for directives applied to proxied resources</td></tr>
687 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code><Proxy <var>wildcard-url</var>> ...</Proxy></code></td></tr>
688 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
689 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
690 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
692 <p>Directives placed in <code class="directive"><Proxy></code>
693 sections apply only to matching proxied content. Shell-style wildcards are
696 <p>For example, the following will allow only hosts in
697 <code>yournetwork.example.com</code> to access content via your proxy
700 <pre class="prettyprint lang-config"><Proxy *>
701 Require host yournetwork.example.com
705 <p>The following example will process all files in the <code>foo</code>
706 directory of <code>example.com</code> through the <code>INCLUDES</code>
707 filter when they are sent through the proxy server:</p>
709 <pre class="prettyprint lang-config"><Proxy http://example.com/foo/*>
710 SetOutputFilter INCLUDES
714 <div class="note"><h3>Differences from the Location configuration section</h3>
715 <p>A backend URL matches the configuration section if it begins with the
716 the <var>wildcard-url</var> string, even if the last path segment in the
717 directive only matches a prefix of the backend URL. For example,
718 <Proxy http://example.com/foo> matches all of
719 http://example.com/foo, http://example.com/foo/bar, and
720 http://example.com/foobar. The matching of the final URL differs
721 from the behavior of the <code class="directive"><a href="../mod/core.html#location"><Location></a></code> section, which for purposes of this note
722 treats the final path component as if it ended in a slash.</p>
723 <p>For more control over the matching, see <code class="directive"><ProxyMatch></code>.</p>
729 <li><code class="directive"><a href="#proxymatch"><ProxyMatch></a></code></li>
732 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
733 <div class="directive-section"><h2><a name="ProxyAddHeaders" id="ProxyAddHeaders">ProxyAddHeaders</a> <a name="proxyaddheaders" id="proxyaddheaders">Directive</a></h2>
734 <table class="directive">
735 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Add proxy information in X-Forwarded-* headers</td></tr>
736 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyAddHeaders Off|On</code></td></tr>
737 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ProxyAddHeaders On</code></td></tr>
738 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
739 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
740 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
741 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.3.10 and later</td></tr>
743 <p>This directive determines whether or not proxy related information should be passed to the
744 backend server through X-Forwarded-For, X-Forwarded-Host and X-Forwarded-Server HTTP headers.</p>
745 <div class="note"><h3>Effectiveness</h3>
746 <p>This option is of use only for HTTP proxying, as handled by <code class="module"><a href="../mod/mod_proxy_http.html">mod_proxy_http</a></code>.</p>
750 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
751 <div class="directive-section"><h2><a name="ProxyBadHeader" id="ProxyBadHeader">ProxyBadHeader</a> <a name="proxybadheader" id="proxybadheader">Directive</a></h2>
752 <table class="directive">
753 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Determines how to handle bad header lines in a
755 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyBadHeader IsError|Ignore|StartBody</code></td></tr>
756 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ProxyBadHeader IsError</code></td></tr>
757 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
758 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
759 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
761 <p>The <code class="directive">ProxyBadHeader</code> directive determines the
762 behaviour of <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code> if it receives syntactically invalid
763 response header lines (<em>i.e.</em> containing no colon) from the origin
764 server. The following arguments are possible:</p>
767 <dt><code>IsError</code></dt>
768 <dd>Abort the request and end up with a 502 (Bad Gateway) response. This is
769 the default behaviour.</dd>
771 <dt><code>Ignore</code></dt>
772 <dd>Treat bad header lines as if they weren't sent.</dd>
774 <dt><code>StartBody</code></dt>
775 <dd>When receiving the first bad header line, finish reading the headers and
776 treat the remainder as body. This helps to work around buggy backend servers
777 which forget to insert an empty line between the headers and the body.</dd>
781 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
782 <div class="directive-section"><h2><a name="ProxyBlock" id="ProxyBlock">ProxyBlock</a> <a name="proxyblock" id="proxyblock">Directive</a></h2>
783 <table class="directive">
784 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Disallow proxy requests to certain hosts</td></tr>
785 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyBlock *|<var>hostname</var>|<var>partial-hostname</var> [<var>hostname</var>|<var>partial-hostname</var>]...</code></td></tr>
786 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
787 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
788 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
790 <p>The <code class="directive">ProxyBlock</code> directive can be used to
791 block FTP or HTTP access to certain hosts via the proxy, based on
792 a full or partial hostname match, or, if applicable, an IP address
795 <p>Each of the arguments to the <code class="directive">ProxyBlock</code>
796 directive can be either <code>*</code> or a alphanumeric string.
797 At startup, the module will attempt to resolve every alphanumeric
798 string from a DNS name to a set of IP addresses, but any DNS errors
801 <p>If an asterisk "<code>*</code>" argument is specified,
802 <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code> will deny access to all FTP or HTTP
805 <p>Otherwise, for any request for an HTTP or FTP resource via the
806 proxy, <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code> will check the hostname of the
807 request URI against each specified string. If a partial string
808 match is found, access is denied. If no matches against hostnames
809 are found, and a remote (forward) proxy is configured using
810 <code class="directive">ProxyRemote</code> or
811 <code class="directive">ProxyRemoteMatch</code>, access is allowed. If no
812 remote (forward) proxy is configured, the IP address of the
813 hostname from the URI is compared against all resolved IP
814 addresses determined at startup. Access is denied if any match is
817 <p>Note that the DNS lookups may slow down the startup time of the
820 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">ProxyBlock news.example.com auctions.example.com friends.example.com</pre>
823 <p>Note that <code>example</code> would also be sufficient to match any
826 <p>Hosts would also be matched if referenced by IP address.</p>
828 <p>Note also that</p>
830 <pre class="prettyprint lang-config">ProxyBlock *</pre>
833 <p>blocks connections to all sites.</p>
836 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
837 <div class="directive-section"><h2><a name="ProxyDomain" id="ProxyDomain">ProxyDomain</a> <a name="proxydomain" id="proxydomain">Directive</a></h2>
838 <table class="directive">
839 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Default domain name for proxied requests</td></tr>
840 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyDomain <var>Domain</var></code></td></tr>
841 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
842 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
843 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
845 <p>This directive is only useful for Apache httpd proxy servers within
846 intranets. The <code class="directive">ProxyDomain</code> directive specifies
847 the default domain which the apache proxy server will belong to. If a
848 request to a host without a domain name is encountered, a redirection
849 response to the same host with the configured <var>Domain</var> appended
850 will be generated.</p>
852 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config"> ProxyRemote * http://firewall.example.com:81<br />
853 NoProxy .example.com 192.168.112.0/21<br />
854 ProxyDomain .example.com</pre>
858 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
859 <div class="directive-section"><h2><a name="ProxyErrorOverride" id="ProxyErrorOverride">ProxyErrorOverride</a> <a name="proxyerroroverride" id="proxyerroroverride">Directive</a></h2>
860 <table class="directive">
861 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Override error pages for proxied content</td></tr>
862 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyErrorOverride On|Off</code></td></tr>
863 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ProxyErrorOverride Off</code></td></tr>
864 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
865 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
866 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
868 <p>This directive is useful for reverse-proxy setups, where you want to
869 have a common look and feel on the error pages seen by the end user.
870 This also allows for included files (via
871 <code class="module"><a href="../mod/mod_include.html">mod_include</a></code>'s SSI) to get
872 the error code and act accordingly (default behavior would display
873 the error page of the proxied server, turning this on shows the SSI
876 <p>This directive does not affect the processing of informational (1xx),
877 normal success (2xx), or redirect (3xx) responses.</p>
880 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
881 <div class="directive-section"><h2><a name="ProxyIOBufferSize" id="ProxyIOBufferSize">ProxyIOBufferSize</a> <a name="proxyiobuffersize" id="proxyiobuffersize">Directive</a></h2>
882 <table class="directive">
883 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Determine size of internal data throughput buffer</td></tr>
884 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyIOBufferSize <var>bytes</var></code></td></tr>
885 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ProxyIOBufferSize 8192</code></td></tr>
886 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
887 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
888 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
890 <p>The <code class="directive">ProxyIOBufferSize</code> directive adjusts the size
891 of the internal buffer, which is used as a scratchpad for the data between
892 input and output. The size must be at least <code>512</code>.</p>
894 <p>In almost every case there's no reason to change that value.</p>
896 <p>If used with AJP this directive sets the maximum AJP packet size in
897 bytes. Values larger than 65536 are set to 65536. If you change it from
898 the default, you must also change the <code>packetSize</code> attribute of
899 your AJP connector on the Tomcat side! The attribute
900 <code>packetSize</code> is only available in Tomcat <code>5.5.20+</code>
901 and <code>6.0.2+</code></p>
903 <p>Normally it is not necessary to change the maximum packet size.
904 Problems with the default value have been reported when sending
905 certificates or certificate chains.</p>
909 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
910 <div class="directive-section"><h2><a name="ProxyMatch" id="ProxyMatch"><ProxyMatch></a> <a name="proxymatch" id="proxymatch">Directive</a></h2>
911 <table class="directive">
912 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Container for directives applied to regular-expression-matched
913 proxied resources</td></tr>
914 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code><ProxyMatch <var>regex</var>> ...</ProxyMatch></code></td></tr>
915 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
916 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
917 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
919 <p>The <code class="directive"><ProxyMatch></code> directive is
920 identical to the <code class="directive"><a href="#proxy"><Proxy></a></code> directive, except it matches URLs
921 using <a class="glossarylink" href="../glossary.html#regex" title="see glossary">regular expressions</a>.</p>
923 <p>From 2.4.8 onwards, named groups and backreferences are captured and
924 written to the environment with the corresponding name prefixed with
925 "MATCH_" and in upper case. This allows elements of URLs to be referenced
926 from within <a href="../expr.html">expressions</a> and modules like
927 <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>. In order to prevent confusion, numbered
928 (unnamed) backreferences are ignored. Use named groups instead.</p>
930 <pre class="prettyprint lang-config"><ProxyMatch ^http://(?<sitename>[^/]+)>
931 require ldap-group cn=%{env:MATCH_SITENAME},ou=combined,o=Example
932 </ProxyMatch></pre>
937 <li><code class="directive"><a href="#proxy"><Proxy></a></code></li>
940 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
941 <div class="directive-section"><h2><a name="ProxyMaxForwards" id="ProxyMaxForwards">ProxyMaxForwards</a> <a name="proxymaxforwards" id="proxymaxforwards">Directive</a></h2>
942 <table class="directive">
943 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Maximium number of proxies that a request can be forwarded
945 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyMaxForwards <var>number</var></code></td></tr>
946 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ProxyMaxForwards -1</code></td></tr>
947 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
948 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
949 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
951 <p>The <code class="directive">ProxyMaxForwards</code> directive specifies the
952 maximum number of proxies through which a request may pass, if there's no
953 <code>Max-Forwards</code> header supplied with the request. This may
954 be set to prevent infinite proxy loops, or a DoS attack.</p>
956 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">ProxyMaxForwards 15</pre>
959 <p>Note that setting <code class="directive">ProxyMaxForwards</code> is a
960 violation of the HTTP/1.1 protocol (RFC2616), which forbids a Proxy
961 setting <code>Max-Forwards</code> if the Client didn't set it.
962 Earlier Apache httpd versions would always set it. A negative
963 <code class="directive">ProxyMaxForwards</code> value, including the
964 default -1, gives you protocol-compliant behaviour, but may
965 leave you open to loops.</p>
968 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
969 <div class="directive-section"><h2><a name="ProxyPass" id="ProxyPass">ProxyPass</a> <a name="proxypass" id="proxypass">Directive</a></h2>
970 <table class="directive">
971 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Maps remote servers into the local server URL-space</td></tr>
972 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyPass [<var>path</var>] !|<var>url</var> [<var>key=value</var>
973 <var>[key=value</var> ...]] [nocanon] [interpolate] [noquery]</code></td></tr>
974 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
975 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
976 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
978 <p>This directive allows remote servers to be mapped into the
979 space of the local server; the local server does not act as a
980 proxy in the conventional sense, but appears to be a mirror of the
981 remote server. The local server is often called a <dfn>reverse
982 proxy</dfn> or <dfn>gateway</dfn>. The <var>path</var> is the name of
983 a local virtual path; <var>url</var> is a partial URL for the
984 remote server and cannot include a query string.</p>
986 <div class="note"><strong>Note: </strong>This directive cannot be used within a
987 <code><Directory></code> context.</div>
989 <div class="warning">The <code class="directive"><a href="#proxyrequests">ProxyRequests</a></code> directive should
990 usually be set <strong>off</strong> when using
991 <code class="directive">ProxyPass</code>.</div>
993 <p>Support for using a Unix Domain Socket is available by using a url target
994 which prepends <code>unix:/path/lis.sock|</code>. For example, to proxy
995 HTTP and target the UDS at /home/www/socket you would use
996 <code>unix:/home/www.socket|http://localhost/whatever/</code>. Since
997 the socket is local, the hostname used (in this case <code>localhost</code>)
998 is moot, but it is passed as the Host: header value of the request.</p>
1000 <div class="note"><strong>Note:</strong> The path associated with the <code>unix:</code>
1001 URL is <code class="directive">DefaultRuntimeDir</code> aware.</div>
1003 <div class="note"><strong>Note:</strong> <code class="directive">RewriteRule</code> requires
1004 the <code>[P,NE]</code> option to prevent the <code>'|'</code> character
1005 from being escaped.</div>
1007 <p>Suppose the local server has address <code>http://example.com/</code>;
1010 <pre class="prettyprint lang-config"><Location /mirror/foo/>
1011 ProxyPass http://backend.example.com/
1012 </Location></pre>
1015 <p>will cause a local request for
1016 <code>http://example.com/mirror/foo/bar</code> to be internally converted
1017 into a proxy request to <code>http://backend.example.com/bar</code>.</p>
1019 <p>The following alternative syntax is possible, however it can carry a
1020 performance penalty when present in very large numbers. The advantage of
1021 the below syntax is that it allows for dynamic control via the
1022 <a href="mod_proxy_balancer.html#balancer_manager">Balancer Manager</a> interface:</p>
1024 <pre class="prettyprint lang-config">ProxyPass /mirror/foo/ http://backend.example.com/</pre>
1027 <div class="warning">
1028 <p>If the first argument ends with a trailing <strong>/</strong>, the second
1029 argument should also end with a trailing <strong>/</strong> and vice
1030 versa. Otherwise the resulting requests to the backend may miss some
1031 needed slashes and do not deliver the expected results.
1035 <p>The <code>!</code> directive is useful in situations where you don't want
1036 to reverse-proxy a subdirectory, <em>e.g.</em></p>
1038 <pre class="prettyprint lang-config"><Location /mirror/foo/>
1039 ProxyPass http://backend.example.com/
1041 <Location /mirror/foo/i>
1043 </Location></pre>
1046 <pre class="prettyprint lang-config">ProxyPass /mirror/foo/i !
1047 ProxyPass /mirror/foo http://backend.example.com</pre>
1050 <p>will proxy all requests to <code>/mirror/foo</code> to
1051 <code>backend.example.com</code> <em>except</em> requests made to
1052 <code>/mirror/foo/i</code>.</p>
1054 <div class="warning"><h3>Ordering ProxyPass Directives</h3>
1055 <p>The configured <code class="directive"><a href="#proxypass">ProxyPass</a></code>
1056 and <code class="directive"><a href="#proxypassmatch">ProxyPassMatch</a></code>
1057 rules are checked in the order of configuration. The first rule that
1058 matches wins. So usually you should sort conflicting
1059 <code class="directive"><a href="#proxypass">ProxyPass</a></code> rules starting with the
1060 longest URLs first. Otherwise later rules for longer URLS will be hidden
1061 by any earlier rule which uses a leading substring of the URL. Note that
1062 there is some relation with worker sharing. In contrast, only one
1063 <code class="directive"><a href="#proxypass">ProxyPass</a></code> directive can be placed
1064 in a <code class="directive"><a href="../mod/core.html#location">Location</a></code> block, and the most
1065 specific location will take precedence.</p>
1067 <p>For the same reasons exclusions must come <em>before</em> the
1068 general <code class="directive">ProxyPass</code> directives.</p>
1072 <p>In Apache HTTP Server 2.1 and later, mod_proxy supports pooled
1073 connections to a backend server. Connections created on demand
1074 can be retained in a pool for future use. Limits on the pool size
1075 and other settings can be coded on
1076 the <code class="directive">ProxyPass</code> directive
1077 using <code>key=value</code> parameters, described in the table
1080 <p>By default, mod_proxy will allow and retain the maximum number of
1081 connections that could be used simultaneously by that web server child
1082 process. Use the <code>max</code> parameter to reduce the number from
1083 the default. Use the <code>ttl</code> parameter to set an optional
1084 time to live; connections which have been unused for at least
1085 <code>ttl</code> seconds will be closed. <code>ttl</code> can be used
1086 to avoid using a connection which is subject to closing because of the
1087 backend server's keep-alive timeout.</p>
1089 <p>The pool of connections is maintained per web server child
1090 process, and <code>max</code> and other settings are not coordinated
1091 among all child processes, except when only one child process is allowed
1092 by configuration or MPM design.</p>
1094 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">ProxyPass /example http://backend.example.com max=20 ttl=120 retry=300</pre>
1097 <table class="bordered"><tr><th>BalancerMember parameters</th></tr></table>
1099 <tr><th>Parameter</th>
1101 <th>Description</th></tr>
1104 <td>Minimum number of connection pool entries, unrelated to the
1105 actual number of connections. This only needs to be modified from the
1106 default for special circumstances where heap memory associated with the
1107 backend connections should be preallocated or retained.</td></tr>
1110 <td>Maximum number of connections that will be allowed to the
1111 backend server. The default for this limit is the number of threads
1112 per process in the active MPM. In the Prefork MPM, this is always 1,
1113 while with other MPMs it is controlled by the
1114 <code class="directive">ThreadsPerChild</code> directive.</td></tr>
1117 <td>Retained connection pool entries above this limit are freed
1118 during certain operations if they have been unused for longer than
1119 the time to live, controlled by the <code>ttl</code> parameter. If
1120 the connection pool entry has an associated connection, it will be
1121 closed. This only needs to be modified from the default for special
1122 circumstances where connection pool entries and any associated
1123 connections which have exceeded the time to live need to be freed or
1124 closed more aggressively.</td></tr>
1125 <tr><td>acquire</td>
1127 <td>If set this will be the maximum time to wait for a free
1128 connection in the connection pool, in milliseconds. If there are no free
1129 connections in the pool the Apache httpd will return <code>SERVER_BUSY</code>
1130 status to the client.
1132 <tr><td>connectiontimeout</td>
1134 <td>Connect timeout in seconds.
1135 The number of seconds Apache httpd waits for the creation of a connection to
1136 the backend to complete. By adding a postfix of ms the timeout can be
1137 also set in milliseconds.
1139 <tr><td>disablereuse</td>
1141 <td>This parameter should be used when you want to force mod_proxy
1142 to immediately close a connection to the backend after being used, and
1143 thus, disable its persistent connection and pool for that backend.
1144 This helps in various situations where a firewall between Apache
1146 the backend server (regardless of protocol) tends to silently
1147 drop connections or when backends themselves may be under round-
1148 robin DNS. To disable connection pooling reuse,
1149 set this property value to <code>On</code>.
1151 <tr><td>flushpackets</td>
1153 <td>Determines whether the proxy module will auto-flush the output
1154 brigade after each "chunk" of data. 'off' means that it will flush
1155 only when needed, 'on' means after each chunk is sent and
1156 'auto' means poll/wait for a period of time and flush if
1157 no input has been received for 'flushwait' milliseconds.
1158 Currently this is in effect only for AJP.
1160 <tr><td>flushwait</td>
1162 <td>The time to wait for additional input, in milliseconds, before
1163 flushing the output brigade if 'flushpackets' is 'auto'.
1165 <tr><td>iobuffersize</td>
1167 <td>Adjusts the size of the internal scratchpad IO buffer. This allows you
1168 to override the <code class="directive">ProxyIOBufferSize</code> for a specific worker.
1169 This must be at least 512 or set to 0 for the system default of 8192.
1171 <tr><td>keepalive</td>
1173 <td><p>This parameter should be used when you have a firewall between your
1174 Apache httpd and the backend server, who tend to drop inactive connections.
1175 This flag will tell the Operating System to send <code>KEEP_ALIVE</code>
1176 messages on inactive connections and thus prevent the firewall to drop the connection.
1177 To enable keepalive set this property value to <code>On</code>. </p>
1178 <p>The frequency of initial and subsequent TCP keepalive probes
1179 depends on global OS settings, and may be as high as 2 hours. To be useful,
1180 the frequency configured in the OS must be smaller than the threshold used
1181 by the firewall.</p>
1185 <td>Sets the load balancer cluster set that the worker is a member
1186 of. The load balancer will try all members of a lower numbered
1187 lbset before trying higher numbered ones.
1191 <td>Ping property tells the webserver to "test" the connection to
1192 the backend before forwarding the request. For negative values
1193 the test is a simple socket check, for positive values it's
1194 a more functional check, dependent upon the protocol. For AJP, it causes
1195 <code class="module"><a href="../mod/mod_proxy_ajp.html">mod_proxy_ajp</a></code>to send a <code>CPING</code>
1196 request on the ajp13 connection (implemented on Tomcat 3.3.2+, 4.1.28+
1197 and 5.0.13+). For HTTP, it causes <code class="module"><a href="../mod/mod_proxy_http.html">mod_proxy_http</a></code>
1198 to send a <code>100-Continue</code> to the backend (only valid for
1199 HTTP/1.1 - for non HTTP/1.1 backends, this property has no
1200 effect). In both cases the parameter is the delay in seconds to wait
1202 This feature has been added to avoid problems with hung and
1204 This will increase the network traffic during the normal operation
1205 which could be an issue, but it will lower the
1206 traffic in case some of the cluster nodes are down or busy.
1207 By adding a postfix of ms the delay can be also set in
1210 <tr><td>receivebuffersize</td>
1212 <td>Adjusts the size of the explicit (TCP/IP) network buffer size for
1213 proxied connections. This allows you to override the
1214 <code class="directive">ProxyReceiveBufferSize</code> for a specific worker.
1215 This must be at least 512 or set to 0 for the system default.
1217 <tr><td>redirect</td>
1219 <td>Redirection Route of the worker. This value is usually
1220 set dynamically to enable safe removal of the node from
1221 the cluster. If set all requests without session id will be
1222 redirected to the BalancerMember that has route parameter
1223 equal as this value.
1227 <td>Connection pool worker retry timeout in seconds.
1228 If the connection pool worker to the backend server is in the error state,
1229 Apache httpd will not forward any requests to that server until the timeout
1230 expires. This enables to shut down the backend server for maintenance,
1231 and bring it back online later. A value of 0 means always retry workers
1232 in an error state with no timeout.
1236 <td>Route of the worker when used inside load balancer.
1237 The route is a value appended to session id.
1241 <td>Single letter value defining the initial status of
1244 <tr><td>D: Worker is disabled and will not accept any requests.</td></tr>
1245 <tr><td>S: Worker is administratively stopped.</td></tr>
1246 <tr><td>I: Worker is in ignore-errors mode, and will always be considered available.</td></tr>
1247 <tr><td>H: Worker is in hot-standby mode and will only be used if no other
1248 viable workers are available.</td></tr>
1249 <tr><td>E: Worker is in an error state.</td></tr>
1250 <tr><td>N: Worker is in drain mode, and will only accept existing sticky sessions
1251 destined for itself and ignore all other requests.</td></tr>
1253 can be set (which is the default) by prepending with '+' or
1254 cleared by prepending with '-'.
1255 Thus, a setting of 'S-E' sets this worker to Stopped and
1256 clears the in-error flag.
1258 <tr><td>timeout</td>
1259 <td><code class="directive"><a href="#proxytimeout">ProxyTimeout</a></code></td>
1260 <td>Connection timeout in seconds.
1261 The number of seconds Apache httpd waits for data sent by / to the backend.
1265 <td>Time to live for inactive connections and associated connection
1266 pool entries, in seconds. Once reaching this limit, a
1267 connection will not be used again; it will be closed at some
1273 <p>If the Proxy directive scheme starts with the
1274 <code>balancer://</code> (eg: <code>balancer://cluster</code>,
1275 any path information is ignored) then a virtual worker that does not really
1276 communicate with the backend server will be created. Instead it is responsible
1277 for the management of several "real" workers. In that case the special set of
1278 parameters can be add to this virtual worker. See <code class="module"><a href="../mod/mod_proxy_balancer.html">mod_proxy_balancer</a></code>
1279 for more information about how the balancer works.
1281 <table class="bordered"><tr><th>Balancer parameters</th></tr></table>
1283 <tr><th>Parameter</th>
1285 <th>Description</th></tr>
1286 <tr><td>lbmethod</td>
1288 <td>Balancer load-balance method. Select the load-balancing scheduler
1289 method to use. Either <code>byrequests</code>, to perform weighted
1290 request counting, <code>bytraffic</code>, to perform weighted
1291 traffic byte count balancing, or <code>bybusyness</code>, to perform
1292 pending request balancing. Default is <code>byrequests</code>.
1294 <tr><td>maxattempts</td>
1295 <td>One less than the number of workers, or 1 with a single worker.</td>
1296 <td>Maximum number of failover attempts before giving up.
1298 <tr><td>nofailover</td>
1300 <td>If set to <code>On</code> the session will break if the worker is in
1301 error state or disabled. Set this value to On if backend servers do not
1302 support session replication.
1304 <tr><td>stickysession</td>
1306 <td>Balancer sticky session name. The value is usually set to something
1307 like <code>JSESSIONID</code> or <code>PHPSESSIONID</code>,
1308 and it depends on the backend application server that support sessions.
1309 If the backend application server uses different name for cookies
1310 and url encoded id (like servlet containers) use | to to separate them.
1311 The first part is for the cookie the second for the path.<br />
1312 Available in Apache HTTP Server 2.4.4 and later.
1314 <tr><td>stickysessionsep</td>
1316 <td>Sets the separation symbol in the session cookie. Some backend application servers
1317 do not use the '.' as the symbol. For example the Oracle Weblogic server uses
1318 '!'. The correct symbol can be set using this option. The setting of 'Off'
1319 signifies that no symbol is used.
1321 <tr><td>scolonpathdelim</td>
1323 <td>If set to <code>On</code> the semi-colon character ';' will be
1324 used as an additional sticky session path delimiter/separator. This
1325 is mainly used to emulate mod_jk's behavior when dealing with paths such
1326 as <code>JSESSIONID=6736bcf34;foo=aabfa</code>
1328 <tr><td>timeout</td>
1330 <td>Balancer timeout in seconds. If set this will be the maximum time
1331 to wait for a free worker. Default is not to wait.
1333 <tr><td>failonstatus</td>
1335 <td>A single or comma-separated list of HTTP status codes. If set this will
1336 force the worker into error state when the backend returns any status code
1337 in the list. Worker recovery behaves the same as other worker errors.
1339 <tr><td>failontimeout</td>
1341 <td>If set, an IO read timeout after a request is sent to the backend will
1342 force the worker into error state. Worker recovery behaves the same as other
1343 worker errors.<br />
1344 Available in Apache HTTP Server 2.4.5 and later.
1347 <td><auto></td>
1348 <td>The protective nonce used in the <code>balancer-manager</code> application page.
1349 The default is to use an automatically determined UUID-based
1350 nonce, to provide for further protection for the page. If set,
1351 then the nonce is set to that value. A setting of <code>None</code>
1352 disables all nonce checking.
1353 <div class="note"><h3>Note</h3>
1354 <p>In addition to the nonce, the <code>balancer-manager</code> page
1355 should be protected via an ACL.</p>
1360 <td>Number of additional BalancerMembers to allow to be added
1361 to this balancer in addition to those defined at configuration.
1363 <tr><td>forcerecovery</td>
1365 <td>Force the immediate recovery of all workers without considering the
1366 retry parameter of the workers if all workers of a balancer are
1367 in error state. There might be cases where an already overloaded backend
1368 can get into deeper trouble if the recovery of all workers is enforced
1369 without considering the retry parameter of each worker. In this case
1370 set to <code>Off</code>.<br />
1371 Available in Apache HTTP Server 2.4.2 and later.
1375 <p>A sample balancer setup</p>
1376 <pre class="prettyprint lang-config">ProxyPass /special-area http://special.example.com smax=5 max=10
1377 ProxyPass / balancer://mycluster/ stickysession=JSESSIONID|jsessionid nofailover=On
1378 <Proxy balancer://mycluster>
1379 BalancerMember ajp://1.2.3.4:8009
1380 BalancerMember ajp://1.2.3.5:8009 loadfactor=20
1381 # Less powerful server, don't send as many requests there,
1382 BalancerMember ajp://1.2.3.6:8009 loadfactor=5
1383 </Proxy></pre>
1386 <p>Setting up a hot-standby, that will only be used if no other
1387 members are available</p>
1388 <pre class="prettyprint lang-config">ProxyPass / balancer://hotcluster/
1389 <Proxy balancer://hotcluster>
1390 BalancerMember ajp://1.2.3.4:8009 loadfactor=1
1391 BalancerMember ajp://1.2.3.5:8009 loadfactor=2
1392 # The server below is on hot standby
1393 BalancerMember ajp://1.2.3.6:8009 status=+H
1394 ProxySet lbmethod=bytraffic
1395 </Proxy></pre>
1398 <p>Normally, mod_proxy will canonicalise ProxyPassed URLs.
1399 But this may be incompatible with some backends, particularly those
1400 that make use of <var>PATH_INFO</var>. The optional <var>nocanon</var>
1401 keyword suppresses this, and passes the URL path "raw" to the
1402 backend. Note that may affect the security of your backend, as it
1403 removes the normal limited protection against URL-based attacks
1404 provided by the proxy.</p>
1406 <p>Normally, mod_proxy will include the query string when
1407 generating the <var>SCRIPT_FILENAME</var> environment variable.
1408 The optional <var>noquery</var> keyword (available in
1409 httpd 2.4.1 and later) prevents this.</p>
1411 <p>When used inside a <code class="directive"><a href="../mod/core.html#location"><Location></a></code> section, the first argument is omitted and the local
1412 directory is obtained from the <code class="directive"><a href="../mod/core.html#location"><Location></a></code>. The same will occur inside a
1413 <code class="directive"><a href="../mod/core.html#locationmatch"><LocationMatch></a></code> section,
1414 however ProxyPass does not interpret the regexp as such, so it is necessary
1415 to use <code class="directive">ProxyPassMatch</code> in this situation instead.</p>
1417 <p>This directive is not supported in <code class="directive"><a href="../mod/core.html#directory"><Directory></a></code> or <code class="directive"><a href="../mod/core.html#files"><Files></a></code> sections.</p>
1419 <p>If you require a more flexible reverse-proxy configuration, see the
1420 <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> directive with the
1421 <code>[P]</code> flag.</p>
1423 <p>The optional <var>interpolate</var> keyword, in combination with
1424 <code class="directive">ProxyPassInterpolateEnv</code> causes the ProxyPass
1425 to interpolate environment variables, using the syntax
1426 <var>${VARNAME}</var>. Note that many of the standard CGI-derived
1427 environment variables will not exist when this interpolation happens,
1428 so you may still have to resort to <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>
1429 for complex rules. Also note that interpolation is not supported
1430 within the scheme portion of a URL. Dynamic determination of the
1431 scheme can be accomplished with <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code> as in the
1432 following example.</p>
1434 <pre class="prettyprint lang-config">RewriteEngine On
1436 RewriteCond %{HTTPS} =off
1437 RewriteRule . - [E=protocol:http]
1438 RewriteCond %{HTTPS} =on
1439 RewriteRule . - [E=protocol:https]
1441 RewriteRule ^/mirror/foo/(.*) %{ENV:protocol}://backend.example.com/$1 [P]
1442 ProxyPassReverse /mirror/foo/ http://backend.example.com/
1443 ProxyPassReverse /mirror/foo/ https://backend.example.com/</pre>
1447 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1448 <div class="directive-section"><h2><a name="ProxyPassInherit" id="ProxyPassInherit">ProxyPassInherit</a> <a name="proxypassinherit" id="proxypassinherit">Directive</a></h2>
1449 <table class="directive">
1450 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Inherit ProxyPass directives defined from the main server</td></tr>
1451 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyPassInherit On|Off</code></td></tr>
1452 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ProxyPassInherit On</code></td></tr>
1453 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1454 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1455 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
1456 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>ProxyPassInherit is only available in Apache HTTP Server 2.4.5 and later.
1457 and later.</td></tr>
1459 <p>This directive will cause the current server/vhost to "inherit"
1460 <code class="directive"><a href="#proxypass">ProxyPass</a></code>
1461 directives defined in the main server. This can cause issues and
1462 inconsistent behavior if using the Balancer Manager for dynamic changes
1463 and so should be disabled if using that feature.</p>
1464 <p>The setting in the global server defines the default for all vhosts.</p>
1465 <p>Disabling ProxyPassInherit also disables <code class="directive"><a href="#balancerinherit">BalancerInherit</a></code>.</p>
1468 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1469 <div class="directive-section"><h2><a name="ProxyPassInterpolateEnv" id="ProxyPassInterpolateEnv">ProxyPassInterpolateEnv</a> <a name="proxypassinterpolateenv" id="proxypassinterpolateenv">Directive</a></h2>
1470 <table class="directive">
1471 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enable Environment Variable interpolation in Reverse Proxy configurations</td></tr>
1472 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyPassInterpolateEnv On|Off</code></td></tr>
1473 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ProxyPassInterpolateEnv Off</code></td></tr>
1474 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
1475 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1476 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
1478 <p>This directive, together with the <var>interpolate</var> argument to
1479 <code class="directive">ProxyPass</code>, <code class="directive">ProxyPassReverse</code>,
1480 <code class="directive">ProxyPassReverseCookieDomain</code> and
1481 <code class="directive">ProxyPassReverseCookiePath</code>
1482 enables reverse proxies to be dynamically
1483 configured using environment variables, which may be set by
1484 another module such as <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>.
1485 It affects the <code class="directive">ProxyPass</code>,
1486 <code class="directive">ProxyPassReverse</code>,
1487 <code class="directive">ProxyPassReverseCookieDomain</code>, and
1488 <code class="directive">ProxyPassReverseCookiePath</code> directives,
1489 and causes them to substitute the value of an environment
1490 variable <code>varname</code> for the string <code>${varname}</code>
1491 in configuration directives (if the <var>interpolate</var> option is set).</p>
1492 <p>Keep this turned off (for server performance) unless you need it!</p>
1495 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1496 <div class="directive-section"><h2><a name="ProxyPassMatch" id="ProxyPassMatch">ProxyPassMatch</a> <a name="proxypassmatch" id="proxypassmatch">Directive</a></h2>
1497 <table class="directive">
1498 <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>
1499 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyPassMatch [<var>regex</var>] !|<var>url</var> [<var>key=value</var>
1500 <var>[key=value</var> ...]]</code></td></tr>
1501 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
1502 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1503 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
1505 <p>This directive is equivalent to <code class="directive"><a href="#proxypass">ProxyPass</a></code>,
1506 but makes use of regular expressions, instead of simple prefix matching. The
1507 supplied regular expression is matched against the <var>url</var>, and if it
1508 matches, the server will substitute any parenthesized matches into the given
1509 string and use it as a new <var>url</var>.</p>
1511 <div class="note"><strong>Note: </strong>This directive cannot be used within a
1512 <code><Directory></code> context.</div>
1514 <p>Suppose the local server has address <code>http://example.com/</code>;
1517 <pre class="prettyprint lang-config">ProxyPassMatch ^(/.*\.gif)$ http://backend.example.com$1</pre>
1520 <p>will cause a local request for
1521 <code>http://example.com/foo/bar.gif</code> to be internally converted
1522 into a proxy request to <code>http://backend.example.com/foo/bar.gif</code>.</p>
1523 <div class="note"><h3>Note</h3>
1524 <p>The URL argument must be parsable as a URL <em>before</em> regexp
1525 substitutions (as well as after). This limits the matches you can use.
1526 For instance, if we had used</p>
1527 <pre class="prettyprint lang-config">ProxyPassMatch ^(/.*\.gif)$ http://backend.example.com:8000$1</pre>
1529 <p>in our previous example, it would fail with a syntax error
1530 at server startup. This is a bug (PR 46665 in the ASF bugzilla),
1531 and the workaround is to reformulate the match:</p>
1532 <pre class="prettyprint lang-config">ProxyPassMatch ^/(.*\.gif)$ http://backend.example.com:8000/$1</pre>
1535 <p>The <code>!</code> directive is useful in situations where you don't want
1536 to reverse-proxy a subdirectory.</p>
1538 <p>When used inside a <code class="directive"><a href="../mod/core.html#locationmatch"><LocationMatch></a></code> section, the first argument is omitted and the
1539 regexp is obtained from the <code class="directive"><a href="../mod/core.html#locationmatch"><LocationMatch></a></code>.</p>
1541 <p>If you require a more flexible reverse-proxy configuration, see the
1542 <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> directive with the
1543 <code>[P]</code> flag.</p>
1545 <div class="warning">
1546 <h3>Security Warning</h3>
1547 <p>Take care when constructing the target URL of the rule, considering
1548 the security impact from allowing the client influence over the set of
1549 URLs to which your server will act as a proxy. Ensure that the scheme
1550 and hostname part of the URL is either fixed, or does not allow the
1551 client undue influence.</p>
1555 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1556 <div class="directive-section"><h2><a name="ProxyPassReverse" id="ProxyPassReverse">ProxyPassReverse</a> <a name="proxypassreverse" id="proxypassreverse">Directive</a></h2>
1557 <table class="directive">
1558 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Adjusts the URL in HTTP response headers sent from a reverse
1559 proxied server</td></tr>
1560 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyPassReverse [<var>path</var>] <var>url</var>
1561 [<var>interpolate</var>]</code></td></tr>
1562 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
1563 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1564 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
1566 <p>This directive lets Apache httpd adjust the URL in the <code>Location</code>,
1567 <code>Content-Location</code> and <code>URI</code> headers on HTTP
1568 redirect responses. This is essential when Apache httpd is used as a
1569 reverse proxy (or gateway) to avoid by-passing the reverse proxy
1570 because of HTTP redirects on the backend servers which stay behind
1571 the reverse proxy.</p>
1573 <p>Only the HTTP response headers specifically mentioned above
1574 will be rewritten. Apache httpd will not rewrite other response
1575 headers, nor will it by default rewrite URL references inside HTML pages.
1576 This means that if the proxied content contains absolute URL
1577 references, they will by-pass the proxy. To rewrite HTML content to
1578 match the proxy, you must load and enable <code class="module"><a href="../mod/mod_proxy_html.html">mod_proxy_html</a></code>.
1581 <p><var>path</var> is the name of a local virtual path. <var>url</var> is a
1582 partial URL for the remote server - the same way they are used for the
1583 <code class="directive"><a href="#proxypass">ProxyPass</a></code> directive.</p>
1585 <p>For example, suppose the local server has address
1586 <code>http://example.com/</code>; then</p>
1588 <pre class="prettyprint lang-config">ProxyPass /mirror/foo/ http://backend.example.com/
1589 ProxyPassReverse /mirror/foo/ http://backend.example.com/
1590 ProxyPassReverseCookieDomain backend.example.com public.example.com
1591 ProxyPassReverseCookiePath / /mirror/foo/</pre>
1594 <p>will not only cause a local request for the
1595 <code>http://example.com/mirror/foo/bar</code> to be internally converted
1596 into a proxy request to <code>http://backend.example.com/bar</code>
1597 (the functionality <code>ProxyPass</code> provides here). It also takes care
1598 of redirects the server <code>backend.example.com</code> sends: when
1599 <code>http://backend.example.com/bar</code> is redirected by him to
1600 <code>http://backend.example.com/quux</code> Apache httpd adjusts this to
1601 <code>http://example.com/mirror/foo/quux</code> before forwarding the HTTP
1602 redirect response to the client. Note that the hostname used for
1603 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>
1605 <p>Note that this <code class="directive">ProxyPassReverse</code> directive can
1606 also be used in conjunction with the proxy pass-through feature
1607 (<code>RewriteRule ... [P]</code>) from <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>
1608 because it doesn't depend on a corresponding <code class="directive"><a href="#proxypass">ProxyPass</a></code> directive.</p>
1610 <p>The optional <var>interpolate</var> keyword, used together with
1611 <code class="directive">ProxyPassInterpolateEnv</code>, enables interpolation
1612 of environment variables specified using the format <var>${VARNAME}</var>.
1613 Note that interpolation is not supported within the scheme portion of a
1616 <p>When used inside a <code class="directive"><a href="../mod/core.html#location"><Location></a></code> section, the first argument is omitted and the local
1617 directory is obtained from the <code class="directive"><a href="../mod/core.html#location"><Location></a></code>. The same occurs inside a <code class="directive"><a href="../mod/core.html#locationmatch"><LocationMatch></a></code> section, but will probably not work as
1618 intended, as ProxyPassReverse will interpret the regexp literally as a
1619 path; if needed in this situation, specify the ProxyPassReverse outside
1620 the section, or in a separate <code class="directive"><a href="../mod/core.html#location"><Location></a></code> section.</p>
1622 <p>This directive is not supported in <code class="directive"><a href="../mod/core.html#directory"><Directory></a></code> or <code class="directive"><a href="../mod/core.html#files"><Files></a></code> sections.</p>
1625 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1626 <div class="directive-section"><h2><a name="ProxyPassReverseCookieDomain" id="ProxyPassReverseCookieDomain">ProxyPassReverseCookieDomain</a> <a name="proxypassreversecookiedomain" id="proxypassreversecookiedomain">Directive</a></h2>
1627 <table class="directive">
1628 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Adjusts the Domain string in Set-Cookie headers from a reverse-
1629 proxied server</td></tr>
1630 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyPassReverseCookieDomain <var>internal-domain</var>
1631 <var>public-domain</var> [<var>interpolate</var>]</code></td></tr>
1632 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
1633 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1634 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
1636 <p>Usage is basically similar to
1637 <code class="directive"><a href="#proxypassreverse">ProxyPassReverse</a></code>, but instead of
1638 rewriting headers that are a URL, this rewrites the <code>domain</code>
1639 string in <code>Set-Cookie</code> headers.</p>
1642 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1643 <div class="directive-section"><h2><a name="ProxyPassReverseCookiePath" id="ProxyPassReverseCookiePath">ProxyPassReverseCookiePath</a> <a name="proxypassreversecookiepath" id="proxypassreversecookiepath">Directive</a></h2>
1644 <table class="directive">
1645 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Adjusts the Path string in Set-Cookie headers from a reverse-
1646 proxied server</td></tr>
1647 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyPassReverseCookiePath <var>internal-path</var>
1648 <var>public-path</var> [<var>interpolate</var>]</code></td></tr>
1649 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
1650 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1651 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
1654 Useful in conjunction with
1655 <code class="directive"><a href="#proxypassreverse">ProxyPassReverse</a></code>
1656 in situations where backend URL paths are mapped to public paths on the
1657 reverse proxy. This directive rewrites the <code>path</code> string in
1658 <code>Set-Cookie</code> headers. If the beginning of the cookie path matches
1659 <var>internal-path</var>, the cookie path will be replaced with
1660 <var>public-path</var>.
1662 In the example given with
1663 <code class="directive"><a href="#proxypassreverse">ProxyPassReverse</a></code>, the directive:
1665 <pre class="prettyprint lang-config">ProxyPassReverseCookiePath / /mirror/foo/</pre>
1668 will rewrite a cookie with backend path <code>/</code> (or
1669 <code>/example</code> or, in fact, anything) to <code>/mirror/foo/</code>.
1673 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1674 <div class="directive-section"><h2><a name="ProxyPreserveHost" id="ProxyPreserveHost">ProxyPreserveHost</a> <a name="proxypreservehost" id="proxypreservehost">Directive</a></h2>
1675 <table class="directive">
1676 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Use incoming Host HTTP request header for proxy
1678 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyPreserveHost On|Off</code></td></tr>
1679 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ProxyPreserveHost Off</code></td></tr>
1680 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
1681 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1682 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
1683 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Usable in directory
1684 context in 2.3.3 and later.</td></tr>
1686 <p>When enabled, this option will pass the Host: line from the incoming
1687 request to the proxied host, instead of the hostname specified in the
1688 <code class="directive">ProxyPass</code> line.</p>
1690 <p>This option should normally be turned <code>Off</code>. It is mostly
1691 useful in special configurations like proxied mass name-based virtual
1692 hosting, where the original Host header needs to be evaluated by the
1696 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1697 <div class="directive-section"><h2><a name="ProxyReceiveBufferSize" id="ProxyReceiveBufferSize">ProxyReceiveBufferSize</a> <a name="proxyreceivebuffersize" id="proxyreceivebuffersize">Directive</a></h2>
1698 <table class="directive">
1699 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Network buffer size for proxied HTTP and FTP
1700 connections</td></tr>
1701 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyReceiveBufferSize <var>bytes</var></code></td></tr>
1702 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ProxyReceiveBufferSize 0</code></td></tr>
1703 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1704 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1705 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
1707 <p>The <code class="directive">ProxyReceiveBufferSize</code> directive specifies an
1708 explicit (TCP/IP) network buffer size for proxied HTTP and FTP connections,
1709 for increased throughput. It has to be greater than <code>512</code> or set
1710 to <code>0</code> to indicate that the system's default buffer size should
1713 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">ProxyReceiveBufferSize 2048</pre>
1717 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1718 <div class="directive-section"><h2><a name="ProxyRemote" id="ProxyRemote">ProxyRemote</a> <a name="proxyremote" id="proxyremote">Directive</a></h2>
1719 <table class="directive">
1720 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Remote proxy used to handle certain requests</td></tr>
1721 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyRemote <var>match</var> <var>remote-server</var></code></td></tr>
1722 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1723 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1724 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
1726 <p>This defines remote proxies to this proxy. <var>match</var> is either the
1727 name of a URL-scheme that the remote server supports, or a partial URL
1728 for which the remote server should be used, or <code>*</code> to indicate
1729 the server should be contacted for all requests. <var>remote-server</var> is
1730 a partial URL for the remote server. Syntax:</p>
1732 <div class="example"><p><code>
1733 <dfn>remote-server</dfn> =
1734 <var>scheme</var>://<var>hostname</var>[:<var>port</var>]
1737 <p><var>scheme</var> is effectively the protocol that should be used to
1738 communicate with the remote server; only <code>http</code> and <code>https</code>
1739 are supported by this module. When using <code>https</code>, the requests
1740 are forwarded through the remote proxy using the HTTP CONNECT method.</p>
1742 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">ProxyRemote http://goodguys.example.com/ http://mirrorguys.example.com:8000
1743 ProxyRemote * http://cleverproxy.localdomain
1744 ProxyRemote ftp http://ftpproxy.mydomain:8080</pre>
1747 <p>In the last example, the proxy will forward FTP requests, encapsulated
1748 as yet another HTTP proxy request, to another proxy which can handle
1751 <p>This option also supports reverse proxy configuration - a backend
1752 webserver can be embedded within a virtualhost URL space even if that
1753 server is hidden by another forward proxy.</p>
1756 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1757 <div class="directive-section"><h2><a name="ProxyRemoteMatch" id="ProxyRemoteMatch">ProxyRemoteMatch</a> <a name="proxyremotematch" id="proxyremotematch">Directive</a></h2>
1758 <table class="directive">
1759 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Remote proxy used to handle requests matched by regular
1760 expressions</td></tr>
1761 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyRemoteMatch <var>regex</var> <var>remote-server</var></code></td></tr>
1762 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1763 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1764 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
1766 <p>The <code class="directive">ProxyRemoteMatch</code> is identical to the
1767 <code class="directive"><a href="#proxyremote">ProxyRemote</a></code> directive, except the
1768 first argument is a <a class="glossarylink" href="../glossary.html#regex" title="see glossary">regular expression</a>
1769 match against the requested URL.</p>
1772 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1773 <div class="directive-section"><h2><a name="ProxyRequests" id="ProxyRequests">ProxyRequests</a> <a name="proxyrequests" id="proxyrequests">Directive</a></h2>
1774 <table class="directive">
1775 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enables forward (standard) proxy requests</td></tr>
1776 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyRequests On|Off</code></td></tr>
1777 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ProxyRequests Off</code></td></tr>
1778 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1779 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1780 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
1782 <p>This allows or prevents Apache httpd from functioning as a forward proxy
1783 server. (Setting ProxyRequests to <code>Off</code> does not disable use of
1784 the <code class="directive"><a href="#proxypass">ProxyPass</a></code> directive.)</p>
1786 <p>In a typical reverse proxy or gateway configuration, this
1787 option should be set to
1788 <code>Off</code>.</p>
1790 <p>In order to get the functionality of proxying HTTP or FTP sites, you
1791 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>
1792 (or both) present in the server.</p>
1794 <p>In order to get the functionality of (forward) proxying HTTPS sites, you
1795 need <code class="module"><a href="../mod/mod_proxy_connect.html">mod_proxy_connect</a></code> enabled in the server.</p>
1797 <div class="warning"><h3>Warning</h3>
1798 <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
1799 both to your network and to the Internet at large.</p>
1804 <li><a href="#forwardreverse">Forward and Reverse Proxies/Gateways</a></li>
1807 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1808 <div class="directive-section"><h2><a name="ProxySet" id="ProxySet">ProxySet</a> <a name="proxyset" id="proxyset">Directive</a></h2>
1809 <table class="directive">
1810 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set various Proxy balancer or member parameters</td></tr>
1811 <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>
1812 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory</td></tr>
1813 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1814 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
1816 <p>This directive is used as an alternate method of setting any of the
1817 parameters available to Proxy balancers and workers normally done via the
1818 <code class="directive"><a href="#proxypass">ProxyPass</a></code> directive. If used
1819 within a <code><Proxy <var>balancer url|worker url</var>></code>
1820 container directive, the <var>url</var> argument is not required. As a side
1821 effect the respective balancer or worker gets created. This can be useful
1822 when doing reverse proxying via a
1823 <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> instead of a
1824 <code class="directive"><a href="#proxypass">ProxyPass</a></code> directive.</p>
1826 <div class="example"><pre class="prettyprint lang-config"><Proxy balancer://hotcluster>
1827 BalancerMember http://www2.example.com:8080 loadfactor=1
1828 BalancerMember http://www3.example.com:8080 loadfactor=2
1829 ProxySet lbmethod=bytraffic
1830 </Proxy></pre>
1833 <pre class="prettyprint lang-config"><Proxy http://backend>
1834 ProxySet keepalive=On
1835 </Proxy></pre>
1838 <pre class="prettyprint lang-config">ProxySet balancer://foo lbmethod=bytraffic timeout=15</pre>
1841 <pre class="prettyprint lang-config">ProxySet ajp://backend:7001 timeout=15</pre>
1844 <div class="warning"><h3>Warning</h3>
1845 <p>Keep in mind that the same parameter key can have a different meaning
1846 depending whether it is applied to a balancer or a worker as shown by the two
1847 examples above regarding timeout.</p>
1852 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1853 <div class="directive-section"><h2><a name="ProxySourceAddress" id="ProxySourceAddress">ProxySourceAddress</a> <a name="proxysourceaddress" id="proxysourceaddress">Directive</a></h2>
1854 <table class="directive">
1855 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set local IP address for outgoing proxy connections</td></tr>
1856 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxySourceAddress <var>address</var></code></td></tr>
1857 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1858 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1859 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
1860 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.3.9 and later</td></tr>
1862 <p>This directive allows to set a specific local address to bind to when connecting
1863 to a backend server.</p>
1866 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1867 <div class="directive-section"><h2><a name="ProxyStatus" id="ProxyStatus">ProxyStatus</a> <a name="proxystatus" id="proxystatus">Directive</a></h2>
1868 <table class="directive">
1869 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Show Proxy LoadBalancer status in mod_status</td></tr>
1870 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyStatus Off|On|Full</code></td></tr>
1871 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ProxyStatus Off</code></td></tr>
1872 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1873 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1874 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
1876 <p>This directive determines whether or not proxy
1877 loadbalancer status data is displayed via the <code class="module"><a href="../mod/mod_status.html">mod_status</a></code>
1878 server-status page.</p>
1879 <div class="note"><h3>Note</h3>
1880 <p><strong>Full</strong> is synonymous with <strong>On</strong></p>
1885 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1886 <div class="directive-section"><h2><a name="ProxyTimeout" id="ProxyTimeout">ProxyTimeout</a> <a name="proxytimeout" id="proxytimeout">Directive</a></h2>
1887 <table class="directive">
1888 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Network timeout for proxied requests</td></tr>
1889 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyTimeout <var>seconds</var></code></td></tr>
1890 <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>
1891 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1892 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1893 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
1895 <p>This directive allows a user to specifiy a timeout on proxy requests.
1896 This is useful when you have a slow/buggy appserver which hangs, and you
1897 would rather just return a timeout and fail gracefully instead of waiting
1898 however long it takes the server to return.</p>
1901 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1902 <div class="directive-section"><h2><a name="ProxyVia" id="ProxyVia">ProxyVia</a> <a name="proxyvia" id="proxyvia">Directive</a></h2>
1903 <table class="directive">
1904 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Information provided in the <code>Via</code> HTTP response
1905 header for proxied requests</td></tr>
1906 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyVia On|Off|Full|Block</code></td></tr>
1907 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ProxyVia Off</code></td></tr>
1908 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1909 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1910 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy</td></tr>
1912 <p>This directive controls the use of the <code>Via:</code> HTTP
1913 header by the proxy. Its intended use is to control the flow of
1914 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
1915 14.45 for an explanation of <code>Via:</code> header lines.</p>
1918 <li>If set to <code>Off</code>, which is the default, no special processing
1919 is performed. If a request or reply contains a <code>Via:</code> header,
1920 it is passed through unchanged.</li>
1922 <li>If set to <code>On</code>, each request and reply will get a
1923 <code>Via:</code> header line added for the current host.</li>
1925 <li>If set to <code>Full</code>, each generated <code>Via:</code> header
1926 line will additionally have the Apache httpd server version shown as a
1927 <code>Via:</code> comment field.</li>
1929 <li>If set to <code>Block</code>, every proxy request will have all its
1930 <code>Via:</code> header lines removed. No new <code>Via:</code> header will
1936 <div class="bottomlang">
1937 <p><span>Available Languages: </span><a href="../en/mod/mod_proxy.html" title="English"> en </a> |
1938 <a href="../fr/mod/mod_proxy.html" hreflang="fr" rel="alternate" title="Français"> fr </a> |
1939 <a href="../ja/mod/mod_proxy.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a></p>
1940 </div><div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
1941 <script type="text/javascript"><!--//--><![CDATA[//><!--
1942 var comments_shortname = 'httpd';
1943 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_proxy.html';
1945 if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
1946 d.write('<div id="comments_thread"><\/div>');
1947 var s = d.createElement('script');
1948 s.type = 'text/javascript';
1950 s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
1951 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
1954 d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
1956 })(window, document);
1957 //--><!]]></script></div><div id="footer">
1958 <p class="apache">Copyright 2014 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>
1959 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><
projects / apache / blob