phpbb: Add some module documentation.

[matthijs/projects/wipi.git] / conf / auth / phpbb.py

diff --git a/conf/auth/phpbb.py b/conf/auth/phpbb.py
index 0558d53aa443791d876a6eff4b84f43ce53c2d56..aa38df625a85a30a261183aa04c9b26227737270 100644 (file)
--- a/conf/auth/phpbb.py
+++ b/conf/auth/phpbb.py
@@ -4,6 +4,21 @@
 
     @copyright: 2008 Matthijs Kooijman
     @license: GNU GPL, see COPYING for details.
+
+    This plugin allows authentication (use accounts and password) and
+    authorization (use groups) against a phpbb Mysql database.
+
+    To use this plugin, you should put it in a place where the config python
+    file can "see" it (somewhere in your pythonpath, or in the same dir as the
+    config file). Then import the setup function and call it.
+
+    For example:
+
+    class FarmConfig:
+        import phpbb
+        (phpbb_auth, phpbb_groups) = phpbb.setup(...)
+        auth = [phpbb_auth]
+        groups = phpbb_groups
 """
 
 import MySQLdb