[Bps-public-commit] r10886 - in RT-BugTracker-Public: .

[ruz at bestpractical.com]

Author: ruz
Date: Tue Feb 19 14:08:19 2008
New Revision: 10886

Removed:
   RT-BugTracker-Public/notes
Modified:
   RT-BugTracker-Public/lib/RT/BugTracker/Public.pm

Log:
* move notes into POD

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	Tue Feb 19 14:08:19 2008
@@ -45,16 +45,39 @@
 # those contributions and any derivatives thereof.
 # 
 # END BPS TAGGED BLOCK }}}
-=head1 COPYRIGHT
+package RT::BugTracker::Public;
 
-This extension is Copyright (C) 2005 Best Practical Solutions, LLC.
+our $VERSION = '0.01';
 
-It is freely redistributable under the terms of version 2 of the GNU GPL.
+1;
 
-=cut
+=head1 NAME
 
-package RT::BugTracker::Public;
+RT::BugTracker::Public - Adds a public, (hopefully) userfriendly bug tracking UI to RT
 
-our $VERSION = '0.01';
+=head1 CONFIGURATION
 
-1;
+Make sure to create the public user in your RT system and add the line below
+to your RT_SiteConfig.pm.
+
+    Set( $WebPublicUser, 'guest' );
+
+If you didn't name your public user 'guest', then change accordingly.
+
+The public user should probably be unprivileged and have the following rights
+
+    CreateTicket
+    ModifyCustomField
+    ReplyToTicket
+    SeeCustomField
+    SeeQueue
+    ShowTicket
+
+If you want the public UI to do anything useful. It should NOT have the
+ModifySelf right.
+
+=head1 AUTHOR
+
+Thomas Sibley E<lt>trs at bestpractical.comE<gt>
+
+=cut