[Bps-public-commit] r10892 - in RT-BugTracker-Public: etc

[ruz at bestpractical.com]

Author: ruz
Date: Wed Feb 20 06:36:08 2008
New Revision: 10892

Modified:
   RT-BugTracker-Public/etc/RT_SiteConfig.pm
   RT-BugTracker-Public/lib/RT/BugTracker/Public.pm

Log:
* update docs

Modified: RT-BugTracker-Public/etc/RT_SiteConfig.pm
==============================================================================
--- RT-BugTracker-Public/etc/RT_SiteConfig.pm	(original)
+++ RT-BugTracker-Public/etc/RT_SiteConfig.pm	Wed Feb 20 06:36:08 2008
@@ -1,5 +1,8 @@
+# Read more about options in lib/RT/BugTracker/Public.pm
+
 Set($WebNoAuthRegex, qr!^(?:/+NoAuth/|
                             /+Public/|
                             /+REST/\d+\.\d+/NoAuth/)!x );
 
 Set($WebPublicUser, 'public');
+

Modified: RT-BugTracker-Public/lib/RT/BugTracker/Public.pm
==============================================================================
--- RT-BugTracker-Public/lib/RT/BugTracker/Public.pm	(original)
+++ RT-BugTracker-Public/lib/RT/BugTracker/Public.pm	Wed Feb 20 06:36:08 2008
@@ -57,8 +57,26 @@
 
 =head1 CONFIGURATION
 
+You can find F<local/etc/BugTracker-Public/RT_SiteConfig.pm> with example of
+configuration and sane defaults. Add require in the main F<RT_SiteConfig.pm> or
+define options there.
+
+=head2 NoAuthRegexp
+
+As public shouldn't require authentication then you should add '/Public/' path
+to NoAuthRegexp option, something like:
+
+    Set($WebNoAuthRegex, qr!^(?:/+NoAuth/|
+                                /+Public/|
+                                /+REST/\d+\.\d+/NoAuth/)!x );
+
+Note that if you have multiple extensions that want to change this option then
+you have to merge them manually into one perl regular expression.
+
+=head2 WebPublicUser
+
 Make sure to create the public user in your RT system and add the line below
-to your RT_SiteConfig.pm.
+to your F<RT_SiteConfig.pm>.
 
     Set( $WebPublicUser, 'guest' );