Fixed run-on sentence in COPYRIGHT and s/program/library/
[catagits/Catalyst-Runtime.git] / lib / Catalyst / Engine / FastCGI.pm
index 85dee52..d8f21dd 100644 (file)
@@ -220,6 +220,12 @@ sub _fix_env
     my $self = shift;
     my $env = shift;
 
+    # we are gonna add variables from current system environment %ENV to %env 
+    # that contains at this moment just variables taken from FastCGI request
+    foreach my $k (keys(%ENV)) {
+      $env->{$k} = $ENV{$k} unless defined($env->{$k});
+    }
+
     return unless ( $env->{SERVER_SOFTWARE} );
 
     # If we're running under Lighttpd, swap PATH_INFO and SCRIPT_NAME
@@ -228,8 +234,8 @@ sub _fix_env
     if ( $env->{SERVER_SOFTWARE} =~ /lighttpd/ ) {
         $env->{PATH_INFO} ||= delete $env->{SCRIPT_NAME};
     }
-    # Fix the environment variables PATH_INFO and SCRIPT_NAME when running under IIS 6.0
-    elsif ( $env->{SERVER_SOFTWARE} =~ /IIS\/6.0/ ) {
+    # Fix the environment variables PATH_INFO and SCRIPT_NAME when running under IIS
+    elsif ( $env->{SERVER_SOFTWARE} =~ /IIS\/[67].0/ ) {
         my @script_name = split(m!/!, $env->{PATH_INFO});
         my @path_translated = split(m!/|\\\\?!, $env->{PATH_TRANSLATED});
         my @path_info;
@@ -297,9 +303,9 @@ static, and dynamic.
 
 The FastCgiExternalServer directive tells Apache that when serving
 /tmp/myapp to use the FastCGI application listenting on the socket
-/tmp/mapp.socket.  Note that /tmp/myapp.fcgi does not need to exist --
+/tmp/mapp.socket.  Note that /tmp/myapp.fcgi B<MUST NOT> exist --
 it's a virtual file name.  With some versions of C<mod_fastcgi> or
-C<mod_fcgid>, you can use any name you like, but most require that the
+C<mod_fcgid>, you can use any name you like, but some require that the
 virtual filename end in C<.fcgi>.
 
 It's likely that Apache is not configured to serve files in /tmp, so the 
@@ -427,10 +433,134 @@ above modes.  Note the required mod_rewrite rule.
 For more information on using FastCGI under Lighttpd, visit
 L<http://www.lighttpd.net/documentation/fastcgi.html>
 
-=head2 IIS
+=head2 Microsoft IIS
+
+It is possible to run Catalyst under IIS with FastCGI, but only on IIS 6.0 
+(Microsoft Windows 2003), IIS 7.0 (Microsoft Windows 2008 and Vista) and
+hopefully its successors.
+
+Even if it is declared that FastCGI is supported on IIS 5.1 (Windows XP) it 
+does not support some features (specifically: wildcard mappings) that prevents
+running Catalyst application.
+
+Let us assume that our server has the following layout:
+
+    d:\WWW\WebApp\                   path to our Catalyst application
+    d:\strawberry\perl\bin\perl.exe  path to perl interpreter (with Catalyst installed)
+    c:\windows                       Windows directory
+
+=head3 Setup IIS 6.0 (Windows 2003)
+
+=over 4
+
+=item Install FastCGI extension for IIS 6.0
+
+FastCGI is not a standard part of IIS 6 - you have to install it separately. For
+more info and download go to L<http://www.iis.net/extensions/FastCGI>. Choose
+approptiate version (32-bit/64-bit), installation is quite simple 
+(in fact no questions, no options).
+
+=item Create a new website
+
+Open "Control Panel" > "Administrative Tools" > "Internet Information Services Manager". 
+Click "Action" > "New" > "Web Site". After you finish the installation wizard
+you need to go to the new website's properties. 
+
+=item Set website properties
+
+On tab "Web site" set proper values for: 
+Site Description, IP Address, TCP Port, SSL Port etc.
+
+On tab "Home Directory" set the following:
+
+    Local path: "d:\WWW\WebApp\root"
+    Local path permission flags: check only "Read" + "Log visits"
+    Execute permitions: "Scripts only"
+
+Click "Configuration" button (still on Home Directory tab) then click "Insert" 
+the wildcard application mapping and in the next dialog set:
+
+    Executable: "c:\windows\system32\inetsrv\fcgiext.dll"
+    Uncheck: "Verify that file exists"
+
+Close all dialogs with "OK".
+
+=item Edit fcgiext.ini
+
+Put the following lines into c:\windows\system32\inetsrv\fcgiext.ini (on 64-bit 
+system c:\windows\syswow64\inetsrv\fcgiext.ini):
+
+    [Types]
+    *:8=CatalystApp
+    ;replace 8 with the identification number of the newly created website
+    ;it is not so easy to get this number:
+    ; - you can use utility "c:\inetpub\adminscripts\adsutil.vbs"
+    ;   to list websites:   "cscript adsutil.vbs ENUM /P /W3SVC"
+    ;   to get site name:   "cscript adsutil.vbs GET /W3SVC/<number>/ServerComment"
+    ;   to get all details: "cscript adsutil.vbs GET /W3SVC/<number>"
+    ; - or look where are the logs located: 
+    ;   c:\WINDOWS\SYSTEM32\Logfiles\W3SVC7\whatever.log 
+    ;   means that the corresponding number is "7"
+    ;if you are running just one website using FastCGI you can use '*=CatalystApp'    
+
+    [CatalystApp]
+    ExePath=d:\strawberry\perl\bin\perl.exe
+    Arguments="d:\WWW\WebApp\script\webapp_fastcgi.pl -e"
 
-It is possible to run Catalyst under IIS with FastCGI, but we do not
-yet have detailed instructions.
+    ;by setting this you can instruct IIS to serve Catalyst static files 
+    ;directly not via FastCGI (in case of any problems try 1)
+    IgnoreExistingFiles=0
+        
+    ;do not be fooled by Microsoft doc talking about "IgnoreExistingDirectories"
+    ;that does not work and use "IgnoreDirectories" instead
+    IgnoreDirectories=1
+
+=back
+
+=head3 Setup IIS 7.0 (Windows 2008 and Vista)
+
+Microsoft IIS 7.0 has built-in support for FastCGI so you do not have to install
+any addons.
+
+=over 4
+
+=item Necessary steps during IIS7 installation
+
+During IIS7 installation after you have added role "Web Server (IIS)"
+you need to check to install role feature "CGI" (do not be nervous that it is 
+not FastCGI). If you already have IIS7 installed you can add "CGI" role feature 
+through "Control panel" > "Programs and Features". 
+
+=item Create a new website
+
+Open "Control Panel" > "Administrative Tools" > "Internet Information Services Manager" 
+> "Add Web Site".
+
+    site name: "CatalystSite"
+    content directory: "d:\WWW\WebApp\root" 
+    binding: set proper IP address, port etc.
+
+=item Configure FastCGI
+
+You can configure FastCGI extension using commandline utility 
+"c:\windows\system32\inetsrv\appcmd.exe"
+
+=over 4
+
+=item Configuring section "fastCgi" (it is a global setting)
+
+  appcmd.exe set config -section:system.webServer/fastCgi /+"[fullPath='d:\strawberry\perl\bin\perl.exe',arguments='d:\www\WebApp\script\webapp_fastcgi.pl -e',maxInstances='4',idleTimeout='300',activityTimeout='30',requestTimeout='90',instanceMaxRequests='1000',protocol='NamedPipe',flushNamedPipe='False']" /commit:apphost
+
+=item Configuring proper handler (it is a site related setting)
+
+  appcmd.exe set config "CatalystSite" -section:system.webServer/handlers /+"[name='CatalystFastCGI',path='*',verb='GET,HEAD,POST',modules='FastCgiModule',scriptProcessor='d:\strawberry\perl\bin\perl.exe|d:\www\WebApp\script\webapp_fastcgi.pl -e',resourceType='Unspecified',requireAccess='Script']" /commit:apphost
+
+Note: before launching the commands above do not forget to change site 
+name and paths to values relevant for your server setup.
+
+=back
+
+=back
 
 =head1 SEE ALSO
 
@@ -446,7 +576,7 @@ Bill Moseley, for documentation updates and testing.
 
 =head1 COPYRIGHT
 
-This program is free software, you can redistribute it and/or modify it under
+This library is free software. You can redistribute it and/or modify it under
 the same terms as Perl itself.
 
 =cut