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>Topics</h3>
  59 <ul id="topics">
  60 <li><img alt="" src="../images/down.gif" /> <a href="#examples">Examples</a></li>
  61 <li><img alt="" src="../images/down.gif" /> <a href="#env">Environment Variables</a></li>
  62 </ul><h3 class="directives">Directives</h3>
  63 <p>This module provides no
  64             directives.</p>
  65 <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 <li><code class="module"><a href="../mod/mod_authnz_fcgi.html">mod_authnz_fcgi</a></code></li>
  70 </ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
  71 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  72 <div class="section">
  73 <h2><a name="examples" id="examples">Examples</a></h2>
  74     <p>Remember, in order to make the following examples work, you have to
  75     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>
  76
  77     <div class="example"><h3>Single application instance</h3><pre class="prettyprint lang-config">ProxyPass "/myapp/" "fcgi://localhost:4000/"</pre>
  78 </div>
  79
  80     <p> <code class="module"><a href="../mod/mod_proxy_fcgi.html">mod_proxy_fcgi</a></code> disables connection reuse by
  81     default, so after a request has been completed the connection will NOT be
  82     held open by that httpd child process and won't be reused.  If the
  83     FastCGI application is able to handle concurrent connections
  84     from httpd, you can opt-in to connection reuse as shown in the following
  85     example:</p>
  86
  87     <div class="example"><h3>Single application instance, connection reuse</h3><pre class="prettyprint lang-config">ProxyPass "/myapp/" "fcgi://localhost:4000/" enablereuse=on</pre>
  88 </div>
  89
  90     <p> The following example passes the request URI as a filesystem
  91     path for the PHP-FPM daemon to run. The request URL is implicitly added
  92     to the 2nd parameter. The hostname and port following fcgi:// are where
  93     PHP-FPM is listening.  Connection pooling is enabled.</p>
  94     <div class="example"><h3>PHP-FPM</h3><pre class="prettyprint lang-config">ProxyPassMatch "^/myapp/.*\.php(/.*)?$" "fcgi://localhost:9000/var/www/" enablereuse=on</pre>
  95 </div>
  96
  97     <p> The following example passes the request URI as a filesystem
  98     path for the PHP-FPM daemon to run. In this case, PHP-FPM is listening on
  99     a unix domain socket (UDS).  Requires 2.4.9 or later. With this syntax,
 100     the hostname and optional port following fcgi:// are ignored.</p>
 101     <div class="example"><h3>PHP-FPM with UDS</h3><pre class="prettyprint lang-config">      # UDS does not currently support connection reuse
 102       ProxyPassMatch "^/(.*\.php(/.*)?)$" "unix:/var/run/php5-fpm.sock|fcgi://localhost/var/www/"</pre>
 103 </div>
 104
 105     <p>The balanced gateway needs <code class="module"><a href="../mod/mod_proxy_balancer.html">mod_proxy_balancer</a></code> and
 106     at least one load balancer algorithm module, such as
 107     <code class="module"><a href="../mod/mod_lbmethod_byrequests.html">mod_lbmethod_byrequests</a></code>, in addition to the proxy
 108     modules listed above.  <code class="module"><a href="../mod/mod_lbmethod_byrequests.html">mod_lbmethod_byrequests</a></code> is the
 109     default, and will be used for this example configuration.</p>
 110
 111     <div class="example"><h3>Balanced gateway to multiple application instances</h3><pre class="prettyprint lang-config">ProxyPass "/myapp/" "balancer://myappcluster/"
 112 &lt;Proxy balancer://myappcluster/&gt;
 113     BalancerMember fcgi://localhost:4000
 114     BalancerMember fcgi://localhost:4001
 115 &lt;/Proxy&gt;</pre>
 116 </div>
 117
 118       <p>You can also force a request to be handled as a reverse-proxy
 119         request, by creating a suitable Handler pass-through. The example
 120         configuration below will pass all requests for PHP scripts to the
 121         specified FastCGI server using reverse proxy.
 122         This feature is available in Apache HTTP Server 2.4.10 and later. For performance
 123        reasons, you will want to define a <a href="mod_proxy.html#workers">worker</a>
 124        representing the same fcgi:// backend. The benefit of this form is that it
 125        allows the normal mapping of URI to filename to occur in the server, and the
 126        local filesystem result is passed to the backend.  When FastCGI is
 127        configured this way, the server can calculate the most accurate
 128        PATH_INFO.
 129       </p>
 130     <div class="example"><h3>Proxy via Handler</h3><pre class="prettyprint lang-config">&lt;FilesMatch "\.php$"&gt;
 131     # Note: The only part that varies is /path/to/app.sock
 132     SetHandler  "proxy:unix:/path/to/app.sock|fcgi://localhost/"
 133 &lt;/FilesMatch&gt;
 134    # Define a matching worker.
 135    # The part that is matched to the SetHandler is the part that
 136    # follows the pipe. If you need to distinguish, "localhost; can
 137    # be anything unique.
 138    &lt;Proxy fcgi://localhost/ enablereuse=on max=10&gt;
 139    &lt;/Proxy&gt;
 140
 141 &lt;FilesMatch ...&gt;
 142     SetHandler  "proxy:fcgi://localhost:9000"
 143 &lt;/FilesMatch&gt;
 144
 145 &lt;FilesMatch ...&gt;
 146     SetHandler  "proxy:balancer://myappcluster/"
 147 &lt;/FilesMatch&gt;</pre>
 148 </div>
 149 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 150 <div class="section">
 151 <h2><a name="env" id="env">Environment Variables</a></h2>
 152     <p>In addition to the configuration directives that control the
 153     behaviour of <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code>, there are a number of
 154     <dfn>environment variables</dfn> that control the FCGI protocol
 155     provider:</p>
 156     <dl>
 157         <dt>proxy-fcgi-pathinfo</dt>
 158         <dd>When configured via <code class="directive"><a href="../mod/mod_proxy.html#proxypass">ProxyPass</a></code> or  <code class="directive"><a href="../mod/mod_proxy.html#proxypassmatch">ProxyPassMatch</a></code>, <code class="module"><a href="../mod/mod_proxy_fcgi.html">mod_proxy_fcgi</a></code> will not
 159         set the <var>PATH_INFO</var> environment variable. This allows
 160         the backend FCGI server to correctly determine <var>SCRIPT_NAME</var>
 161         and <var>Script-URI</var> and be compliant with RFC 3875 section 3.3.
 162         If instead you need <code class="module"><a href="../mod/mod_proxy_fcgi.html">mod_proxy_fcgi</a></code> to generate
 163         a "best guess" for <var>PATH_INFO</var>, set this env-var.
 164         This is a workaround for a bug in some FCGI implementations.  This
 165         variable can be set to multiple values to tweak at how the best guess
 166         is chosen:
 167         <dl>
 168           <dt>first-dot</dt>
 169           <dd>PATH_INFO is split from the slash following the
 170               <em>first</em> "." in the URL.</dd>
 171           <dt>last-dot</dt>
 172           <dd>PATH_INFO is split from the slash following the
 173               <em>last</em> "." in the URL.</dd>
 174           <dt>full</dt>
 175           <dd>PATH_INFO is calculated by an attempt to map the URL to the
 176               local filesystem.</dd>
 177           <dt>unescape</dt>
 178           <dd>PATH_INFO is the path component of the URL, unescaped /
 179               decoded.</dd>
 180           <dt>any other value</dt>
 181           <dd>PATH_INFO is the same as the path component of the URL.
 182               Originally, this was the only proxy-fcgi-pathinfo option.</dd>
 183          </dl>
 184         </dd>
 185     </dl>
 186 </div>
 187 </div>
 188 <div class="bottomlang">
 189 <p><span>Available Languages: </span><a href="../en/mod/mod_proxy_fcgi.html" title="English">&nbsp;en&nbsp;</a></p>
 190 </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>
 191 <script type="text/javascript"><!--//--><![CDATA[//><!--
 192 var comments_shortname = 'httpd';
 193 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_proxy_fcgi.html';
 194 (function(w, d) {
 195     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 196         d.write('<div id="comments_thread"><\/div>');
 197         var s = d.createElement('script');
 198         s.type = 'text/javascript';
 199         s.async = true;
 200         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 201         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 202     }
 203     else {
 204         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 205     }
 206 })(window, document);
 207 //--><!]]></script></div><div id="footer">
 208 <p class="apache">Copyright 2015 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>
 209 <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[//><!--
 210 if (typeof(prettyPrint) !== 'undefined') {
 211     prettyPrint();
 212 }
 213 //--><!]]></script>
 214 </body></html>