move detailed setup documentation to interface modules

[perl/plp/.git] / PLP / FastCGI.pm

diff --git a/PLP/FastCGI.pm b/PLP/FastCGI.pm
index e16fbcbb940cca4cefea975dcd2fa0f0260e3e77..7db729697ad23c0c12de6acf5fb8864b21ddfc32 100644 (file)
--- a/PLP/FastCGI.pm
+++ b/PLP/FastCGI.pm
@@ -20,3 +20,50 @@ sub import {
 
 1;
 
+=head1 NAME
+
+PLP::FastCGI - FastCGI interface for PLP
+
+=head1 SYNOPSIS
+
+=head2 Lighttpd
+
+Edit the configuration file (usually F</etc/lighttpd/lighttpd.conf>)
+to enable I<mod_fastcgi> (add/outcomment in server.modules), and add:
+
+    fastcgi.server = (
+        ".plp" => ((
+            "bin-path" => "/usr/bin/perl -MPLP::FastCGI",
+            "socket" => "/tmp/fcgi-plp.socket",
+        )),
+    )
+
+=head2 Apache
+
+You'll need a dispatch script (F<plp.fcgi> is included with PLP).
+Example F</foo/bar/plp.fcgi>:
+
+    #!/usr/bin/perl
+    use PLP::FastCGI;
+
+Then enable either I<mod_fastcgi> or I<mod_fcgid>, and setup F<httpd.conf>
+(often just create a F</etc/apache2/conf.d/plp>) with:
+
+    <IfModule mod_fastcgi.c>
+        AddHandler fastcgi-script plp
+        FastCgiWrapper /foo/bar/plp.fcgi
+    </IfModule>
+
+    <IfModule mod_fcgid.c>
+        AddHandler fcgid-script plp
+        FCGIWrapper /foo/bar/plp.fcgi .plp
+    </IfModule>
+
+=head1 AUTHOR
+
+Mischa POSLAWSKY <perl@shiar.org>
+
+=head1 SEE ALSO
+
+L<PLP|PLP>, L<PLP::CGI|PLP::CGI>, L<FCGI|FCGI>
+