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