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 Version 2.5</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">
  13 </script>
  14
  15 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  16 <body>
  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="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  22 <div id="path">
  23 <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>
  24 <div id="page-content">
  25 <div id="preamble"><h1>Apache Module mod_proxy_http</h1>
  26 <div class="toplang">
  27 <p><span>Available Languages: </span><a href="../en/mod/mod_proxy_http.html" title="English">&nbsp;en&nbsp;</a> |
  28 <a href="../fr/mod/mod_proxy_http.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a></p>
  29 </div>
  30 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>HTTP support module for
  31 <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code></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_http_module</td></tr>
  34 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_proxy_http.c</td></tr></table>
  35 <h3>Summary</h3>
  36
  37     <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
  38     proxying HTTP and HTTPS requests. <code class="module"><a href="../mod/mod_proxy_http.html">mod_proxy_http</a></code>
  39     supports HTTP/0.9, HTTP/1.0 and HTTP/1.1. It does <em>not</em>
  40     provide any caching abilities. If you want to set up a caching
  41     proxy, you might want to use the additional service of the
  42     <code class="module"><a href="../mod/mod_cache.html">mod_cache</a></code> module.</p>
  43
  44     <p>Thus, in order to get the ability of handling HTTP proxy requests,
  45     <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>
  46     have to be present in the server.</p>
  47
  48     <div class="warning"><h3>Warning</h3>
  49       <p>Do not enable proxying until you have <a href="mod_proxy.html#access">secured your server</a>. Open proxy
  50       servers are dangerous both to your network and to the Internet at
  51       large.</p>
  52     </div>
  53 </div>
  54 <div id="quickview"><h3 class="directives">Directives</h3>
  55 <p>This module provides no
  56             directives.</p>
  57 <h3>Topics</h3>
  58 <ul id="topics">
  59 <li><img alt="" src="../images/down.gif" /> <a href="#env">Environment Variables</a></li>
  60 <li><img alt="" src="../images/down.gif" /> <a href="#notes">Request notes</a></li>
  61 </ul><h3>See also</h3>
  62 <ul class="seealso">
  63 <li><code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code></li>
  64 <li><code class="module"><a href="../mod/mod_proxy_connect.html">mod_proxy_connect</a></code></li>
  65 </ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
  66 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  67 <div class="section">
  68 <h2><a name="env" id="env">Environment Variables</a></h2>
  69     <p>In addition to the configuration directives that control the
  70     behaviour of <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code>, there are a number of
  71     <dfn>environment variables</dfn> that control the HTTP protocol
  72     provider. Environment variables below that don't specify specific values
  73     are enabled when set to any value.</p>
  74     <dl>
  75         <dt>proxy-sendextracrlf</dt>
  76         <dd>Causes proxy to send an extra CR-LF newline on the end of a
  77         request.  This is a workaround for a bug in some browsers.</dd>
  78         <dt>force-proxy-request-1.0</dt>
  79         <dd>Forces the proxy to send requests to the backend as HTTP/1.0
  80         and disables HTTP/1.1 features.</dd>
  81         <dt>proxy-nokeepalive</dt>
  82         <dd>Forces the proxy to close the backend connection after
  83         each request.</dd>
  84         <dt>proxy-chain-auth</dt>
  85         <dd>If the proxy requires authentication, it will read and
  86         consume the proxy authentication credentials sent by the client.
  87         With <var>proxy-chain-auth</var> it will <em>also</em> forward
  88         the credentials to the next proxy in the chain.  This may
  89         be necessary if you have a chain of proxies that share
  90         authentication information.  <strong>Security Warning:</strong>
  91         Do not set this unless you know you need it, as it forwards
  92         sensitive information!</dd>
  93         <dt>proxy-sendcl</dt>
  94         <dd>HTTP/1.0 required all HTTP requests that include a body
  95         (e.g. POST requests) to include a <var>Content-Length</var>
  96         header.  This environment variable forces the Apache proxy to
  97         send this header to the backend server, regardless of what the
  98         Client sent to the proxy.  It ensures compatibility when
  99         proxying for an HTTP/1.0 or unknown backend.  However, it
 100         may require the entire request to be buffered by the proxy,
 101         so it becomes very inefficient for large requests.</dd>
 102         <dt>proxy-sendchunks or proxy-sendchunked</dt>
 103         <dd>This is the opposite of <var>proxy-sendcl</var>.  It allows
 104         request bodies to be sent to the backend using chunked transfer
 105         encoding.  This allows the request to be efficiently streamed,
 106         but requires that the backend server supports HTTP/1.1.</dd>
 107         <dt>proxy-interim-response</dt>
 108         <dd>This variable takes values <code>RFC</code> (the default) or
 109         <code>Suppress</code>.  Earlier httpd versions would suppress
 110         HTTP interim (1xx) responses sent from the backend.  This is
 111         technically a violation of the HTTP protocol.  In practice,
 112         if a backend sends an interim response, it may itself be
 113         extending the protocol in a manner we know nothing about,
 114         or just broken.  So this is now configurable: set
 115         <code>proxy-interim-response RFC</code> to be fully protocol
 116         compliant, or <code>proxy-interim-response Suppress</code>
 117         to suppress interim responses.</dd>
 118         <dt>proxy-initial-not-pooled</dt>
 119         <dd>If this variable is set, no pooled connection will be reused
 120         if the client request is the initial request on the frontend connection. This avoids
 121         the "proxy: error reading status line from remote server" error message
 122         caused by the race condition that the backend server closed the
 123         pooled connection after the connection check by the proxy and
 124         before data sent by the proxy reached the backend. It has to be
 125         kept in mind that setting this variable downgrades performance,
 126         especially with HTTP/1.0 clients.
 127         </dd>
 128     </dl>
 129 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 130 <div class="section">
 131 <h2><a name="notes" id="notes">Request notes</a></h2>
 132     <p><code class="module"><a href="../mod/mod_proxy_http.html">mod_proxy_http</a></code> creates the following request notes for
 133         logging using the <code>%{VARNAME}n</code> format in
 134         <code class="directive"><a href="../mod/mod_log_config.html#logformat">LogFormat</a></code> or
 135         <code class="directive"><a href="../mod/core.html#errorlogformat">ErrorLogFormat</a></code>:
 136     </p>
 137     <dl>
 138         <dt>proxy-source-port</dt>
 139         <dd>The local port used for the connection to the backend server.</dd>
 140         <dt>proxy-status</dt>
 141         <dd>The HTTP status received from the backend server.</dd>
 142     </dl>
 143 </div>
 144 </div>
 145 <div class="bottomlang">
 146 <p><span>Available Languages: </span><a href="../en/mod/mod_proxy_http.html" title="English">&nbsp;en&nbsp;</a> |
 147 <a href="../fr/mod/mod_proxy_http.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a></p>
 148 </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&amp;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>
 149 <script type="text/javascript"><!--//--><![CDATA[//><!--
 150 var comments_shortname = 'httpd';
 151 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_proxy_http.html';
 152 (function(w, d) {
 153     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 154         d.write('<div id="comments_thread"><\/div>');
 155         var s = d.createElement('script');
 156         s.type = 'text/javascript';
 157         s.async = true;
 158         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 159         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 160     }
 161     else {
 162         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 163     }
 164 })(window, document);
 165 //--><!]]></script></div><div id="footer">
 166 <p class="apache">Copyright 2015 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>
 167 <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"><!--//--><![CDATA[//><!--
 168 if (typeof(prettyPrint) !== 'undefined') {
 169     prettyPrint();
 170 }
 171 //--><!]]></script>
 172 </body></html>