expand backend documentation
[perl/plp/.git] / PLP / Backend / Apache.pm
index 89e32c632a9dac5af972c02e72d722e40923ec8d..eb13d361e44f4f01656e53755e76833e1b7deee3 100644 (file)
@@ -92,33 +92,53 @@ Naturally, you'll need to enable I<mod_perl>:
 
     apache-modconf apache enable mod_perl
 
-Setup F<httpd.conf> (often just create a F</etc/apache2/conf.d/plp>) with:
+Setup F<httpd.conf> (in new installs just create F</etc/apache/conf.d/plp>) with:
 
     <IfModule mod_perl.c>
         <Files *.plp>
             SetHandler perl-script
             PerlHandler PLP::Backend::Apache
             PerlSendHeader On
-            PerlSetVar PLPcache On
         </Files>
     </IfModule>
 
 =head1 DESCRIPTION
 
-=head2 PerlSetVar configuration directives
+=head2 Configuration directives
+
+PLP behaviour can be configured by B<PerlSetVar> rules.
+These can be added to a F<.htaccess> file or most any scope of server
+configuration.  For example, to disable caching for a specific site:
+
+       <Directory /var/www/somesite/>
+               PerlSetVar PLPcache Off
+       </Directory>
 
 =over 16
 
 =item PLPcache
 
-Sets caching B<On>/B<Off>. When caching, PLP saves your script in memory and
-doesn't re-read and re-parse it if it hasn't changed. PLP will use more memory,
+Sets caching B<On>/B<Off>.
+When caching, PLP saves your script in memory and doesn't re-read
+and re-parse it if it hasn't changed. PLP will use more memory,
 but will also run 50% faster.
 
 B<On> is default, anything that isn't =~ /^off$/i is considered On.
 
 =back
 
+=head1 BUGS
+
+With mod_perlB<2>, any new request will change the cwd for all processes.
+This means that if you're running files from multiple directories,
+you I<should not use the current path> for it may change at any time.
+
+The bug has been confirmed with at least mod_perl 2.0.2/3/4 on Apache 2.2.3/8.
+Using this backend on Apache2 is extremely discouraged until this is fixed.
+Instead, L<the FastCGI backend|PLP::Backend::FastCGI> is recommended.
+
+Apache1 does not show any problems.
+
 =head1 AUTHOR
 
 Mischa POSLAWSKY <perl@shiar.org>