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

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
   4         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   5               This file is generated from xml source: DO NOT EDIT
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7       -->
   8 <title>mod_proxy_http - Apache HTTP Server</title>
   9 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  10 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  11 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
  12 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  13 <body>
  14 <div id="page-header">
  15 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  16 <p class="apache">Apache HTTP Server Version 2.5</p>
  17 <img alt="" src="../images/feather.gif" /></div>
  18 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  19 <div id="path">
  20 <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.5</a> &gt; <a href="./">Modules</a></div>
  21 <div id="page-content">
  22 <div id="preamble"><h1>Apache Module mod_proxy_http</h1>
  23 <div class="toplang">
  24 <p><span>Available Languages: </span><a href="../en/mod/mod_proxy_http.html" title="English">&nbsp;en&nbsp;</a> |
  25 <a href="../fr/mod/mod_proxy_http.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a></p>
  26 </div>
  27 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>HTTP support module for
  28 <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code></td></tr>
  29 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  30 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>proxy_http_module</td></tr>
  31 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_proxy_http.c</td></tr></table>
  32 <h3>Summary</h3>
  33
  34     <p>This module <em>requires</em> the service of <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code>. It provides the features used for
  35     proxying HTTP and HTTPS requests. <code class="module"><a href="../mod/mod_proxy_http.html">mod_proxy_http</a></code>
  36     supports HTTP/0.9, HTTP/1.0 and HTTP/1.1. It does <em>not</em>
  37     provide any caching abilities. If you want to set up a caching
  38     proxy, you might want to use the additional service of the
  39     <code class="module"><a href="../mod/mod_cache.html">mod_cache</a></code> module.</p>
  40
  41     <p>Thus, in order to get the ability of handling HTTP proxy requests,
  42     <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code> and <code class="module"><a href="../mod/mod_proxy_http.html">mod_proxy_http</a></code>
  43     have to be present in the server.</p>
  44
  45     <div class="warning"><h3>Warning</h3>
  46       <p>Do not enable proxying until you have <a href="mod_proxy.html#access">secured your server</a>. Open proxy
  47       servers are dangerous both to your network and to the Internet at
  48       large.</p>
  49     </div>
  50 </div>
  51 <div id="quickview"><h3 class="directives">Directives</h3>
  52 <p>This module provides no
  53             directives.</p>
  54 <h3>Topics</h3>
  55 <ul id="topics">
  56 <li><img alt="" src="../images/down.gif" /> <a href="#env">Environment Variables</a></li>
  57 <li><img alt="" src="../images/down.gif" /> <a href="#notes">Request notes</a></li>
  58 </ul><h3>See also</h3>
  59 <ul class="seealso">
  60 <li><code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code></li>
  61 <li><code class="module"><a href="../mod/mod_proxy_connect.html">mod_proxy_connect</a></code></li>
  62 </ul></div>
  63 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  64 <div class="section">
  65 <h2><a name="env" id="env">Environment Variables</a></h2>
  66     <p>In addition to the configuration directives that control the
  67     behaviour of <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code>, there are a number of
  68     <dfn>environment variables</dfn> that control the HTTP protocol
  69     provider:</p>
  70     <dl>
  71         <dt>proxy-sendextracrlf</dt>
  72         <dd>Causes proxy to send an extra CR-LF newline on the end of a
  73         request.  This is a workaround for a bug in some browsers.</dd>
  74         <dt>force-proxy-request-1.0</dt>
  75         <dd>Forces the proxy to send requests to the backend as HTTP/1.0
  76         and disables HTTP/1.1 features.</dd>
  77         <dt>proxy-nokeepalive</dt>
  78         <dd>Forces the proxy to close the backend connection after
  79         each request.</dd>
  80         <dt>proxy-chain-auth</dt>
  81         <dd>If the proxy requires authentication, it will read and
  82         consume the proxy authentication credentials sent by the client.
  83         With <var>proxy-chain-auth</var> it will <em>also</em> forward
  84         the credentials to the next proxy in the chain.  This may
  85         be necessary if you have a chain of proxies that share
  86         authentication information.  <strong>Security Warning:</strong>
  87         Do not set this unless you know you need it, as it forwards
  88         sensitive information!</dd>
  89         <dt>proxy-sendcl</dt>
  90         <dd>HTTP/1.0 required all HTTP requests that include a body
  91         (e.g. POST requests) to include a <var>Content-Length</var>
  92         header.  This environment variable forces the Apache proxy to
  93         send this header to the backend server, regardless of what the
  94         Client sent to the proxy.  It ensures compatibility when
  95         proxying for an HTTP/1.0 or unknown backend.  However, it
  96         may require the entire request to be buffered by the proxy,
  97         so it becomes very inefficient for large requests.</dd>
  98         <dt>proxy-sendchunks or proxy-sendchunked</dt>
  99         <dd>This is the opposite of <var>proxy-sendcl</var>.  It allows
 100         request bodies to be sent to the backend using chunked transfer
 101         encoding.  This allows the request to be efficiently streamed,
 102         but requires that the backend server supports HTTP/1.1.</dd>
 103         <dt>proxy-interim-response</dt>
 104         <dd>This variable takes values <code>RFC</code> (the default) or
 105         <code>Suppress</code>.  Earlier httpd versions would suppress
 106         HTTP interim (1xx) responses sent from the backend.  This is
 107         technically a violation of the HTTP protocol.  In practice,
 108         if a backend sends an interim response, it may itself be
 109         extending the protocol in a manner we know nothing about,
 110         or just broken.  So this is now configurable: set
 111         <code>proxy-interim-response RFC</code> to be fully protocol
 112         compliant, or <code>proxy-interim-response Suppress</code>
 113         to suppress interim responses.</dd>
 114         <dt>proxy-initial-not-pooled</dt>
 115         <dd>If this variable is set no pooled connection will be reused
 116         if the client connection is an initial connection. This avoids
 117         the "proxy: error reading status line from remote server" error message
 118         caused by the race condition that the backend server closed the
 119         pooled connection after the connection check by the proxy and
 120         before data sent by the proxy reached the backend. It has to be
 121         kept in mind that setting this variable downgrades performance,
 122         especially with HTTP/1.0 clients.
 123         </dd>
 124     </dl>
 125 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 126 <div class="section">
 127 <h2><a name="notes" id="notes">Request notes</a></h2>
 128     <p><code class="module"><a href="../mod/mod_proxy_http.html">mod_proxy_http</a></code> creates the following request notes for
 129         logging using the <code>%{VARNAME}n</code> format in
 130         <code class="directive"><a href="../mod/mod_log_config.html#logformat">LogFormat</a></code> or
 131         <code class="directive"><a href="../mod/core.html#errorlogformat">ErrorLogFormat</a></code>:
 132     </p>
 133     <dl>
 134         <dt>proxy-source-port</dt>
 135         <dd>The local port used for the connection to the backend server.</dd>
 136         <dt>proxy-status</dt>
 137         <dd>The HTTP status received from the backend server.</dd>
 138     </dl>
 139 </div>
 140 </div>
 141 <div class="bottomlang">
 142 <p><span>Available Languages: </span><a href="../en/mod/mod_proxy_http.html" title="English">&nbsp;en&nbsp;</a> |
 143 <a href="../fr/mod/mod_proxy_http.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a></p>
 144 </div><div id="footer">
 145 <p class="apache">Copyright 2011 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>
 146 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>
 147 </body></html>