Extension:GroupWhitelist

File:Wikiteq - logo.png

<translate> This extension is professionally maintained by the WikiTeq team.</translate>

<translate> WikiTeq provides official support for [[<tvar name=1>Special:MyLanguage/Version lifecycle</tvar>|MediaWiki LTS releases only]].</translate> <translate> It may work with other MediaWiki releases.</translate>

MediaWiki extensions manual

File:OOjs UI icon advanced-invert.svg GroupWhitelist Release status: stable
Implementation	User rights
Description	Allows to override per page permissions based on a whitelist
Author(s)	WikiWorks team
Maintainer(s)	WikiTeq team
Compatibility policy	For every MediaWiki release that is a Long Term Support release there is a corresponding branch in the extension.
MediaWiki	1.31+
License	GNU General Public License 2.0 or later
Download	<translate> Download extension</translate> <translate> Git</translate> [?]: <translate> Download Git master</translate> <translate> browse repository</translate> (GitHub) <translate> commit history</translate> <translate> repository contributors (GitHub)</translate> <translate> code review</translate> README
Parameters $wgGroupWhitelistSourcePage $wgGroupWhitelistAPIAllow $wgGroupWhitelistRights $wgGroupWhitelistGroup
Hooks used UserGetRights getUserPermissionsErrors
Quarterly downloads
Public wikis using
Translate the GroupWhitelist extension if it is available at translatewiki.net
Issues	Open tasks · Report a bug

The extension allows to grant users from selected group with a special per-page rights specifying affected pages list on a regular wiki page.

This extension was created for WikiWorks.

Installation

• <translate> [[<tvar name=2>Special:ExtensionDistributor/GroupWhitelist</tvar>|Download]] and move the extracted <tvar name=name>GroupWhitelist</tvar> folder to your <tvar name=ext>extensions/</tvar> directory.</translate>
  <translate> Developers and code contributors should install the extension [[<tvar name=git>Special:MyLanguage/Download from Git</tvar>|from Git]] instead, using:</translate>cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/GroupWhitelist
• <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar> file:</translate>

  wfLoadExtension( 'GroupWhitelist' );
  

• File:OOjs UI icon check-constructive.svg <translate> Done</translate> – <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>

Configuration parameters

• $wgGroupWhitelistRights - A list of actions to be allowed
• $wgGroupWhitelistGroup - A group affected by the extension
• $wgGroupWhitelistSourcePage - A page to look for list of whitelisted pages
• $wgGroupWhitelistAPIAllow - API modules to be always granted with the right

The default configuration is:

$wgGroupWhitelistRights = [ 'edit' ];
$wgGroupWhitelistGroup = 'user';
$wgGroupWhitelistSourcePage = 'Mediawiki:Whitelist';
$wgGroupWhitelistAPIAllow = [];

and the Mediawiki:Whitelist contents could be:

* SomePage1
// Comments are allowed
* SomePage2
* SomaPage3

The settings above allow users from a `user` group to `edit` pages specified in the `Mediawiki:Whitelist` page contents (`SomePage1`, `SomePage2`, `SomePage3`).

File:OOjs UI icon notice-destructive.svg <translate> Warning:</translate>

This extension will also add $wgGroupWhitelistRights to the API for requests coming from 127.0.0.1 regardless of user

See also

• Extension:InternalWhitelist - A similar extension that only allows whitelisting pages for reading by anonymous users.