granicus.if.org Git - apache/blob - docs/manual/mod/mod_proxy_fcgi.html.en

   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
   7       -->
   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" />
  12 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  13 <body>
  14 <div id="page-header">
  15 <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>
  16 <p class="apache">Apache HTTP Server Version 2.5</p>
  17 <img alt="" src="../images/feather.gif" /></div>
  18 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  19 <div id="path">
  20 <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.5</a> &gt; <a href="./">Modules</a></div>
  21 <div id="page-content">
  22 <div id="preamble"><h1>Apache Module mod_proxy_fcgi</h1>
  23 <div class="toplang">
  24 <p><span>Available Languages: </span><a href="../en/mod/mod_proxy_fcgi.html" title="English">&nbsp;en&nbsp;</a></p>
  25 </div>
  26 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>FastCGI support module for
  27 <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code></td></tr>
  28 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  29 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>proxy_fcgi_module</td></tr>
  30 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_proxy_fcgi.c</td></tr>
  31 <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.3 and later</td></tr></table>
  32 <h3>Summary</h3>
  33
  34     <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
  35     <a href="http://www.fastcgi.com/">FastCGI</a> protocol.</p>
  36
  37     <p>Thus, in order to get the ability of handling the <code>FastCGI</code>
  38     protocol, <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code> and
  39     <code class="module"><a href="../mod/mod_proxy_fcgi.html">mod_proxy_fcgi</a></code> have to be present in the server.</p>
  40
  41     <p>Unlike <a href="http://httpd.apache.org/mod_fcgid/">mod_fcgid</a>
  42     and <a href="http://www.fastcgi.com/">mod_fastcgi</a>,
  43     <code class="module"><a href="../mod/mod_proxy_fcgi.html">mod_proxy_fcgi</a></code> has no provision for starting the
  44     application process; <code class="program"><a href="../programs/fcgistarter.html">fcgistarter</a></code> is provided for
  45     that purpose.</p>
  46
  47     <div class="warning"><h3>Warning</h3>
  48       <p>Do not enable proxying until you have <a href="mod_proxy.html#access">secured your server</a>. Open proxy
  49       servers are dangerous both to your network and to the Internet at
  50       large.</p>
  51     </div>
  52 </div>
  53 <div id="quickview"><h3 class="directives">Directives</h3>
  54 <p>This module provides no
  55             directives.</p>
  56 <h3>Topics</h3>
  57 <ul id="topics">
  58 <li><img alt="" src="../images/down.gif" /> <a href="#examples">Examples</a></li>
  59 <li><img alt="" src="../images/down.gif" /> <a href="#env">Environment Variables</a></li>
  60 </ul><h3>See also</h3>
  61 <ul class="seealso">
  62 <li><code class="program"><a href="../programs/fcgistarter.html">fcgistarter</a></code></li>
  63 <li><code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code></li>
  64 </ul></div>
  65 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  66 <div class="section">
  67 <h2><a name="examples" id="examples">Examples</a></h2>
  68     <p>Remember, in order to make the following examples work, you have to
  69     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>
  70
  71     <div class="example"><h3>Single application instance</h3><p><code>
  72       ProxyPass /myapp/ fcgi://localhost:4000/
  73     </code></p></div>
  74
  75     <p>This application should be able to handle multiple concurrent
  76     connections.  <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code> enables connection reuse by
  77     default, so after a request has been completed the connection will be
  78     held open by that httpd child process and won't be reused until that
  79     httpd process routes another request to the application.  If the
  80     FastCGI application is unable to handle enough concurrent connections
  81     from httpd, requests can block waiting for the application to close
  82     an existing connection.  One way to resolve this is to disable connection
  83     reuse on the <code class="directive">ProxyPass</code> directive, as shown in
  84     the following example:</p>
  85
  86     <div class="example"><h3>Single application instance, no connection reuse</h3><p><code>
  87       ProxyPass /myapp/ fcgi://localhost:4000/ disablereuse=on
  88     </code></p></div>
  89
  90     <p>The balanced gateway needs <code class="module"><a href="../mod/mod_proxy_balancer.html">mod_proxy_balancer</a></code> and
  91     at least one load balancer algorithm module, such as
  92     <code class="module"><a href="../mod/mod_lbmethod_byrequests.html">mod_lbmethod_byrequests</a></code>, in addition to the proxy
  93     modules listed above.  <code class="module"><a href="../mod/mod_lbmethod_byrequests.html">mod_lbmethod_byrequests</a></code> is the
  94     default, and will be used for this example configuration.</p>
  95
  96     <div class="example"><h3>Balanced gateway to multiple application instances</h3><p><code>
  97     ProxyPass /myapp/ balancer://myappcluster/<br />
  98     &lt;Proxy balancer://myappcluster/&gt;<br />
  99     <span class="indent">
 100         BalancerMember fcgi://localhost:4000/<br />
 101         BalancerMember fcgi://localhost:4001/<br />
 102     </span>
 103     &lt;/Proxy&gt;
 104     </code></p></div>
 105 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 106 <div class="section">
 107 <h2><a name="env" id="env">Environment Variables</a></h2>
 108     <p>In addition to the configuration directives that control the
 109     behaviour of <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code>, there are a number of
 110     <dfn>environment variables</dfn> that control the FCGI protocol
 111     provider:</p>
 112     <dl>
 113         <dt>proxy-fcgi-pathinfo</dt>
 114         <dd>By default <code class="module"><a href="../mod/mod_proxy_fcgi.html">mod_proxy_fcgi</a></code> will neither create
 115         nor export the <var>PATH_INFO</var> environment variable. This allows
 116         the backend FCGI server to correctly determine <var>SCRIPT_NAME</var>
 117         and <var>Script-URI</var> and be compliant with RFC 3875 section 3.3.
 118         If instead you need <code class="module"><a href="../mod/mod_proxy_fcgi.html">mod_proxy_fcgi</a></code> to generate
 119         a "best guess" for <var>PATH_INFO</var>, set this env-var.
 120         This is a workaround for a bug in some FCGI implementations.</dd>
 121     </dl>
 122 </div>
 123 </div>
 124 <div class="bottomlang">
 125 <p><span>Available Languages: </span><a href="../en/mod/mod_proxy_fcgi.html" title="English">&nbsp;en&nbsp;</a></p>
 126 </div><div id="footer">
 127 <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>
 128 <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>
 129 </body></html>