mod_proxy_scgi.html.en revision 0d0ba3a410038e179b695446bb149cce6264e0ab
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd This file is generated from xml source: DO NOT EDIT
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen<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" />
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen<script src="/style/scripts/prettify.js" type="text/javascript">
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<link href="/images/favicon.ico" rel="shortcut icon" /></head>
d229f940abfb2490dee17979e9a5ff31b7012eb5rbowen<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.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>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<div class="up"><a href="./"><img title="<-" alt="<-" src="/images/left.gif" /></a></div>
3f08db06526d6901aa08c110b5bc7dde6bc39905nd<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.5</a> > <a href="./">Modules</a></div>
f086b4b402fa9a2fefc7dda85de2a3cc1cd0a654rjung<p><span>Available Languages: </span><a href="/en/mod/mod_proxy_scgi.html" title="English"> en </a></p>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>SCGI gateway module for <code class="module"><a href="/mod/mod_proxy.html">mod_proxy</a></code></td></tr>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>proxy_scgi_module</td></tr>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_proxy_scgi.c</td></tr>
c63c66561df3887ae4d6a1a58579044ccb00710end<tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.2.14 and later</td></tr></table>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd <p>This module <em>requires</em> the service of <code class="module"><a href="/mod/mod_proxy.html">mod_proxy</a></code>. It provides support for the
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd <a href="http://python.ca/scgi/protocol.txt">SCGI protocol, version
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd <p>Thus, in order to get the ability of handling the SCGI protocol,
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd <code class="module"><a href="/mod/mod_proxy.html">mod_proxy</a></code> and <code class="module"><a href="/mod/mod_proxy_scgi.html">mod_proxy_scgi</a></code> have to
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd be present in the server.</p>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd <p>Do not enable proxying until you have <a href="mod_proxy.html#access">secured your server</a>. Open proxy
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd servers are dangerous both to your network and to the Internet at
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd large.</p>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<div id="quickview"><h3 class="directives">Directives</h3>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<li><img alt="" src="/images/down.gif" /> <a href="#proxyscgiinternalredirect">ProxySCGIInternalRedirect</a></li>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<li><img alt="" src="/images/down.gif" /> <a href="#proxyscgisendfile">ProxySCGISendfile</a></li>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<li><img alt="" src="/images/down.gif" /> <a href="#examples">Examples</a></li>
fabd4bc0c499704e644a74f78cc3871436824ea0jim<li><img alt="" src="/images/down.gif" /> <a href="#env">Environment Variables</a></li>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<li><code class="module"><a href="/mod/mod_proxy.html">mod_proxy</a></code></li>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<li><code class="module"><a href="/mod/mod_proxy_balancer.html">mod_proxy_balancer</a></code></li>
30471a4650391f57975f60bbb6e4a90be7b284bfhumbedooh</ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd <p>Remember, in order to make the following examples work, you have to
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd enable <code class="module"><a href="/mod/mod_proxy.html">mod_proxy</a></code> and <code class="module"><a href="/mod/mod_proxy_scgi.html">mod_proxy_scgi</a></code>.</p>
e487d6c09669296f94a5190cc34586a98e624a00nd <div class="example"><h3>Simple gateway</h3><pre class="prettyprint lang-config">
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd ProxyPass /scgi-bin/ scgi://localhost:4000/
c8fa0a6b7b2b6beb23bf4684720100e60e4e5764trawick <p>The balanced gateway needs <code class="module"><a href="/mod/mod_proxy_balancer.html">mod_proxy_balancer</a></code> and
9a58dc6a2b26ec128b1270cf48810e705f1a90dbsf at least one load balancer algorithm module, such as
c8fa0a6b7b2b6beb23bf4684720100e60e4e5764trawick <code class="module"><a href="/mod/mod_lbmethod_byrequests.html">mod_lbmethod_byrequests</a></code>, in addition to the proxy
c8fa0a6b7b2b6beb23bf4684720100e60e4e5764trawick modules listed above. <code class="module"><a href="/mod/mod_lbmethod_byrequests.html">mod_lbmethod_byrequests</a></code> is the
c8fa0a6b7b2b6beb23bf4684720100e60e4e5764trawick default, and will be used for this example configuration.</p>
e487d6c09669296f94a5190cc34586a98e624a00nd <div class="example"><h3>Balanced gateway</h3><pre class="prettyprint lang-config">
a4784b5a082381b03e972caf3aa052a64c68f06dhumbedoohProxyPass /scgi-bin/ balancer://somecluster/
a4784b5a082381b03e972caf3aa052a64c68f06dhumbedooh<Proxy balancer://somecluster/>
a4784b5a082381b03e972caf3aa052a64c68f06dhumbedooh BalancerMember scgi://localhost:4000/
a4784b5a082381b03e972caf3aa052a64c68f06dhumbedooh BalancerMember scgi://localhost:4001/
a4784b5a082381b03e972caf3aa052a64c68f06dhumbedooh</Proxy>
fabd4bc0c499704e644a74f78cc3871436824ea0jim</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
fabd4bc0c499704e644a74f78cc3871436824ea0jim<h2><a name="env" id="env">Environment Variables</a></h2>
fabd4bc0c499704e644a74f78cc3871436824ea0jim <p>In addition to the configuration directives that control the
fabd4bc0c499704e644a74f78cc3871436824ea0jim behaviour of <code class="module"><a href="/mod/mod_proxy.html">mod_proxy</a></code>, there are a number of
fabd4bc0c499704e644a74f78cc3871436824ea0jim <dfn>environment variables</dfn> that control the SCGI protocol
fabd4bc0c499704e644a74f78cc3871436824ea0jim provider:</p>
fabd4bc0c499704e644a74f78cc3871436824ea0jim <dd>By default <code class="module"><a href="/mod/mod_proxy_scgi.html">mod_proxy_scgi</a></code> will neither create
fabd4bc0c499704e644a74f78cc3871436824ea0jim nor export the <var>PATH_INFO</var> environment variable. This allows
fabd4bc0c499704e644a74f78cc3871436824ea0jim the backend SCGI server to correctly determine <var>SCRIPT_NAME</var>
fabd4bc0c499704e644a74f78cc3871436824ea0jim and <var>Script-URI</var> and be compliant with RFC 3875 section 3.3.
fabd4bc0c499704e644a74f78cc3871436824ea0jim If instead you need <code class="module"><a href="/mod/mod_proxy_scgi.html">mod_proxy_scgi</a></code> to generate
fabd4bc0c499704e644a74f78cc3871436824ea0jim a "best guess" for <var>PATH_INFO</var>, set this env-var.</dd>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<div class="directive-section"><h2><a name="ProxySCGIInternalRedirect" id="ProxySCGIInternalRedirect">ProxySCGIInternalRedirect</a> <a name="proxyscgiinternalredirect" id="proxyscgiinternalredirect">Directive</a></h2>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enable or disable internal redirect responses from the
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxySCGIInternalRedirect On|Off</code></td></tr>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ProxySCGIInternalRedirect On</code></td></tr>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy_scgi</td></tr>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd <p>The <code class="directive">ProxySCGIInternalRedirect</code> enables the backend
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd to internally redirect the gateway to a different URL. This feature
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd origins in <code class="module"><a href="/mod/mod_cgi.html">mod_cgi</a></code>, which internally redirects the
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd response, if the response status is <code>OK</code> (<code>200</code>) and
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd the response contains a <code>Location</code> header and its value starts
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd with a slash (<code>/</code>). This value is interpreted as a new local
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd URL the apache internally redirects to.</p>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd <p><code class="module"><a href="/mod/mod_proxy_scgi.html">mod_proxy_scgi</a></code> does the same as
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd <code class="module"><a href="/mod/mod_cgi.html">mod_cgi</a></code> in this regard, except that you can turn off the
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd feature.</p>
e487d6c09669296f94a5190cc34586a98e624a00nd <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd ProxySCGIInternalRedirect Off
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<div class="directive-section"><h2><a name="ProxySCGISendfile" id="ProxySCGISendfile">ProxySCGISendfile</a> <a name="proxyscgisendfile" id="proxyscgisendfile">Directive</a></h2>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enable evaluation of <var>X-Sendfile</var> pseudo response
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxySCGISendfile On|Off|<var>Headername</var></code></td></tr>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ProxySCGISendfile Off</code></td></tr>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy_scgi</td></tr>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd <p>The <code class="directive">ProxySCGISendfile</code> directive enables the
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd SCGI backend to let files serve directly by the gateway. This is useful
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd performance purposes -- the httpd can use <code>sendfile</code> or other
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd optimizations, which are not possible if the file comes over the backend
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd socket.</p>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd <p>The <code class="directive">ProxySCGISendfile</code> argument determines the
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd gateway behaviour:</p>
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd <dd>The gateway looks for a backend response header called
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd <code>X-Sendfile</code> and interprets the value as filename to serve. The
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd header is removed from the final response headers. This is equivalent to
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd <dd>Similar to <code>On</code>, but instead of the hardcoded header name
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd the argument is applied as header name.</dd>
e487d6c09669296f94a5190cc34586a98e624a00nd <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">
a4784b5a082381b03e972caf3aa052a64c68f06dhumbedooh # Use the default header (X-Sendfile)
a4784b5a082381b03e972caf3aa052a64c68f06dhumbedooh ProxySCGISendfile On
a4784b5a082381b03e972caf3aa052a64c68f06dhumbedooh # Use a different header
0a69d9bb491d9810892a9949c01403a1de3c7ac2nd ProxySCGISendfile X-Send-Static
f086b4b402fa9a2fefc7dda85de2a3cc1cd0a654rjung<p><span>Available Languages: </span><a href="/en/mod/mod_proxy_scgi.html" title="English"> en </a></p>
30471a4650391f57975f60bbb6e4a90be7b284bfhumbedooh</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>This section is experimental!</strong><br />Comments placed here should not be expected
19737f4fbef1805f9c3e9e045bb6d710a1e5e10fhumbedoohto last beyond the testing phase of this system, nor do we in any way guarantee that we'll read them.</div>
30471a4650391f57975f60bbb6e4a90be7b284bfhumbedoohvar disqus_shortname = 'httpd';
0d0ba3a410038e179b695446bb149cce6264e0abndvar disqus_identifier = 'http://httpd.apache.org/docs/2.4/mod/mod_proxy_scgi.html.en';
0d0ba3a410038e179b695446bb149cce6264e0abnd(function(w, d) {
0d0ba3a410038e179b695446bb149cce6264e0abnd if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
0d0ba3a410038e179b695446bb149cce6264e0abnd d.write('<div id="disqus_thread"><\/div>');
0d0ba3a410038e179b695446bb149cce6264e0abnd var s = d.createElement('script');
0d0ba3a410038e179b695446bb149cce6264e0abnd s.src = 'http' + '://' + disqus_shortname + '.disqus.com/embed.js';
0d0ba3a410038e179b695446bb149cce6264e0abnd (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
0d0ba3a410038e179b695446bb149cce6264e0abnd d.write('<div id="disqus_thread">Comments have been disabled for offline viewing.<\/div>');
0d0ba3a410038e179b695446bb149cce6264e0abnd})(window, document);
5effc8b39fae5cd169d17f342bfc265705840014rbowen<p class="apache">Copyright 2012 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>
d229f940abfb2490dee17979e9a5ff31b7012eb5rbowen<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.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[//><!--
0d0ba3a410038e179b695446bb149cce6264e0abndif (typeof(prettyPrint) !== 'undefined') {
7fec19672a491661b2fe4b29f685bc7f4efa64d4nd prettyPrint();