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 Version 2.5</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.min.js" type="text/javascript">
  13 </script>
  14
  15 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  16 <body>
  17 <div id="page-header">
  18 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.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="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  22 <div id="path">
  23 <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>
  24 <div id="page-content">
  25 <div id="preamble"><h1>Apache Module mod_proxy_fcgi</h1>
  26 <div class="toplang">
  27 <p><span>Available Languages: </span><a href="../en/mod/mod_proxy_fcgi.html" title="English">&nbsp;en&nbsp;</a></p>
  28 </div>
  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>
  35 <h3>Summary</h3>
  36
  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>
  39
  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>
  43
  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
  48     (on some platforms) for that purpose. Alternatively, external launching
  49     or process management may be available in the FastCGI application
  50     framework in use.</p>
  51
  52     <div class="warning"><h3>Warning</h3>
  53       <p>Do not enable proxying until you have <a href="mod_proxy.html#access">secured your server</a>. Open proxy
  54       servers are dangerous both to your network and to the Internet at
  55       large.</p>
  56     </div>
  57 </div>
  58 <div id="quickview"><h3 class="directives">Directives</h3>
  59 <p>This module provides no
  60             directives.</p>
  61 <h3>Topics</h3>
  62 <ul id="topics">
  63 <li><img alt="" src="../images/down.gif" /> <a href="#examples">Examples</a></li>
  64 <li><img alt="" src="../images/down.gif" /> <a href="#env">Environment Variables</a></li>
  65 </ul><h3>See also</h3>
  66 <ul class="seealso">
  67 <li><code class="program"><a href="../programs/fcgistarter.html">fcgistarter</a></code></li>
  68 <li><code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code></li>
  69 </ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
  70 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  71 <div class="section">
  72 <h2><a name="examples" id="examples">Examples</a></h2>
  73     <p>Remember, in order to make the following examples work, you have to
  74     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>
  75
  76     <div class="example"><h3>Single application instance</h3><pre class="prettyprint lang-config">ProxyPass /myapp/ fcgi://localhost:4000/</pre>
  77 </div>
  78
  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>
  89
  90     <div class="example"><h3>Single application instance, no connection reuse</h3><pre class="prettyprint lang-config">ProxyPass /myapp/ fcgi://localhost:4000/ disablereuse=on</pre>
  91 </div>
  92
  93     <p> The following example passes the request URI as a filesystem
  94     path for the PHP-FPM daemon to run. The request URL is implicitly added
  95     to the 2nd parameter. The hostname and port following fcgi:// are where
  96     PHP-FPM is listening.</p>
  97     <div class="example"><h3>PHP-FPM</h3><pre class="prettyprint lang-config">ProxyPassMatch ^/myapp/.*\.php(/.*)?$ fcgi://localhost:9000/var/www/</pre>
  98 </div>
  99
 100     <p> The following example passes the request URI as a filesystem
 101     path for the PHP-FPM daemon to run. In this case, PHP-FPM is listening on
 102     a unix domain socket (UDS).  Requires 2.4.9 or later. With this syntax,
 103     the hostname and optional port following fci:// are ignored.</p>
 104     <div class="example"><h3>PHP-FPM with UDS</h3><pre class="prettyprint lang-config">ProxyPassMatch ^/(.*\.php(/.*)?)$ "unix:/var/run/php5-fpm.sock|fcgi://localhost/var/www/"</pre>
 105 </div>
 106
 107     <p>The balanced gateway needs <code class="module"><a href="../mod/mod_proxy_balancer.html">mod_proxy_balancer</a></code> and
 108     at least one load balancer algorithm module, such as
 109     <code class="module"><a href="../mod/mod_lbmethod_byrequests.html">mod_lbmethod_byrequests</a></code>, in addition to the proxy
 110     modules listed above.  <code class="module"><a href="../mod/mod_lbmethod_byrequests.html">mod_lbmethod_byrequests</a></code> is the
 111     default, and will be used for this example configuration.</p>
 112
 113     <div class="example"><h3>Balanced gateway to multiple application instances</h3><pre class="prettyprint lang-config">ProxyPass /myapp/ balancer://myappcluster/
 114 &lt;Proxy balancer://myappcluster/&gt;
 115     BalancerMember fcgi://localhost:4000
 116     BalancerMember fcgi://localhost:4001
 117 &lt;/Proxy&gt;</pre>
 118 </div>
 119
 120     <div class="example"><h3>Proxy via Handler</h3><p>You can also force a request to be handled as a reverse-proxy
 121         request, by creating a suitable Handler pass-through. The example
 122         configuration below will pass all requests for PHP scripts to the
 123         specified FastCGI server using reverse proxy:
 124       </p><pre class="prettyprint lang-config">&lt;FilesMatch \.php$&gt;
 125     SetHandler  "proxy:unix:/path/to/app.sock|fcgi://localhost/"
 126 &lt;/FilesMatch&gt;</pre>
 127 <p>This feature is available in Apache HTTP Server 2.4.10 and later. For performance
 128    reasons, you will want to define a <a href="../mod_proxy.html#worker">worker</a>
 129    representing the same fcgi:// backend.</p></div>
 130 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 131 <div class="section">
 132 <h2><a name="env" id="env">Environment Variables</a></h2>
 133     <p>In addition to the configuration directives that control the
 134     behaviour of <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code>, there are a number of
 135     <dfn>environment variables</dfn> that control the FCGI protocol
 136     provider:</p>
 137     <dl>
 138         <dt>proxy-fcgi-pathinfo</dt>
 139         <dd>By default <code class="module"><a href="../mod/mod_proxy_fcgi.html">mod_proxy_fcgi</a></code> will neither create
 140         nor export the <var>PATH_INFO</var> environment variable. This allows
 141         the backend FCGI server to correctly determine <var>SCRIPT_NAME</var>
 142         and <var>Script-URI</var> and be compliant with RFC 3875 section 3.3.
 143         If instead you need <code class="module"><a href="../mod/mod_proxy_fcgi.html">mod_proxy_fcgi</a></code> to generate
 144         a "best guess" for <var>PATH_INFO</var>, set this env-var.
 145         This is a workaround for a bug in some FCGI implementations.</dd>
 146     </dl>
 147 </div>
 148 </div>
 149 <div class="bottomlang">
 150 <p><span>Available Languages: </span><a href="../en/mod/mod_proxy_fcgi.html" title="English">&nbsp;en&nbsp;</a></p>
 151 </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>Notice:</strong><br />This is not a Q&amp;A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
 152 <script type="text/javascript"><!--//--><![CDATA[//><!--
 153 var comments_shortname = 'httpd';
 154 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_proxy_fcgi.html';
 155 (function(w, d) {
 156     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 157         d.write('<div id="comments_thread"><\/div>');
 158         var s = d.createElement('script');
 159         s.type = 'text/javascript';
 160         s.async = true;
 161         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 162         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 163     }
 164     else {
 165         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 166     }
 167 })(window, document);
 168 //--><!]]></script></div><div id="footer">
 169 <p class="apache">Copyright 2014 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>
 170 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.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[//><!--
 171 if (typeof(prettyPrint) !== 'undefined') {
 172     prettyPrint();
 173 }
 174 //--><!]]></script>
 175 </body></html>