| <?xml version="1.0" encoding="ISO-8859-1"?> |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!-- |
| XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| This file is generated from xml source: DO NOT EDIT |
| XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| --> |
| <title>mod_proxy_fcgi - Apache HTTP Server</title> |
| <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" /> |
| <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" /> |
| <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /> |
| <link href="../images/favicon.ico" rel="shortcut icon" /></head> |
| <body> |
| <div id="page-header"> |
| <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p> |
| <p class="apache">Apache HTTP Server Version 2.3</p> |
| <img alt="" src="../images/feather.gif" /></div> |
| <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div> |
| <div id="path"> |
| <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.3</a> > <a href="./">Modules</a></div> |
| <div id="page-content"> |
| <div id="preamble"><h1>Apache Module mod_proxy_fcgi</h1> |
| <div class="toplang"> |
| <p><span>Available Languages: </span><a href="../en/mod/mod_proxy_fcgi.html" title="English"> en </a></p> |
| </div> |
| <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>FastCGI support module for |
| <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code></td></tr> |
| <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr> |
| <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>proxy_fcgi_module</td></tr> |
| <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_proxy_fcgi.c</td></tr> |
| <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.3 and later</td></tr></table> |
| <h3>Summary</h3> |
| |
| <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 |
| <a href="http://www.fastcgi.com/">FastCGI</a> protocol.</p> |
| |
| <p>Thus, in order to get the ability of handling the <code>FastCGI</code> |
| protocol, <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> have to be present in the server.</p> |
| |
| <p>Unlike <a href="http://httpd.apache.org/mod_fcgid/">mod_fcgid</a> |
| and <a href="http://www.fastcgi.com/">mod_fastcgi</a>, |
| <code class="module"><a href="../mod/mod_proxy_fcgi.html">mod_proxy_fcgi</a></code> has no provision for starting the |
| application process; <code class="program"><a href="../programs/fcgistarter.html">fcgistarter</a></code> is provided for |
| that purpose.</p> |
| |
| <div class="warning"><h3>Warning</h3> |
| <p>Do not enable proxying until you have <a href="mod_proxy.html#access">secured your server</a>. Open proxy |
| servers are dangerous both to your network and to the Internet at |
| large.</p> |
| </div> |
| </div> |
| <div id="quickview"><h3 class="directives">Directives</h3> |
| <p>This module provides no |
| directives.</p> |
| <h3>Topics</h3> |
| <ul id="topics"> |
| <li><img alt="" src="../images/down.gif" /> <a href="#examples">Examples</a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#env">Environment Variables</a></li> |
| </ul><h3>See also</h3> |
| <ul class="seealso"> |
| <li><code class="program"><a href="../programs/fcgistarter.html">fcgistarter</a></code></li> |
| <li><code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code></li> |
| </ul></div> |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="section"> |
| <h2><a name="examples" id="examples">Examples</a></h2> |
| <p>Remember, in order to make the following examples work, you have to |
| 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> |
| |
| <div class="example"><h3>Single application instance</h3><p><code> |
| ProxyPass /myapp/ fcgi://localhost:4000/ |
| </code></p></div> |
| |
| <p>This application should be able to handle multiple concurrent |
| connections. <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code> enables connection reuse by |
| default, so after a request has been completed the connection will be |
| held open by that httpd child process and won't be reused until that |
| httpd process routes another request to the application. If the |
| FastCGI application is unable to handle enough concurrent connections |
| from httpd, requests can block waiting for the application to close |
| an existing connection. One way to resolve this is to disable connection |
| reuse on the <code class="directive">ProxyPass</code> directive, as shown in |
| the following example:</p> |
| |
| <div class="example"><h3>Single application instance, no connection reuse</h3><p><code> |
| ProxyPass /myapp/ fcgi://localhost:4000/ disablereuse=on |
| </code></p></div> |
| |
| <p>The balanced gateway needs <code class="module"><a href="../mod/mod_proxy_balancer.html">mod_proxy_balancer</a></code> and |
| at least one load balancer algorithm module, such as |
| <code class="module"><a href="../mod/mod_lbmethod_byrequests.html">mod_lbmethod_byrequests</a></code>, in addition to the proxy |
| modules listed above. <code class="module"><a href="../mod/mod_lbmethod_byrequests.html">mod_lbmethod_byrequests</a></code> is the |
| default, and will be used for this example configuration.</p> |
| |
| <div class="example"><h3>Balanced gateway to multiple application instances</h3><p><code> |
| ProxyPass /myapp/ balancer://myappcluster/<br /> |
| <Proxy balancer://myappcluster/><br /> |
| <span class="indent"> |
| BalancerMember fcgi://localhost:4000/<br /> |
| BalancerMember fcgi://localhost:4001/<br /> |
| </span> |
| </Proxy> |
| </code></p></div> |
| </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="section"> |
| <h2><a name="env" id="env">Environment Variables</a></h2> |
| <p>In addition to the configuration directives that control the |
| behaviour of <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code>, there are a number of |
| <dfn>environment variables</dfn> that control the FCGI protocol |
| provider:</p> |
| <dl> |
| <dt>proxy-fcgi-pathinfo</dt> |
| <dd>By default <code class="module"><a href="../mod/mod_proxy_fcgi.html">mod_proxy_fcgi</a></code> will neither create |
| nor export the <var>PATH_INFO</var> environment variable. This allows |
| the backend FCGI server to correctly determine <var>SCRIPT_NAME</var> |
| and <var>Script-URI</var> and be compliant with RFC 3875 section 3.3. |
| If instead you need <code class="module"><a href="../mod/mod_proxy_fcgi.html">mod_proxy_fcgi</a></code> to generate |
| a "best guess" for <var>PATH_INFO</var>, set this env-var. |
| This is a workaround for a bug in some FCGI implementations.</dd> |
| </dl> |
| </div> |
| </div> |
| <div class="bottomlang"> |
| <p><span>Available Languages: </span><a href="../en/mod/mod_proxy_fcgi.html" title="English"> en </a></p> |
| </div><div id="footer"> |
| <p class="apache">Copyright 2011 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> |
| <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div> |
| </body></html> |
