From: Nick Kew <niq@apache.org>
Date: Wed, 17 Oct 2007 19:52:56 +0000 (+0000)
Subject: Backport r582476: Document proxy_http env vars.
X-Git-Tag: 2.2.7~298
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=dacf772649e73dfe41ee53a1ad7bba4f1819f69c;p=thirdparty%2Fapache%2Fhttpd.git

Backport r582476: Document proxy_http env vars.


git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/branches/2.2.x@585649 13f79535-47bb-0310-9956-ffa450edef68
---

diff --git a/STATUS b/STATUS
index 381b9611698..3b61fd30f2f 100644
--- a/STATUS
+++ b/STATUS
@@ -200,10 +200,6 @@ PATCHES PROPOSED TO BACKPORT FROM TRUNK:
      I'm OK with that if others feel happier that way.  The function
      declaration presumably remains in http_protocol.h, so no API change.
 
-   * mod_proxy_http: Document environment variables used by this module
-     http://svn.apache.org/viewvc?view=rev&revision=582476
-     +1: niq
-     
    * mod_proxy_http: Correctly forward unexpected interim (HTTP 1xx) responses
      PR 16518
      http://svn.apache.org/viewvc?view=rev&revision=582631
@@ -214,7 +210,7 @@ PATCHES PROPOSED TO BACKPORT FROM TRUNK:
      in r582631, or is there something else that needs reconciling?
      rpluem says: Yes, there is a conflict in backporting the mod_proxy_http.xml
      changes of r582631.
-     niq says: Aha, it's r582476.  Adding proposal for that above this one.
+     niq says: Aha, it's r582476. Fixed.
 
 PATCHES/ISSUES THAT ARE STALLED
 
diff --git a/docs/manual/mod/mod_proxy_http.xml b/docs/manual/mod/mod_proxy_http.xml
index f3fc518f9e3..528f03b0438 100644
--- a/docs/manual/mod/mod_proxy_http.xml
+++ b/docs/manual/mod/mod_proxy_http.xml
@@ -52,4 +52,45 @@
 <seealso><module>mod_proxy</module></seealso>
 <seealso><module>mod_proxy_connect</module></seealso>
 
+<section id="env"><title>Environment Variables</title>
+    <p>In addition to the configuration directives that control the
+    behaviour of <module>mod_proxy</module>, there are a number of
+    <dfn>environment variables</dfn> that control the HTTP protocol
+    provider:</p>
+    <dl>
+        <dt>proxy-sendextracrlf</dt>
+        <dd>Causes proxy to send an extra CR-LF newline on the end of a
+        request.  This is a workaround for a bug in some browsers.</dd>
+        <dt>force-proxy-request-1.0</dt>
+        <dd>Forces the proxy to send requests to the backend as HTTP/1.0
+        and disables HTTP/1.1 features.</dd>
+        <dt>proxy-nokeepalive</dt>
+        <dd>Forces the proxy to close the backend connection after
+        each request.</dd>
+        <dt>Proxy-Chain-Auth</dt>
+        <dd>If the proxy requires authentication, it will read and
+        consume the proxy authentication credentials sent by the client.
+        With <var>Proxy-Chain-Auth</var> it will <em>also</em> forward
+        the credentials to the next proxy in the chain.  This may
+        be necessary if you have a chain of proxies that share
+        authentication information.  <strong>Security Warning:</strong>
+        Do not set this unless you know you need it, as it forwards
+        sensitive information!</dd>
+        <dt>proxy-sendcl</dt>
+        <dd>HTTP/1.0 required all HTTP requests that include a body
+        (e.g. POST requests) to include a <var>Content-Length</var>
+        header.  This environment variable forces the Apache proxy to
+        send this header to the backend server, regardless of what the
+        Client sent to the proxy.  It ensures compatibility when
+        proxying for an HTTP/1.0 or unknown backend.  However, it
+        may require the entire request to be buffered by the proxy,
+        so it becomes very inefficient for large requests.</dd>
+        <dt>proxy-sendchunks or proxy-sendchunked</dt>
+        <dd>This is the opposite of <var>proxy-sendcl</var>.  It allows
+        request bodies to be sent to the backend using chunked transfer
+        encoding.  This allows the request to be efficiently streamed,
+        but requires that the backend server supports HTTP/1.1.</dd>
+    </dl>
+</section>
+
 </modulesynopsis>