Updated Catalyst.pm to preload more modules, needed for sane PAR support

[catagits/Catalyst-Runtime.git] / lib / Catalyst / Engine / FastCGI.pm

diff --git a/lib/Catalyst/Engine/FastCGI.pm b/lib/Catalyst/Engine/FastCGI.pm
index d1fd5f3..2eb34cd 100644 (file)
--- a/lib/Catalyst/Engine/FastCGI.pm
+++ b/lib/Catalyst/Engine/FastCGI.pm
@@ -2,7 +2,8 @@ package Catalyst::Engine::FastCGI;
 
 use strict;
 use base 'Catalyst::Engine::CGI';
-use FCGI;
+eval "use FCGI";
+die "Please install FCGI\n" if $@;
 
 =head1 NAME
 
@@ -37,6 +38,7 @@ Options may also be specified;
                   interrupted by Ctrl+C
   nproc           Specify a number of processes for
                   FCGI::ProcManager
+  pidfile         Specify a filename for the pid file
 
 =cut
 
@@ -62,23 +64,32 @@ sub run {
 
     $options ||= {};
 
+    my %env;
+
     my $request =
-      FCGI::Request( \*STDIN, \*STDOUT, \*STDERR, \%ENV, $sock,
+      FCGI::Request( \*STDIN, \*STDOUT, \*STDERR, \%env, $sock,
         ( $options->{nointr} ? 0 : &FCGI::FAIL_ACCEPT_ON_INTR ),
       );
 
     my $proc_manager;
 
-    if ( $listen and ( $options->{nproc} || 1 ) > 1 ) {
+    if ($listen) {
         require FCGI::ProcManager;
+        $options->{nproc} ||= 1;
+
         $proc_manager =
           FCGI::ProcManager->new( { n_processes => $options->{nproc} } );
+
+        if ( $options->{pidfile} ) {
+            $proc_manager->pm_write_pid_file( $options->{pidfile} );
+        }
+
         $proc_manager->pm_manage();
     }
 
     while ( $request->Accept >= 0 ) {
         $proc_manager && $proc_manager->pm_pre_dispatch();
-        $class->handle_request;
+        $class->handle_request( env => \%env );
         $proc_manager && $proc_manager->pm_pre_dispatch();
     }
 }
@@ -100,8 +111,95 @@ sub write {
     *STDOUT->syswrite($buffer);
 }
 
+1;
+__END__
+
 =back
 
+=head1 WEB SERVER CONFIGURATIONS
+
+=head2 Apache 1.x, 2.x
+
+Apache requires the mod_fastcgi module.  The following config will let Apache
+control the running of your FastCGI processes.
+
+    # Launch the FastCGI processes
+    FastCgiIpcDir /tmp
+    FastCgiServer /var/www/MyApp/script/myapp_fastcgi.pl -idle-timeout 300 -processes 5
+    
+    <VirtualHost *>
+        ScriptAlias / /var/www/MyApp/script/myapp_fastcgi.pl/
+    </VirtualHost>
+    
+You can also tell Apache to connect to an external FastCGI server:
+
+    # Start the external server (requires FCGI::ProcManager)
+    $ script/myapp_fastcgi.pl -l /tmp/myapp.socket -n 5
+    
+    # Note that the path used in FastCgiExternalServer can be any path
+    FastCgiIpcDir /tmp
+    FastCgiExternalServer /tmp/myapp_fastcgi.pl -socket /tmp/myapp.socket
+    
+    <VirtualHost *>
+        ScriptAlias / /tmp/myapp_fastcgi.pl/
+    </VirtualHost>
+    
+For more information on using FastCGI under Apache, visit
+L<http://www.fastcgi.com/mod_fastcgi/docs/mod_fastcgi.html>
+
+=head2 Lighttpd
+
+This configuration was tested with Lighttpd 1.4.7.
+
+    server.document-root = "/var/www/MyApp/root"
+    
+    fastcgi.server = (
+        "" => (
+            "MyApp" => (
+                "socket"       => "/tmp/myapp.socket",
+                "check-local"  => "disable",
+                "bin-path"     => "/var/www/MyApp/script/myapp_fastcgi.pl",
+                "min-procs"    => 2,
+                "max-procs"    => 5,
+                "idle-timeout" => 20
+            )
+        )
+    )
+    
+You can also run your application at any non-root location.
+
+    fastcgi.server = (
+        "/myapp" => (
+            "MyApp" => (
+                # same as above
+            )
+        )
+    )
+    
+You can also use an external server:
+
+    # Start the external server (requires FCGI::ProcManager)
+    $ script/myapp_fastcgi.pl -l /tmp/myapp.socket -n 5
+
+    server.document-root = "/var/www/MyApp/root"
+
+    fastcgi.server = (
+        "" => (
+            "MyApp" => (
+                "socket"      => "/tmp/myapp.socket",
+                "check-local" => "disable"
+            )
+        )
+    )
+
+For more information on using FastCGI under Lighttpd, visit
+L<http://www.lighttpd.net/documentation/fastcgi.html>
+
+=head2 IIS
+
+It is possible to run Catalyst under IIS with FastCGI, but we do not
+yet have detailed instructions.
+
 =head1 SEE ALSO
 
 L<Catalyst>, L<FCGI>.
@@ -120,5 +218,3 @@ This program is free software, you can redistribute it and/or modify it under
 the same terms as Perl itself.
 
 =cut
-
-1;