LdapContribGuiPlugin provides services to administer the LDAP cache created by TWiki:Plugins/LdapContrib, a BerkeleyDB v1 database created with the Perl module DB_File.

The topic requires the TWiki:Plugins/JQueryPlugin, TWiki:Plugins/JqPlotPlugin and TWiki:Plugins/LdapContrib.

LdapContrib cache admin panel

As of writing this, the services are present for members of the TWikiAdminGroup via the topic LdapContribAdmin.

The topic contains a single variable %LDAPCONTRIBADMIN% which is set via LdapContribGuiPlugin.pm given that:

  1. The plugin is enabled in configure.
  2. You are logged in.
  3. You are a member of TWikiAdminGroup.
  4. You are viewing the topic LdapContribAdmin.
Navigation in the admin panel is picked up by JQuery defined in LdapContribGuiPlugin.js, and any new content are fetched via AJAX served by LdapContribPlugin.pm over the REST architecture.


  • View all users, displaying stored LDAP DN, emails, WikiName, created date and update date for every user.
    • Using a built-in search box you can narrow the search by searching for both login names and WikiNames using a regular expression.
  • Change WikiName for users, allowing the WikiName you are changing to be preserved from being taken by other users.
  • Delete users.

  • View and delete ignored users and groups. These are groups that have been tried looked up in LDAP and which could not be found. The ignore lists prevents these entries to be looked up again to reduce the stress on the LDAP server.

  • View groups with it's users.
    • Only users which is present in the LdapContrib cache are shown, not showing members only present on the LDAP server.
  • Possibility to delete groups and it's user memberships (the users themselves are not touched by doing this).

  • An overview, showing the number of stored user accounts, groups, ignored users and groups, as well as a dump of the LdapContrib settings.
  • The overview also show's a graph displaying the number of user registrations per month through time. The graph is generated using TWiki:Plugins/JqPlotPlugin.

Further enhancements

As of writing this, I can envision the following features being implemented in the Plugin at a future date:

  • Possibility for users to change their own WikiName.

Plugin Installation Instructions

  • Run configure for automated install, or do a manual install:
  • Download the ZIP file from the Plugin web (see below)
  • Unzip LdapContribGuiPlugin.zip in your twiki installation directory. Content:
File: Description:
data/TWiki/LdapContribGuiPlugin.txt This topic
data/TWiki/LdapContribAdmin.txt The topic for the LdapContribGuiPlugin admin panel, entry point for administering the LdapContrib cache.
pub/TWiki/LdapContribAdmin/LdapContribAdmin.css CSS for LdapContribAdmin
pub/TWiki/LdapContribAdmin/LdapContribAdmin.js JavaScript for LdapContribAdmin using jQuery and jQplot
pub/TWiki/LdapContribAdmin/spinner.gif A simple spinner animation
lib/TWiki/Plugins/LdapContribGuiPlugin.pm The plugin, populating the %LDAPCONTRIBADMIN% variable. Provides a REST interface for the actions in the admin panel.

  • Optionally, run LdapContribGuiPlugin_installer.pl to automatically check and install other TWiki modules that this module depends on. You can also do this step manually.
  • Alternatively, manually make sure the dependencies listed in the table below are resolved.
  • Visit configure in your TWiki installation, and enable the plugin in the {Plugins} section.
  • Dependencies:


Plugin Info

This work was partly sponsored by

Plugin Author: TWiki:Main.TerjeAndersen
Copyright: 2013 TWiki:Main.TWikiContributors
License: GPL ( GNU General Public License)
Plugin Version: 2013-02-01
Change History:
2013-02-01: TWikibug:ItemXXXX: Initial release.
Perl Version: 5.8.8
TWiki:Plugins/Benchmark: GoodStyle nn%, FormattedSearch nn%, LdapContribGuiPlugin nn%
Plugin Home: TWiki:Plugins/LdapContribGuiPlugin
Feedback: TWiki:Plugins/LdapContribGuiPluginDev

Related Topics: LdapContrib

Edit | Attach | Watch | Print version | History: r2 < r1 | Backlinks | Raw View | WYSIWYG | More topic actions
Topic revision: r2 - 2014-05-07 - TerjeAndersen
    • Cern Search Icon Cern Search
    • TWiki Search Icon TWiki Search
    • Google Search Icon Google Search

    TWiki21Nov All webs login

This site is powered by the TWiki collaboration platform Powered by PerlCopyright & 2008-2022 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
or Ideas, requests, problems regarding TWiki? use Discourse or Send feedback