Extension:AutoModerator

MediaWiki extensions manual
AutoModerator
Release status: unstable
Description Enables community-configured reversion of Machine Language-scored bad edits.
Author(s)
MediaWiki
License No license specified
Download
Help Help:Extension:AutoModerator
Translate the AutoModerator extension if it is available at translatewiki.net
Issues Open tasks · Report a bug

The AutoModerator extension is under development by the Moderator Tools team at the Wikimedia Foundation. Read more about the project goals, and provide feedback, at Automoderator.

Please see Extension:AutoModerator/Deploying for guidance on how to request Automoderator on your Wikimedia project.

Installation

edit
  • Download and move the extracted AutoModerator folder to your extensions/ directory.
    Developers and code contributors should install the extension from Git instead, using:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/AutoModerator
  • Add the following code at the bottom of your LocalSettings.php file:
    wfLoadExtension( 'AutoModerator' );
    
  •   Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration

edit

Internal configuration

edit

These values are typically set in your LocalSettings.php for local development. The default values are shown here.

// Revert risk probability threshold; Edits scored above this value will be reverted.
$wgAutoModeratorRevertProbability = 0.99;
// Username for AutoModerator system account.
$wgAutoModeratorUsername = 'AutoModerator';
// Database id of project used to target liftwing lang parameter. (eg. 'enwiki'). If not set, it'll use database name.
$wgAutoModeratorWikiId = null;
// If set to false, on-wiki configuration will be ignored.
$wgAutoModeratorEnableWikiConfig = true;

On-wiki configuration

edit

To configure AutoModerator on a wiki, including enabling it to run, local configuration must also be completed at MediaWiki:AutoModeratorConfig.json. For now, this must be done by directly editing the page, but in the future will incorporate Community configuration for ease of configuring.

You'll need the editsitejson right to edit MediaWiki:AutoModeratorConfig.json, which is held by interface-admin and sysop groups on most wikis. You can check Special:ListGroupRights on your wiki to be sure. If you wish to further limit editing, you may use page protection to do so.

Config Description Allowed values Default if omitted
AutoModeratorEnableRevisionCheck Enables or disables AutoModerator. If set to true, AutoModerator will begin running immediately after the page is saved. AutoModerator can be immediately disabled by setting this value to false. true or false false
AutoModeratorFalsePositivePageTitle The title of the page where people will go to report false positive reverts. A string or a null if no false positive page exists. null
AutoModeratorSkipUserGroups An array of trusted user groups whose revisions will not be checked by AutoModerator. An array of strings that contains the user group names.
[ "bot", "sysop" ]
AutoModeratorUseEditFlagMinor Boolean that enables the minor edit flag for all AutoModerator edits. true or false false

Example MediaWiki:AutoModeratorConfig.json

edit

This example enables revision checks (and potential reverts) and explicitly sets the edit summary to the default value.

{
    "AutoModeratorEnableRevisionCheck": true,
    "AutoModeratorFalsePositivePageTitle": "Wikipedia:Automoderator False Positive Reporting",
    "AutoModeratorSkipUserGroups": [ "bot", "sysop" ],
    "AutoModeratorUseEditFlagMinor" : true,
}