1 package Catalyst::Engine::FastCGI;
4 use base 'Catalyst::Engine::CGI';
6 die "Please install FCGI\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;
26 /path listen via Unix sockets on /path
27 :port listen via TCP on port on all interfaces
28 hostname:port listen via TCP on port bound to hostname
30 Options may also be specified;
33 leave_umask Set to 1 to disable setting umask to 0
35 nointr Do not allow the listener to be
37 nproc Specify a number of processes for
39 pidfile Specify a filename for the pid file
40 manager Specify a FCGI::ProcManager sub-class
41 detach Detach from console
46 my ( $self, $class, $listen, $options ) = @_;
50 my $old_umask = umask;
51 unless ( $options->{leave_umask} ) {
54 $sock = FCGI::OpenSocket( $listen, 100 )
55 or die "failed to open FastCGI socket; $!";
56 unless ( $options->{leave_umask} ) {
60 elsif ( $^O ne 'MSWin32' ) {
62 or die "STDIN is not a socket; specify a listen location";
70 FCGI::Request( \*STDIN, \*STDOUT, \*STDERR, \%env, $sock,
71 ( $options->{nointr} ? 0 : &FCGI::FAIL_ACCEPT_ON_INTR ),
77 $options->{manager} ||= "FCGI::ProcManager";
78 $options->{nproc} ||= 1;
80 $self->daemon_fork() if $options->{detach};
82 if ( $options->{manager} ) {
83 eval "use $options->{manager}; 1" or die $@;
85 $proc_manager = $options->{manager}->new(
87 n_processes => $options->{nproc},
88 pid_fname => $options->{pidfile},
92 # detach *before* the ProcManager inits
93 $self->daemon_detach() if $options->{detach};
95 $proc_manager->pm_manage();
97 elsif ( $options->{detach} ) {
98 $self->daemon_detach();
102 while ( $request->Accept >= 0 ) {
103 $proc_manager && $proc_manager->pm_pre_dispatch();
104 $class->handle_request( env => \%env );
105 $proc_manager && $proc_manager->pm_post_dispatch();
109 =head2 $self->write($c, $buffer)
114 my ( $self, $c, $buffer ) = @_;
116 unless ( $self->{_prepared_write} ) {
117 $self->prepare_write($c);
118 $self->{_prepared_write} = 1;
121 # FastCGI does not stream data properly if using 'print $handle',
122 # but a syswrite appears to work properly.
123 *STDOUT->syswrite($buffer);
126 =head2 $self->daemon_fork()
128 Performs the first part of daemon initialisation. Specifically,
129 forking. STDERR, etc are still connected to a terminal.
138 =head2 $self->daemon_detach( )
140 Performs the second part of daemon initialisation. Specifically,
141 disassociates from the terminal.
143 However, this does B<not> change the current working directory to "/",
144 as normal daemons do. It also does not close all open file
145 descriptors (except STDIN, STDOUT and STDERR, which are re-opened from
152 print "FastCGI daemon started (pid $$)\n";
153 open STDIN, "+</dev/null" or die $!;
154 open STDOUT, ">&STDIN" or die $!;
155 open STDERR, ">&STDIN" or die $!;
162 =head1 WEB SERVER CONFIGURATIONS
164 =head2 Standalone FastCGI Server
166 In server mode the application runs as a standalone server and accepts
167 connections from a web server. The application can be on the same machine as
168 the web server, on a remote machine, or even on multiple remote machines.
169 Advantages of this method include running the Catalyst application as a
170 different user than the web server, and the ability to set up a scalable
173 To start your application in server mode, install the FCGI::ProcManager
174 module and then use the included fastcgi.pl script.
176 $ script/myapp_fastcgi.pl -l /tmp/myapp.socket -n 5
178 Command line options for fastcgi.pl include:
180 -d -daemon Daemonize the server.
181 -p -pidfile Write a pidfile with the pid of the process manager.
182 -l -listen Listen on a socket path, hostname:port, or :port.
183 -n -nproc The number of processes started to handle requests.
185 See below for the specific web server configurations for using the external
188 =head2 Apache 1.x, 2.x
190 Apache requires the mod_fastcgi module. The same module supports both
193 There are three ways to run your application under FastCGI on Apache: server,
196 =head3 Standalone server mode
198 FastCgiExternalServer /tmp/myapp -socket /tmp/myapp.socket
199 Alias /myapp/ /tmp/myapp/
201 # Or, run at the root
204 # Optionally, rewrite the path when accessed without a trailing slash
205 RewriteRule ^/myapp$ myapp/ [R]
207 The FastCgiExternalServer directive tells Apache that when serving /tmp/myapp
208 to use the FastCGI application listenting on the socket /tmp/mapp.socket.
209 Note that /tmp/myapp does not need to exist -- it's a virtual file name.
211 It's likely that Apache is not configured to serve files in /tmp, so the
212 Alias directive maps the url path /myapp/ to the (virtual) file that runs the
213 FastCGI application. The trailing slashes are important as their use will
214 correctly set the PATH_INFO environment variable used by Catalyst to
215 determine the request path. If you would like to be able to access your app
216 without a trailing slash (http://server/myapp), you can use the above
217 RewriteRule directive.
221 The term 'static' is misleading, but in static mode Apache uses its own
222 FastCGI Process Manager to start the application processes. This happens at
223 Apache startup time. In this case you do not run your application's
224 fastcgi.pl script -- that is done by Apache. Apache then maps URIs to the
225 FastCGI script to run your application.
227 FastCgiServer /path/to/myapp/script/myapp_fastcgi.pl -processes 3
228 Alias /myapp/ /path/to/myapp/script/myapp_fastcgi.pl/
230 FastCgiServer tells Apache to start three processes of your application at
231 startup. The Alias command maps a path to the FastCGI application. Again,
232 the trailing slashes are important.
236 In FastCGI dynamic mode, Apache will run your application on demand,
237 typically by requesting a file with a specific extension (e.g. .fcgi). ISPs
238 often use this type of setup to provide FastCGI support to many customers.
240 In this mode it is often enough to place or link your *_fastcgi.pl script in
241 your cgi-bin directory with the extension of .fcgi. In dynamic mode Apache
242 must be able to run your application as a CGI script so ExecCGI must be
243 enabled for the directory.
245 AddHandler fastcgi-script .fcgi
247 The above tells Apache to run any .fcgi file as a FastCGI application.
249 Here is a complete example:
252 ServerName www.myapp.com
253 DocumentRoot /path/to/MyApp
255 # Allow CGI script to run
256 <Directory /path/to/MyApp>
260 # Tell Apache this is a FastCGI application
261 <Files myapp_fastcgi.pl>
262 SetHandler fastcgi-script
266 Then a request for /script/myapp_fastcgi.pl will run the
269 For more information on using FastCGI under Apache, visit
270 L<http://www.fastcgi.com/mod_fastcgi/docs/mod_fastcgi.html>
274 These configurations were tested with Lighttpd 1.4.7.
276 =head3 Standalone server mode
278 server.document-root = "/var/www/MyApp/root"
283 "socket" => "/tmp/myapp.socket",
284 "check-local" => "disable"
291 server.document-root = "/var/www/MyApp/root"
296 "socket" => "/tmp/myapp.socket",
297 "check-local" => "disable",
298 "bin-path" => "/var/www/MyApp/script/myapp_fastcgi.pl",
306 Note that in newer versions of lighttpd, the min-procs and idle-timeout
307 values are disabled. The above example would start 5 processes.
309 =head3 Non-root configuration
311 You can also run your application at any non-root location with either of the
322 For more information on using FastCGI under Lighttpd, visit
323 L<http://www.lighttpd.net/documentation/fastcgi.html>
327 It is possible to run Catalyst under IIS with FastCGI, but we do not
328 yet have detailed instructions.
332 L<Catalyst>, L<FCGI>.
336 Sebastian Riedel, <sri@cpan.org>
338 Christian Hansen, <ch@ngmedia.com>
340 Andy Grundman, <andy@hybridized.org>
344 Bill Moseley, for documentation updates and testing.
348 This program is free software, you can redistribute it and/or modify it under
349 the same terms as Perl itself.