mod_proxy_http.xml revision 4e4b258e3d8a6bcb430a8bb938561711fb82f4cf
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford<!DOCTYPE modulesynopsis SYSTEM "/style/modulesynopsis.dtd">
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford<?xml-stylesheet type="text/xsl" href="/style/manual.en.xsl"?>
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford<!-- $LastChangedRevision$ -->
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford Licensed to the Apache Software Foundation (ASF) under one or more
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford contributor license agreements. See the NOTICE file distributed with
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford this work for additional information regarding copyright ownership.
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford The ASF licenses this file to You under the Apache License, Version 2.0
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford (the "License"); you may not use this file except in compliance with
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford the License. You may obtain a copy of the License at
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford Unless required by applicable law or agreed to in writing, software
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford distributed under the License is distributed on an "AS IS" BASIS,
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford See the License for the specific language governing permissions and
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford limitations under the License.
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford<modulesynopsis metafile="mod_proxy_http.xml.meta">
06b16f5d7356f342d87e72fd8746b71673a71ff1Ram Anaswara<description>HTTP support module for
06b16f5d7356f342d87e72fd8746b71673a71ff1Ram Anaswara <p>This module <em>requires</em> the service of <module
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford >mod_proxy</module>. It provides the features used for
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford proxying HTTP requests. <module>mod_proxy_http</module>
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford supports HTTP/0.9, HTTP/1.0 and HTTP/1.1. It does <em>not</em>
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford provide any caching abilities. If you want to set up a caching
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford proxy, you might want to use the additional service of the
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford <p>Thus, in order to get the ability of handling HTTP proxy requests,
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford <module>mod_proxy</module> and <module>mod_proxy_http</module>
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford have to be present in the server.</p>
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford href="mod_proxy.html#access">secured your server</a>. Open proxy
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford servers are dangerous both to your network and to the Internet at
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford<seealso><module>mod_proxy_connect</module></seealso>
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford<section id="env"><title>Environment Variables</title>
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford <p>In addition to the configuration directives that control the
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford behaviour of <module>mod_proxy</module>, there are a number of
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford <dfn>environment variables</dfn> that control the HTTP protocol
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford provider:</p>
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford <dd>Causes proxy to send an extra CR-LF newline on the end of a
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford request. This is a workaround for a bug in some browsers.</dd>
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford <dd>Forces the proxy to send requests to the backend as HTTP/1.0
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford <dd>Forces the proxy to close the backend connection after
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford each request.</dd>
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford <dd>If the proxy requires authentication, it will read and
06b16f5d7356f342d87e72fd8746b71673a71ff1Ram Anaswara consume the proxy authentication credentials sent by the client.
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford With <var>Proxy-Chain-Auth</var> it will <em>also</em> forward
06b16f5d7356f342d87e72fd8746b71673a71ff1Ram Anaswara the credentials to the next proxy in the chain. This may
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford be necessary if you have a chain of proxies that share
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford authentication information. <strong>Security Warning:</strong>
06b16f5d7356f342d87e72fd8746b71673a71ff1Ram Anaswara Do not set this unless you know you need it, as it forwards
06b16f5d7356f342d87e72fd8746b71673a71ff1Ram Anaswara sensitive information!</dd>
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford <dd>HTTP/1.0 required all HTTP requests that include a body
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford (e.g. POST requests) to include a <var>Content-Length</var>
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford header. This environment variable forces the Apache proxy to
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford send this header to the backend server, regardless of what the
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford Client sent to the proxy. It ensures compatibility when
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford proxying for an HTTP/1.0 or unknown backend. However, it
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford may require the entire request to be buffered by the proxy,
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford so it becomes very inefficient for large requests.</dd>
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford <dd>This is the opposite of <var>proxy-sendcl</var>. It allows
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford request bodies to be sent to the backend using chunked transfer
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford encoding. This allows the request to be efficiently streamed,
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford but requires that the backend server supports HTTP/1.1.</dd>
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford <dd>This variable takes values <code>RFC</code> or
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford <code>Suppress</code>. Earlier httpd versions would suppress
06b16f5d7356f342d87e72fd8746b71673a71ff1Ram Anaswara HTTP interim (1xx) responses sent from the backend. This is
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford technically a violation of the HTTP protocol. In practice,
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford if a backend sends an interim response, it may itself be
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford extending the protocol in a manner we know nothing about,
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford or just broken. So this is now configurable: set
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford <code>proxy-interim-response RFC</code> to be fully protocol
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford compliant, or <code>proxy-interim-response Suppress</code>
5769134bf2230c120a9474908c07f24dffaf9991Tony Bamford to suppress interim responses.</dd>