From: Matthijs Kooijman Date: Fri, 2 Jul 2010 15:02:36 +0000 (+0200) Subject: phpbb: Add some module documentation. X-Git-Url: https://git.stderr.nl/gitweb?a=commitdiff_plain;h=8610da3615f7d43ded326d74fc76b28c04d3aae0;p=matthijs%2Fprojects%2Fwipi.git phpbb: Add some module documentation. --- diff --git a/conf/auth/phpbb.py b/conf/auth/phpbb.py index 0558d53..aa38df6 100644 --- 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