1 package Catalyst::Engine::FastCGI;
4 use base 'Catalyst::Engine::CGI';
6 die "Unable to load the FCGI module, you may need to install it:\n$@\n" if $@;
10 Catalyst::Engine::FastCGI - FastCGI Engine
14 This is the FastCGI engine.
16 =head1 OVERLOADED METHODS
18 This class overloads some methods from C<Catalyst::Engine::CGI>.
20 =head2 $self->run($c, $listen, { option => value, ... })
22 Starts the FastCGI server. If C<$listen> is set, then it specifies a
23 location to listen for FastCGI requests;
29 listen via Unix sockets on /path
33 listen via TCP on port on all interfaces
37 listen via TCP on port bound to hostname
41 Options may also be specified;
47 Set to 1 to disable setting umask to 0 for socket open =item nointr
49 Do not allow the listener to be interrupted by Ctrl+C
53 Specify a number of processes for FCGI::ProcManager
57 Specify a filename for the pid file
61 Specify a FCGI::ProcManager sub-class
69 Send STDERR to STDOUT instead of the webserver
76 my ( $self, $class, $listen, $options ) = @_;
80 my $old_umask = umask;
81 unless ( $options->{leave_umask} ) {
84 $sock = FCGI::OpenSocket( $listen, 100 )
85 or die "failed to open FastCGI socket; $!";
86 unless ( $options->{leave_umask} ) {
90 elsif ( $^O ne 'MSWin32' ) {
92 or die "STDIN is not a socket; specify a listen location";
98 my $error = \*STDERR; # send STDERR to the web server
99 $error = \*STDOUT # send STDERR to stdout (a logfile)
100 if $options->{keep_stderr}; # (if asked to)
103 FCGI::Request( \*STDIN, \*STDOUT, $error, \%env, $sock,
104 ( $options->{nointr} ? 0 : &FCGI::FAIL_ACCEPT_ON_INTR ),
110 $options->{manager} ||= "FCGI::ProcManager";
111 $options->{nproc} ||= 1;
113 $self->daemon_fork() if $options->{detach};
115 if ( $options->{manager} ) {
116 eval "use $options->{manager}; 1" or die $@;
118 $proc_manager = $options->{manager}->new(
120 n_processes => $options->{nproc},
121 pid_fname => $options->{pidfile},
125 # detach *before* the ProcManager inits
126 $self->daemon_detach() if $options->{detach};
128 $proc_manager->pm_manage();
130 elsif ( $options->{detach} ) {
131 $self->daemon_detach();
135 while ( $request->Accept >= 0 ) {
136 $proc_manager && $proc_manager->pm_pre_dispatch();
138 # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
139 # http://lists.rawmode.org/pipermail/catalyst/2006-June/008361.html
140 # Thanks to Mark Blythe for this fix
141 if ( $env{SERVER_SOFTWARE} && $env{SERVER_SOFTWARE} =~ /lighttpd/ ) {
142 $env{PATH_INFO} ||= delete $env{SCRIPT_NAME};
145 $class->handle_request( env => \%env );
147 $proc_manager && $proc_manager->pm_post_dispatch();
151 =head2 $self->write($c, $buffer)
156 my ( $self, $c, $buffer ) = @_;
158 unless ( $self->{_prepared_write} ) {
159 $self->prepare_write($c);
160 $self->{_prepared_write} = 1;
163 # FastCGI does not stream data properly if using 'print $handle',
164 # but a syswrite appears to work properly.
165 *STDOUT->syswrite($buffer);
168 =head2 $self->daemon_fork()
170 Performs the first part of daemon initialisation. Specifically,
171 forking. STDERR, etc are still connected to a terminal.
180 =head2 $self->daemon_detach( )
182 Performs the second part of daemon initialisation. Specifically,
183 disassociates from the terminal.
185 However, this does B<not> change the current working directory to "/",
186 as normal daemons do. It also does not close all open file
187 descriptors (except STDIN, STDOUT and STDERR, which are re-opened from
194 print "FastCGI daemon started (pid $$)\n";
195 open STDIN, "+</dev/null" or die $!;
196 open STDOUT, ">&STDIN" or die $!;
197 open STDERR, ">&STDIN" or die $!;
204 =head1 WEB SERVER CONFIGURATIONS
206 =head2 Standalone FastCGI Server
208 In server mode the application runs as a standalone server and accepts
209 connections from a web server. The application can be on the same machine as
210 the web server, on a remote machine, or even on multiple remote machines.
211 Advantages of this method include running the Catalyst application as a
212 different user than the web server, and the ability to set up a scalable
215 To start your application in server mode, install the FCGI::ProcManager
216 module and then use the included fastcgi.pl script.
218 $ script/myapp_fastcgi.pl -l /tmp/myapp.socket -n 5
220 Command line options for fastcgi.pl include:
222 -d -daemon Daemonize the server.
223 -p -pidfile Write a pidfile with the pid of the process manager.
224 -l -listen Listen on a socket path, hostname:port, or :port.
225 -n -nproc The number of processes started to handle requests.
227 See below for the specific web server configurations for using the external
230 =head2 Apache 1.x, 2.x
232 Apache requires the mod_fastcgi module. The same module supports both
235 There are three ways to run your application under FastCGI on Apache: server,
238 =head3 Standalone server mode
240 FastCgiExternalServer /tmp/myapp.fcgi -socket /tmp/myapp.socket
241 Alias /myapp/ /tmp/myapp/myapp.fcgi/
243 # Or, run at the root
244 Alias / /tmp/myapp.fcgi/
246 # Optionally, rewrite the path when accessed without a trailing slash
247 RewriteRule ^/myapp$ myapp/ [R]
250 The FastCgiExternalServer directive tells Apache that when serving
251 /tmp/myapp to use the FastCGI application listenting on the socket
252 /tmp/mapp.socket. Note that /tmp/myapp.fcgi does not need to exist --
253 it's a virtual file name. With some versions of C<mod_fastcgi> or
254 C<mod_fcgid>, you can use any name you like, but most require that the
255 virtual filename end in C<.fcgi>.
257 It's likely that Apache is not configured to serve files in /tmp, so the
258 Alias directive maps the url path /myapp/ to the (virtual) file that runs the
259 FastCGI application. The trailing slashes are important as their use will
260 correctly set the PATH_INFO environment variable used by Catalyst to
261 determine the request path. If you would like to be able to access your app
262 without a trailing slash (http://server/myapp), you can use the above
263 RewriteRule directive.
267 The term 'static' is misleading, but in static mode Apache uses its own
268 FastCGI Process Manager to start the application processes. This happens at
269 Apache startup time. In this case you do not run your application's
270 fastcgi.pl script -- that is done by Apache. Apache then maps URIs to the
271 FastCGI script to run your application.
273 FastCgiServer /path/to/myapp/script/myapp_fastcgi.pl -processes 3
274 Alias /myapp/ /path/to/myapp/script/myapp_fastcgi.pl/
276 FastCgiServer tells Apache to start three processes of your application at
277 startup. The Alias command maps a path to the FastCGI application. Again,
278 the trailing slashes are important.
282 In FastCGI dynamic mode, Apache will run your application on demand,
283 typically by requesting a file with a specific extension (e.g. .fcgi). ISPs
284 often use this type of setup to provide FastCGI support to many customers.
286 In this mode it is often enough to place or link your *_fastcgi.pl script in
287 your cgi-bin directory with the extension of .fcgi. In dynamic mode Apache
288 must be able to run your application as a CGI script so ExecCGI must be
289 enabled for the directory.
291 AddHandler fastcgi-script .fcgi
293 The above tells Apache to run any .fcgi file as a FastCGI application.
295 Here is a complete example:
298 ServerName www.myapp.com
299 DocumentRoot /path/to/MyApp
301 # Allow CGI script to run
302 <Directory /path/to/MyApp>
306 # Tell Apache this is a FastCGI application
307 <Files myapp_fastcgi.pl>
308 SetHandler fastcgi-script
312 Then a request for /script/myapp_fastcgi.pl will run the
315 For more information on using FastCGI under Apache, visit
316 L<http://www.fastcgi.com/mod_fastcgi/docs/mod_fastcgi.html>
320 These configurations were tested with Lighttpd 1.4.7.
322 =head3 Standalone server mode
324 server.document-root = "/var/www/MyApp/root"
329 "socket" => "/tmp/myapp.socket",
330 "check-local" => "disable"
337 server.document-root = "/var/www/MyApp/root"
342 "socket" => "/tmp/myapp.socket",
343 "check-local" => "disable",
344 "bin-path" => "/var/www/MyApp/script/myapp_fastcgi.pl",
352 Note that in newer versions of lighttpd, the min-procs and idle-timeout
353 values are disabled. The above example would start 5 processes.
355 =head3 Non-root configuration
357 You can also run your application at any non-root location with either of the
368 For more information on using FastCGI under Lighttpd, visit
369 L<http://www.lighttpd.net/documentation/fastcgi.html>
373 It is possible to run Catalyst under IIS with FastCGI, but we do not
374 yet have detailed instructions.
378 L<Catalyst>, L<FCGI>.
382 Sebastian Riedel, <sri@cpan.org>
384 Christian Hansen, <ch@ngmedia.com>
386 Andy Grundman, <andy@hybridized.org>
390 Bill Moseley, for documentation updates and testing.
394 This program is free software, you can redistribute it and/or modify it under
395 the same terms as Perl itself.