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
8 <title>mod_proxy_fcgi - Apache HTTP Server</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.js" type="text/javascript">
15 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
17 <div id="page-header">
18 <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>
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="<-" alt="<-" src="../images/left.gif" /></a></div>
23 <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>
24 <div id="page-content">
25 <div id="preamble"><h1>Apache Module mod_proxy_fcgi</h1>
27 <p><span>Available Languages: </span><a href="../en/mod/mod_proxy_fcgi.html" title="English"> en </a></p>
29 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>FastCGI support module for
30 <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code></td></tr>
31 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
32 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>proxy_fcgi_module</td></tr>
33 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_proxy_fcgi.c</td></tr>
34 <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.3 and later</td></tr></table>
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 support for the
38 <a href="http://www.fastcgi.com/">FastCGI</a> protocol.</p>
40 <p>Thus, in order to get the ability of handling the <code>FastCGI</code>
41 protocol, <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code> and
42 <code class="module"><a href="../mod/mod_proxy_fcgi.html">mod_proxy_fcgi</a></code> have to be present in the server.</p>
44 <p>Unlike <a href="http://httpd.apache.org/mod_fcgid/">mod_fcgid</a>
45 and <a href="http://www.fastcgi.com/">mod_fastcgi</a>,
46 <code class="module"><a href="../mod/mod_proxy_fcgi.html">mod_proxy_fcgi</a></code> has no provision for starting the
47 application process; <code class="program"><a href="../programs/fcgistarter.html">fcgistarter</a></code> is provided for
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
56 <div id="quickview"><h3 class="directives">Directives</h3>
57 <p>This module provides no
61 <li><img alt="" src="../images/down.gif" /> <a href="#examples">Examples</a></li>
62 <li><img alt="" src="../images/down.gif" /> <a href="#env">Environment Variables</a></li>
63 </ul><h3>See also</h3>
65 <li><code class="program"><a href="../programs/fcgistarter.html">fcgistarter</a></code></li>
66 <li><code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code></li>
67 </ul><ul class="seealso"><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>
70 <h2><a name="examples" id="examples">Examples</a></h2>
71 <p>Remember, in order to make the following examples work, you have to
72 enable <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code> and <code class="module"><a href="../mod/mod_proxy_fcgi.html">mod_proxy_fcgi</a></code>.</p>
74 <div class="example"><h3>Single application instance</h3><pre class="prettyprint lang-config">
75 ProxyPass /myapp/ fcgi://localhost:4000/
79 <p>This application should be able to handle multiple concurrent
80 connections. <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code> enables connection reuse by
81 default, so after a request has been completed the connection will be
82 held open by that httpd child process and won't be reused until that
83 httpd process routes another request to the application. If the
84 FastCGI application is unable to handle enough concurrent connections
85 from httpd, requests can block waiting for the application to close
86 an existing connection. One way to resolve this is to disable connection
87 reuse on the <code class="directive">ProxyPass</code> directive, as shown in
88 the following example:</p>
90 <div class="example"><h3>Single application instance, no connection reuse</h3><pre class="prettyprint lang-config">
91 ProxyPass /myapp/ fcgi://localhost:4000/ disablereuse=on
95 <p>The balanced gateway needs <code class="module"><a href="../mod/mod_proxy_balancer.html">mod_proxy_balancer</a></code> and
96 at least one load balancer algorithm module, such as
97 <code class="module"><a href="../mod/mod_lbmethod_byrequests.html">mod_lbmethod_byrequests</a></code>, in addition to the proxy
98 modules listed above. <code class="module"><a href="../mod/mod_lbmethod_byrequests.html">mod_lbmethod_byrequests</a></code> is the
99 default, and will be used for this example configuration.</p>
101 <div class="example"><h3>Balanced gateway to multiple application instances</h3><pre class="prettyprint lang-config">
102 ProxyPass /myapp/ balancer://myappcluster/
103 <Proxy balancer://myappcluster/>
104 BalancerMember fcgi://localhost:4000/
105 BalancerMember fcgi://localhost:4001/
109 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
110 <div class="section">
111 <h2><a name="env" id="env">Environment Variables</a></h2>
112 <p>In addition to the configuration directives that control the
113 behaviour of <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code>, there are a number of
114 <dfn>environment variables</dfn> that control the FCGI protocol
117 <dt>proxy-fcgi-pathinfo</dt>
118 <dd>By default <code class="module"><a href="../mod/mod_proxy_fcgi.html">mod_proxy_fcgi</a></code> will neither create
119 nor export the <var>PATH_INFO</var> environment variable. This allows
120 the backend FCGI server to correctly determine <var>SCRIPT_NAME</var>
121 and <var>Script-URI</var> and be compliant with RFC 3875 section 3.3.
122 If instead you need <code class="module"><a href="../mod/mod_proxy_fcgi.html">mod_proxy_fcgi</a></code> to generate
123 a "best guess" for <var>PATH_INFO</var>, set this env-var.
124 This is a workaround for a bug in some FCGI implementations.</dd>
128 <div class="bottomlang">
129 <p><span>Available Languages: </span><a href="../en/mod/mod_proxy_fcgi.html" title="English"> en </a></p>
130 </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
131 to last beyond the testing phase of this system, nor do we in any way guarantee that we'll read them.</div>
132 <script type="text/javascript"><!--//--><![CDATA[//><!--
134 var disqus_shortname = 'httpd';
135 var disqus_identifier = window.location.href.replace(/(current|trunk)/, "2.4").replace(/\/[a-z]{2}\//, "/").replace(window.location.protocol, "http:") + '.' + lang;
136 if (disqus_identifier.indexOf("httpd.apache.org") == -1) {
137 document.write('<div id="disqus_thread">\n</div>');
139 var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
140 dsq.src = window.location.protocol + '//' + disqus_shortname + '.disqus.com/embed.js';
141 (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
144 document.write("Comments have been disabled for offline viewing.");
146 //--><!]]></script></div><div id="footer">
147 <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>
148 <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[//><!--
149 if (typeof(prettyPrint) !== undefined) {