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 <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
   5 <!--
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7               This file is generated from xml source: DO NOT EDIT
   8         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   9       -->
  10 <title>mod_proxy_fcgi - Apache HTTP Server Version 2.5</title>
  11 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  12 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  13 <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" />
  14 <script src="../style/scripts/prettify.min.js" type="text/javascript">
  15 </script>
  16
  17 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  18 <body>
  19 <div id="page-header">
  20 <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>
  21 <p class="apache">Apache HTTP Server Version 2.5</p>
  22 <img alt="" src="../images/feather.png" /></div>
  23 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  24 <div id="path">
  25 <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>
  26 <div id="page-content">
  27 <div id="preamble"><h1>Apache Module mod_proxy_fcgi</h1>
  28 <div class="toplang">
  29 <p><span>Available Languages: </span><a href="../en/mod/mod_proxy_fcgi.html" title="English">&nbsp;en&nbsp;</a></p>
  30 </div>
  31 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>FastCGI support module for
  32 <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code></td></tr>
  33 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  34 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>proxy_fcgi_module</td></tr>
  35 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_proxy_fcgi.c</td></tr>
  36 <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.3 and later</td></tr></table>
  37 <h3>Summary</h3>
  38
  39     <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
  40     <a href="http://www.fastcgi.com/">FastCGI</a> protocol.</p>
  41
  42     <p>Thus, in order to get the ability of handling the <code>FastCGI</code>
  43     protocol, <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code> and
  44     <code class="module"><a href="../mod/mod_proxy_fcgi.html">mod_proxy_fcgi</a></code> have to be present in the server.</p>
  45
  46     <p>Unlike <a href="http://httpd.apache.org/mod_fcgid/">mod_fcgid</a>
  47     and <a href="http://www.fastcgi.com/">mod_fastcgi</a>,
  48     <code class="module"><a href="../mod/mod_proxy_fcgi.html">mod_proxy_fcgi</a></code> has no provision for starting the
  49     application process; <code class="program"><a href="../programs/fcgistarter.html">fcgistarter</a></code> is provided
  50     (on some platforms) for that purpose. Alternatively, external launching
  51     or process management may be available in the FastCGI application
  52     framework in use.</p>
  53
  54     <div class="warning"><h3>Warning</h3>
  55       <p>Do not enable proxying until you have <a href="mod_proxy.html#access">secured your server</a>. Open proxy
  56       servers are dangerous both to your network and to the Internet at
  57       large.</p>
  58     </div>
  59 </div>
  60 <div id="quickview"><h3>Topics</h3>
  61 <ul id="topics">
  62 <li><img alt="" src="../images/down.gif" /> <a href="#examples">Examples</a></li>
  63 <li><img alt="" src="../images/down.gif" /> <a href="#env">Environment Variables</a></li>
  64 </ul><h3 class="directives">Directives</h3>
  65 <p>This module provides no
  66             directives.</p>
  67 <h3>Bugfix checklist</h3><ul class="seealso"><li><a href="https://www.apache.org/dist/httpd/CHANGES_2.4">httpd changelog</a></li><li><a href="https://bz.apache.org/bugzilla/buglist.cgi?bug_status=__open__&amp;list_id=144532&amp;product=Apache%20httpd-2&amp;query_format=specific&amp;order=changeddate%20DESC%2Cpriority%2Cbug_severity&amp;component=mod_proxy_fcgi">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&amp;component=mod_proxy_fcgi">Report a bug</a></li></ul><h3>See also</h3>
  68 <ul class="seealso">
  69 <li><code class="program"><a href="../programs/fcgistarter.html">fcgistarter</a></code></li>
  70 <li><code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code></li>
  71 <li><code class="module"><a href="../mod/mod_authnz_fcgi.html">mod_authnz_fcgi</a></code></li>
  72 <li><a href="#comments_section">Comments</a></li></ul></div>
  73 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  74 <div class="section">
  75 <h2><a name="examples" id="examples">Examples</a></h2>
  76     <p>Remember, in order to make the following examples work, you have to
  77     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>
  78
  79     <div class="example"><h3>Single application instance</h3><pre class="prettyprint lang-config">ProxyPass "/myapp/" "fcgi://localhost:4000/"</pre>
  80 </div>
  81
  82     <p> <code class="module"><a href="../mod/mod_proxy_fcgi.html">mod_proxy_fcgi</a></code> disables connection reuse by
  83     default, so after a request has been completed the connection will NOT be
  84     held open by that httpd child process and won't be reused.  If the
  85     FastCGI application is able to handle concurrent connections
  86     from httpd, you can opt-in to connection reuse as shown in the following
  87     example:</p>
  88
  89     <div class="example"><h3>Single application instance, connection reuse (2.4.11 and later)</h3><pre class="prettyprint lang-config">ProxyPass "/myapp/" "fcgi://localhost:4000/" enablereuse=on</pre>
  90 </div>
  91
  92     <p> The following example passes the request URI as a filesystem
  93     path for the PHP-FPM daemon to run. The request URL is implicitly added
  94     to the 2nd parameter. The hostname and port following fcgi:// are where
  95     PHP-FPM is listening.  Connection pooling is enabled.</p>
  96     <div class="example"><h3>PHP-FPM</h3><pre class="prettyprint lang-config">ProxyPassMatch "^/myapp/.*\.php(/.*)?$" "fcgi://localhost:9000/var/www/" enablereuse=on</pre>
  97 </div>
  98
  99     <p> The following example passes the request URI as a filesystem
 100     path for the PHP-FPM daemon to run. In this case, PHP-FPM is listening on
 101     a unix domain socket (UDS).  Requires 2.4.9 or later. With this syntax,
 102     the hostname and optional port following fcgi:// are ignored.</p>
 103     <div class="example"><h3>PHP-FPM with UDS</h3><pre class="prettyprint lang-config"># UDS does not currently support connection reuse
 104 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       <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         This feature is available in Apache HTTP Server 2.4.10 and later. For performance
 125        reasons, you will want to define a <a href="mod_proxy.html#workers">worker</a>
 126        representing the same fcgi:// backend. The benefit of this form is that it
 127        allows the normal mapping of URI to filename to occur in the server, and the
 128        local filesystem result is passed to the backend.  When FastCGI is
 129        configured this way, the server can calculate the most accurate
 130        PATH_INFO.
 131       </p>
 132     <div class="example"><h3>Proxy via Handler</h3><pre class="prettyprint lang-config">&lt;FilesMatch "\.php$"&gt;
 133     # Note: The only part that varies is /path/to/app.sock
 134     SetHandler  "proxy:unix:/path/to/app.sock|fcgi://localhost/"
 135 &lt;/FilesMatch&gt;
 136
 137 # Define a matching worker.
 138 # The part that is matched to the SetHandler is the part that
 139 # follows the pipe. If you need to distinguish, "localhost; can
 140 # be anything unique.
 141 &lt;Proxy fcgi://localhost/ enablereuse=on max=10&gt;
 142 &lt;/Proxy&gt;
 143
 144 &lt;FilesMatch ...&gt;
 145     SetHandler  "proxy:fcgi://localhost:9000"
 146 &lt;/FilesMatch&gt;
 147
 148 &lt;FilesMatch ...&gt;
 149     SetHandler  "proxy:balancer://myappcluster/"
 150 &lt;/FilesMatch&gt;</pre>
 151 </div>
 152 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 153 <div class="section">
 154 <h2><a name="env" id="env">Environment Variables</a></h2>
 155     <p>In addition to the configuration directives that control the
 156     behaviour of <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code>, there are a number of
 157     <dfn>environment variables</dfn> that control the FCGI protocol
 158     provider:</p>
 159     <dl>
 160         <dt>proxy-fcgi-pathinfo</dt>
 161         <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
 162         set the <var>PATH_INFO</var> environment variable. This allows
 163         the backend FCGI server to correctly determine <var>SCRIPT_NAME</var>
 164         and <var>Script-URI</var> and be compliant with RFC 3875 section 3.3.
 165         If instead you need <code class="module"><a href="../mod/mod_proxy_fcgi.html">mod_proxy_fcgi</a></code> to generate
 166         a "best guess" for <var>PATH_INFO</var>, set this env-var.
 167         This is a workaround for a bug in some FCGI implementations.  This
 168         variable can be set to multiple values to tweak at how the best guess
 169         is chosen (In 2.4.11 and later only):
 170         <dl>
 171           <dt>first-dot</dt>
 172           <dd>PATH_INFO is split from the slash following the
 173               <em>first</em> "." in the URL.</dd>
 174           <dt>last-dot</dt>
 175           <dd>PATH_INFO is split from the slash following the
 176               <em>last</em> "." in the URL.</dd>
 177           <dt>full</dt>
 178           <dd>PATH_INFO is calculated by an attempt to map the URL to the
 179               local filesystem.</dd>
 180           <dt>unescape</dt>
 181           <dd>PATH_INFO is the path component of the URL, unescaped /
 182               decoded.</dd>
 183           <dt>any other value</dt>
 184           <dd>PATH_INFO is the same as the path component of the URL.
 185               Originally, this was the only proxy-fcgi-pathinfo option.</dd>
 186          </dl>
 187         </dd>
 188     </dl>
 189 </div>
 190 </div>
 191 <div class="bottomlang">
 192 <p><span>Available Languages: </span><a href="../en/mod/mod_proxy_fcgi.html" title="English">&nbsp;en&nbsp;</a></p>
 193 </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>
 194 <script type="text/javascript"><!--//--><![CDATA[//><!--
 195 var comments_shortname = 'httpd';
 196 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_proxy_fcgi.html';
 197 (function(w, d) {
 198     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 199         d.write('<div id="comments_thread"><\/div>');
 200         var s = d.createElement('script');
 201         s.type = 'text/javascript';
 202         s.async = true;
 203         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 204         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 205     }
 206     else {
 207         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 208     }
 209 })(window, document);
 210 //--><!]]></script></div><div id="footer">
 211 <p class="apache">Copyright 2017 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>
 212 <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[//><!--
 213 if (typeof(prettyPrint) !== 'undefined') {
 214     prettyPrint();
 215 }
 216 //--><!]]></script>
 217 </body></html>