Extension:AdminWhiteList

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manualManual:Extensions
Crystal Clear action run.png
AdminWhiteList

Release status:Extension status stable

ImplementationTemplate:Extension#type User access, User rights
DescriptionTemplate:Extension#description This extension adds certain users to the groups 'sysop' and 'bureaucrat' when they log in. This is useful for LDAP-based wiki authentication when you need to define which users must be "administrators". Array defined in LocalSettings.
Author(s)Template:Extension#username Nino Dafonte, José M. Ciges
MediaWikiTemplate:Extension#mediawiki Working in MW 1.14
LicenseTemplate:Extension#license No license specified
Download the code
ParametersTemplate:Extension#parameters

$wgAdminWhiteList

Hooks usedTemplate:Extension#hook
UserLoadAfterLoadFromSessionManual:Hooks/UserLoadAfterLoadFromSession

Translate the AdminWhiteList extension if it is available at translatewiki.net

Check usage and version matrix.

Description[edit]

This extension adds 'sysop' and 'bureaucrat' permissions (to give administrator rights) to certain logged-in users for private wikis with authentication based on an external source, eg. LDAP.

You must define an array in LocalSettings.php with the usernames you want to be included in the 'sysop' and 'bureaucrat' groups. When the user logs in, the extension compares the username with the names in the array and, if the username is in the array, the user is automatically added to both groups.

Installation[edit]

  • Copy AdminWhiteList.php and place the file(s) in a directory called AdminWhiteList in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
require_once "$IP/extensions/AdminWhiteList/AdminWhiteList.php";
$wgAdminWhiteList = array("username1", "username2", "username3"); //Usernames to automatically be given sysop and bureaucrat permissions
  • YesY Done - Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Debugging options[edit]

You can use the variable $wgAdminWhiteListDebug for getting debug output. The following values are available:

  • 1 will show non-sensitive info
  • 2 will show possibly sensitive user info
  • 3 will show sensitive system info. Setting this on a live public site is probably a bad idea.

The value by default is 0, i.e. no debug output at all.

Specifying the debug file[edit]

By default the debug messages will be written in the file specified in the variable $wgDebugLogFile.

If you want to specify a log file for this extension (what I recommend) you should use the array $wgDebugLogGroups with the key "adminwhitelist".

For example:

$wgDebugLogGroups["adminwhitelist"] = "/tmp/adminwhitelist.log";

Change log[edit]

9 October 2009(2009-10-09)

Code[edit]

The last version, 1.1, is here.

You can download also version 1.0 (for MediaWiki 1.12) here.