AddDBMGroupPlugin

This is a plugin you can use to have new users automatically added to one or more groups stored in a DBM file. Apache can use these files for access control.

Syntax Rules

None.

Examples

None.

Plugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %ADDDBMGROUPPLUGIN_SHORTDESCRIPTION%

Note: Until GROUP_FILE is set, this plugin is effectively disabled.

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = This plugin can be used to add a user's name to an Apache group when DBM files are being used for access control.

• The full path to the DBM file that holds the group database:
  • Set GROUP_FILE =

• A comma-separated list of Perl modules to try when opening the DB file. The default (which is the same as in Apache's dbmmanage script) handles all of the common cases.
  • Set DBM_MODULES = DB_File, NDBM_File, GDBM_File, SDBM_File

• The group or groups to which new users will automatically be added. The value USER! is special; it will be replaced with the user's WikiName.
  • Set WIKI_GROUP = USER!, wikiusers

• Debug plugin: (See output in data/debug.txt)
  • Set DEBUG = 0

Plugin Installation Instructions

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the server where TWiki is running.

• Download the ZIP file from the Plugin web (see below)
• Unzip AddDBMGroupPlugin.zip in your twiki installation directory. Content:

  File:	Description:
  data/TWiki/AddDBMGroupPlugin.txt	Plugin topic
  data/TWiki/AddDBMGroupPlugin.txt,v	Plugin topic repository
  lib/TWiki/Plugins/AddDBMGroupPlugin.pm	Plugin Perl module

• Edit AddDBMGroupPlugin to configure the plugin settings
• Register a new user and verify that they've been added to the correct group(s). Check data/warning.txt for clues about any failures.

Plugin Info

Plugin Author:	TWiki:Main/CloyceSpradling
Plugin Version:	02 Jan 2005 (V1.000)
Change History:
02 Jan 2005:	Initial version
TWiki Dependency:	$TWiki::Plugins::VERSION 1.024
CPAN Dependencies:	none
Other Dependencies:	none
Perl Version:	5.005
TWiki:Plugins/Benchmark:	GoodStyle 99%, FormattedSearch 99%, AddDBMGroupPlugin 98%
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/AddDBMGroupPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/AddDBMGroupPluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/AddDBMGroupPluginAppraisal

Related Topics: TWikiPreferences, TWikiPlugins

-- TWiki:Main/CloyceSpradling - 02 Jan 2005