LdapContribAdminPlugin

An admin panel for viewing and changing the LdapContrib database.

Introduction

LdapContribGuiPlugin provides a GUI to administer the LDAP database created by TWiki:Plugins/LdapContrib.

The admin navigates the admin panel by using JQuery making AJAX calls over the REST architecture. TWiki:Plugins/JQueryPlugin needs to be installed.

Usage

Place the %LDAPCONTRIBADMIN% variable in a topic. This will expand the admin panel.

Features

• 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, if its available.

Examples

Installation Instructions

• For an automated installation, run the configure script and follow "Find More Extensions" in the in the Extensions section.
  • See the installation supplement on TWiki.org for more information.

• Or, follow these manual installation steps:
  • Download the ZIP file from the extension home on twiki.org (see below).
  • Unzip LdapContribAdminPlugin.zip in your twiki installation directory.
  • Set the ownership of the extracted directories and files to the webserver user.
  • Install the dependencies (if any).

• Plugin configuration and testing:
  • Run the configure script and enable the plugin in the Plugins section.
  • Configure additional plugin settings in the Extensions section if needed.
  • Test if the installation was successful using the examples provided.

Manifest

File	Description
data/TWiki/LdapContribAdminPlugin.txt	This documentation topic
lib/TWiki/Plugins/LdapContribAdminPlugin.pm	Perl module for the admin panel
pub/TWiki/LdapContribAdminPlugin/gfx/choice-no.gif	Icon used by the admin panel
pub/TWiki/LdapContribAdminPlugin/gfx/edittopic.gif	Icon used by the admin panel
pub/TWiki/LdapContribAdminPlugin/gfx/choice-yes.gif	Icon used by the admin panel
pub/TWiki/LdapContribAdminPlugin/gfx/led-cup-yellow.gif	Icon used by the admin panel
pub/TWiki/LdapContribAdminPlugin/gfx/close.gif	Icon used by the admin panel
pub/TWiki/LdapContribAdminPlugin/gfx/led-cup-green.gif	Icon used by the admin panel
pub/TWiki/LdapContribAdminPlugin/gfx/led-cup-red.gif	Icon used by the admin panel
pub/TWiki/LdapContribAdminPlugin/gfx/spinner.gif	Icon used by the admin panel
/pub/TWiki/LdapContribAdminPlugin/LdapContribAdminPlugin.js	The JavaScript for making AJAX calls over REST to the LdapContribAdminPlugin.pm backend.
/pub/TWiki/LdapContribAdminPlugin/LdapContribAdminGroupSearch.jpg	Screenshot of the admin panel
/pub/TWiki/LdapContribAdminPlugin/LdapContribAdminPlugin.css	CSS for the admin panel
/pub/TWiki/LdapContribAdminPlugin/LdapContribAdminStats.jpg	Screenshot of the admin panel
/pub/TWiki/LdapContribAdminPlugin/LdapContribAdminUserSearch.jpg	Screenshot of the admin panel

Plugin Info

Many thanks to the following sponsors for supporting this work:

• CERN

Plugin Author(s):	TWiki:Main.TerjeAndersen
Copyright:	© CERN 2014
License:	GPL (Gnu General Public License)
Plugin Version:	27464 (2014-05-21)
Change History:
2014-05-21	TWikibug:Item7499: Creating the plug-in -- TWiki:Main.TerjeAndersen
Dependencies:	Name Version Description TWiki::Contrib::LdapContrib >=4.38 Features implemented in LdapContrib version 4.38. TWiki::Plugins::JQueryPlugin ? JQueryPlugin needed to navigate the admin panel. TWiki::Plugins::JqPlotPlugin ? Optional - do display graph on the statistics section of the admin panel.
Plugin Home:	http://twiki.org/cgi-bin/view/Plugins/LdapContribAdminPlugin
Feedback:	http://twiki.org/cgi-bin/view/Plugins/LdapContribAdminPluginDev
Appraisal:	http://twiki.org/cgi-bin/view/Plugins/LdapContribAdminPluginAppraisal

Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences