mod_proxy_fcgi.html.en revision 5b1f1cc7538b9d1872f8de530bb65f51add7d8db
97a9a944b5887e91042b019776c41d5dd74557aferikabele<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
97a9a944b5887e91042b019776c41d5dd74557aferikabele<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
a945f35eff8b6a88009ce73de6d4c862ce58de3cslive XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
a945f35eff8b6a88009ce73de6d4c862ce58de3cslive This file is generated from xml source: DO NOT EDIT
a945f35eff8b6a88009ce73de6d4c862ce58de3cslive XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
5a58787efeb02a1c3f06569d019ad81fd2efa06end<title>mod_proxy_fcgi - Apache HTTP Server Version 2.5</title>
5a58787efeb02a1c3f06569d019ad81fd2efa06end<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
5a58787efeb02a1c3f06569d019ad81fd2efa06end<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
5a58787efeb02a1c3f06569d019ad81fd2efa06end<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" />
5a58787efeb02a1c3f06569d019ad81fd2efa06end<script src="/style/scripts/prettify.min.js" type="text/javascript">
5a58787efeb02a1c3f06569d019ad81fd2efa06end<link href="/images/favicon.ico" rel="shortcut icon" /></head>
5a58787efeb02a1c3f06569d019ad81fd2efa06end<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>
5a58787efeb02a1c3f06569d019ad81fd2efa06end<div class="up"><a href="./"><img title="<-" alt="<-" src="/images/left.gif" /></a></div>
5a58787efeb02a1c3f06569d019ad81fd2efa06end<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.5</a> > <a href="./">Modules</a></div>
5a58787efeb02a1c3f06569d019ad81fd2efa06end<p><span>Available Languages: </span><a href="/en/mod/mod_proxy_fcgi.html" title="English"> en </a></p>
5a58787efeb02a1c3f06569d019ad81fd2efa06end<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>FastCGI support module for
06ba4a61654b3763ad65f52283832ebf058fdf1cslive<code class="module"><a href="/mod/mod_proxy.html">mod_proxy</a></code></td></tr>
9b6a3a558cc90ffdaa0b50bd02546ffec424ded7slive<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
9b6a3a558cc90ffdaa0b50bd02546ffec424ded7slive<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>proxy_fcgi_module</td></tr>
9b6a3a558cc90ffdaa0b50bd02546ffec424ded7slive<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_proxy_fcgi.c</td></tr>
9b6a3a558cc90ffdaa0b50bd02546ffec424ded7slive<tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.3 and later</td></tr></table>
9b6a3a558cc90ffdaa0b50bd02546ffec424ded7slive <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
97a9a944b5887e91042b019776c41d5dd74557aferikabele <a href="http://www.fastcgi.com/">FastCGI</a> protocol.</p>
97a9a944b5887e91042b019776c41d5dd74557aferikabele <p>Thus, in order to get the ability of handling the <code>FastCGI</code>
f8396ed8364b56ec8adeaa49cac35a929758a29eslive protocol, <code class="module"><a href="/mod/mod_proxy.html">mod_proxy</a></code> and
f8396ed8364b56ec8adeaa49cac35a929758a29eslive <code class="module"><a href="/mod/mod_proxy_fcgi.html">mod_proxy_fcgi</a></code> have to be present in the server.</p>
5a58787efeb02a1c3f06569d019ad81fd2efa06end <p>Unlike <a href="http://httpd.apache.org/mod_fcgid/">mod_fcgid</a>
a63f0ab647ad2ab72efc9bea7a66e24e9ebc5cc2nd <code class="module"><a href="/mod/mod_proxy_fcgi.html">mod_proxy_fcgi</a></code> has no provision for starting the
5a58787efeb02a1c3f06569d019ad81fd2efa06end application process; <code class="program"><a href="/programs/fcgistarter.html">fcgistarter</a></code> is provided
117c1f888a14e73cdd821dc6c23eb0411144a41cnd (on some platforms) for that purpose. Alternatively, external launching
117c1f888a14e73cdd821dc6c23eb0411144a41cnd or process management may be available in the FastCGI application
117c1f888a14e73cdd821dc6c23eb0411144a41cnd framework in use.</p>
117c1f888a14e73cdd821dc6c23eb0411144a41cnd <p>Do not enable proxying until you have <a href="mod_proxy.html#access">secured your server</a>. Open proxy
117c1f888a14e73cdd821dc6c23eb0411144a41cnd servers are dangerous both to your network and to the Internet at
117c1f888a14e73cdd821dc6c23eb0411144a41cnd large.</p>
117c1f888a14e73cdd821dc6c23eb0411144a41cnd<div id="quickview"><h3 class="directives">Directives</h3>
117c1f888a14e73cdd821dc6c23eb0411144a41cnd<p>This module provides no
117c1f888a14e73cdd821dc6c23eb0411144a41cnd directives.</p>
117c1f888a14e73cdd821dc6c23eb0411144a41cnd<li><img alt="" src="/images/down.gif" /> <a href="#examples">Examples</a></li>
117c1f888a14e73cdd821dc6c23eb0411144a41cnd<li><img alt="" src="/images/down.gif" /> <a href="#env">Environment Variables</a></li>
5a58787efeb02a1c3f06569d019ad81fd2efa06end<li><code class="program"><a href="/programs/fcgistarter.html">fcgistarter</a></code></li>
5a58787efeb02a1c3f06569d019ad81fd2efa06end<li><code class="module"><a href="/mod/mod_proxy.html">mod_proxy</a></code></li>
5a58787efeb02a1c3f06569d019ad81fd2efa06end</ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
5a58787efeb02a1c3f06569d019ad81fd2efa06end<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
5a58787efeb02a1c3f06569d019ad81fd2efa06end <p>Remember, in order to make the following examples work, you have to
5a58787efeb02a1c3f06569d019ad81fd2efa06end 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>
5a58787efeb02a1c3f06569d019ad81fd2efa06end <div class="example"><h3>Single application instance</h3><pre class="prettyprint lang-config">ProxyPass /myapp/ fcgi://localhost:4000/</pre>
06ba4a61654b3763ad65f52283832ebf058fdf1cslive <p> <code class="module"><a href="/mod/mod_proxy_fcgi.html">mod_proxy_fcgi</a></code> disables connection reuse by
06ba4a61654b3763ad65f52283832ebf058fdf1cslive default, so after a request has been completed the connection will NOT be
06ba4a61654b3763ad65f52283832ebf058fdf1cslive held open by that httpd child process and won't be reused. If the
9b6a3a558cc90ffdaa0b50bd02546ffec424ded7slive FastCGI application is able to handle concurrent connections
97a9a944b5887e91042b019776c41d5dd74557aferikabele from httpd, you can opt-in to connection reuse as shown in the following
9b6a3a558cc90ffdaa0b50bd02546ffec424ded7slive example:</p>
06ba4a61654b3763ad65f52283832ebf058fdf1cslive <div class="example"><h3>Single application instance, connection reuse</h3><pre class="prettyprint lang-config">ProxyPass /myapp/ fcgi://localhost:4000/ enablereuse=on</pre>
06ba4a61654b3763ad65f52283832ebf058fdf1cslive <p> The following example passes the request URI as a filesystem
06ba4a61654b3763ad65f52283832ebf058fdf1cslive path for the PHP-FPM daemon to run. The request URL is implicitly added
92510838f2eb125726e15c5eb4f7a23c7a0396e4slive to the 2nd parameter. The hostname and port following fcgi:// are where
97a9a944b5887e91042b019776c41d5dd74557aferikabele PHP-FPM is listening. Connection pooling is enabled.</p>
92510838f2eb125726e15c5eb4f7a23c7a0396e4slive <div class="example"><h3>PHP-FPM</h3><pre class="prettyprint lang-config">ProxyPassMatch ^/myapp/.*\.php(/.*)?$ fcgi://localhost:9000/var/www/ enablereuse=on</pre>
9b6a3a558cc90ffdaa0b50bd02546ffec424ded7slive <p> The following example passes the request URI as a filesystem
9b6a3a558cc90ffdaa0b50bd02546ffec424ded7slive path for the PHP-FPM daemon to run. In this case, PHP-FPM is listening on
92510838f2eb125726e15c5eb4f7a23c7a0396e4slive a unix domain socket (UDS). Requires 2.4.9 or later. With this syntax,
92510838f2eb125726e15c5eb4f7a23c7a0396e4slive the hostname and optional port following fcgi:// are ignored.</p>
97a9a944b5887e91042b019776c41d5dd74557aferikabele <div class="example"><h3>PHP-FPM with UDS</h3><pre class="prettyprint lang-config"> # UDS does not currently support connection reuse
92510838f2eb125726e15c5eb4f7a23c7a0396e4slive ProxyPassMatch ^/(.*\.php(/.*)?)$ "unix:/var/run/php5-fpm.sock|fcgi://localhost/var/www/"</pre>
97a9a944b5887e91042b019776c41d5dd74557aferikabele <p>The balanced gateway needs <code class="module"><a href="/mod/mod_proxy_balancer.html">mod_proxy_balancer</a></code> and
97a9a944b5887e91042b019776c41d5dd74557aferikabele at least one load balancer algorithm module, such as
92510838f2eb125726e15c5eb4f7a23c7a0396e4slive <code class="module"><a href="/mod/mod_lbmethod_byrequests.html">mod_lbmethod_byrequests</a></code>, in addition to the proxy
92510838f2eb125726e15c5eb4f7a23c7a0396e4slive modules listed above. <code class="module"><a href="/mod/mod_lbmethod_byrequests.html">mod_lbmethod_byrequests</a></code> is the
97a9a944b5887e91042b019776c41d5dd74557aferikabele default, and will be used for this example configuration.</p>
ea8a727ff298d2f5368b55b7ae8d87091ae106e7nd <div class="example"><h3>Balanced gateway to multiple application instances</h3><pre class="prettyprint lang-config">ProxyPass /myapp/ balancer://myappcluster/
ea8a727ff298d2f5368b55b7ae8d87091ae106e7nd<Proxy balancer://myappcluster/>
ea8a727ff298d2f5368b55b7ae8d87091ae106e7nd BalancerMember fcgi://localhost:4000
ea8a727ff298d2f5368b55b7ae8d87091ae106e7nd BalancerMember fcgi://localhost:4001
ea8a727ff298d2f5368b55b7ae8d87091ae106e7nd</Proxy></pre>
ea8a727ff298d2f5368b55b7ae8d87091ae106e7nd <p>You can also force a request to be handled as a reverse-proxy
06ba4a61654b3763ad65f52283832ebf058fdf1cslive request, by creating a suitable Handler pass-through. The example
e8d485701957d5c6de870111c112e168a894d49and configuration below will pass all requests for PHP scripts to the
e8d485701957d5c6de870111c112e168a894d49and specified FastCGI server using reverse proxy.
e8d485701957d5c6de870111c112e168a894d49and This feature is available in Apache HTTP Server 2.4.10 and later. For performance
9b6a3a558cc90ffdaa0b50bd02546ffec424ded7slive reasons, you will want to define a <a href="mod_proxy.html#workers">worker</a>
9b6a3a558cc90ffdaa0b50bd02546ffec424ded7slive representing the same fcgi:// backend. The benefit of this form is that it
9b6a3a558cc90ffdaa0b50bd02546ffec424ded7slive allows the normal mapping of URI to filename to occur in the server, and the
9b6a3a558cc90ffdaa0b50bd02546ffec424ded7slive local filesystem result is passed to the backend. When FastCGI is
9b6a3a558cc90ffdaa0b50bd02546ffec424ded7slive configured this way, the server can calculate the most accurate
97a9a944b5887e91042b019776c41d5dd74557aferikabele <div class="example"><h3>Proxy via Handler</h3><pre class="prettyprint lang-config"><FilesMatch \.php$>
9b6a3a558cc90ffdaa0b50bd02546ffec424ded7slive # Note: The only part that varies is /path/to/app.sock
9b6a3a558cc90ffdaa0b50bd02546ffec424ded7slive SetHandler "proxy:unix:/path/to/app.sock|fcgi://localhost/"
5a58787efeb02a1c3f06569d019ad81fd2efa06end</FilesMatch>
5a58787efeb02a1c3f06569d019ad81fd2efa06end # Define a matching worker.
5a58787efeb02a1c3f06569d019ad81fd2efa06end # The part that is matched to the SetHandler is the part that
5a58787efeb02a1c3f06569d019ad81fd2efa06end # follows the pipe. If you need to distinguish, "localhost; can
5a58787efeb02a1c3f06569d019ad81fd2efa06end # be anything unique.
5a58787efeb02a1c3f06569d019ad81fd2efa06end <Proxy fcgi://localhost/ enablereuse=on max=10>
behaviour of <code class="module"><a href="/mod/mod_proxy.html">mod_proxy</a></code>, there are a number of
<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
If instead you need <code class="module"><a href="/mod/mod_proxy_fcgi.html">mod_proxy_fcgi</a></code> to generate
<p><span>Available Languages: </span><a href="/en/mod/mod_proxy_fcgi.html" title="English"> en </a></p>
</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&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>
var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_proxy_fcgi.html';
if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
d.write('<div id="comments_thread"><\/div>');
var s = d.createElement('script');
s.type = 'text/javascript';
s.async = true;
s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
(d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
<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>
<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[//><!--