MediaWiki

Extension:GlobalBlocking

Translate this page
Languages:
MediaWiki extensions manual
GlobalBlocking
Release status: stable
Implementation Special page , User identity , API , Database
Description Allows IP addresses and accounts to be blocked on multiple wikis
Author(s) Andrew Garrett, Trust and Safety Product Team, Dreamy Jazz
Compatibility policy Snapshots releases along with MediaWiki. Master is not backward compatible.
Database changes Yes
Virtual domain virtual-globalblocking
Tables globalblocks
global_block_whitelist
License GNU General Public License 2.0 or later
Download
Download extension
Git [?]:
Parameters
  • $wgGlobalBlockingMassGlobalBlockMaxTargets
  • $wgGlobalBlockRemoteReasonUrl
  • $wgGlobalBlockingAllowedRanges
  • $wgGlobalBlockingMaximumIPsToRetroactivelyAutoblock
  • $wgApplyGlobalBlocks
  • $wgGlobalBlockingBlockXFF
  • $wgGlobalBlockingCentralWikiContentLanguage
  • $wgGlobalBlockingAutoblockExpiry
  • $wgGlobalBlockingEnableAutoblocks
  • $wgGlobalBlockingCentralWiki
  • $wgGlobalBlockingHideAutoblocksInGlobalBlocksAPIResponse
  • $wgGlobalBlockingCIDRLimit
Added rights
  • globalblock
  • globalblock-whitelist
  • globalblock-exempt
Hooks used
Hooks provided
Quarterly downloads 99 (Ranked 58th)
Public wikis using 1,015 (Ranked 250th)
Translate the GlobalBlocking extension if it is available at translatewiki.net
Vagrant role globalblocking
Issues Open tasks · Report a bug

The GlobalBlocking extension allows a user with the appropriate permissions to block an IP address, IP address range, or an account (but not accounts before MediaWiki 1.43) on all wikis in a group sharing the same globalblocking database. It is intended to be used for combating severe cross-wiki vandalism and spam.

Installation

  • Download and move the extracted GlobalBlocking 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/GlobalBlocking
  • Add the following code at the bottom of your LocalSettings.php file: 
    wfLoadExtension( 'GlobalBlocking' );
  • You will also need to create a dedicated database for this extension to work. At a minimum (all wikis running on the same host), you need to create a local database for the global tables. Usually this database is named globalblocking, but you can choose a different name. For example, on WMF wikis this table is on a database named centralauth.
  • Grant all database users that your wikis run as full permissions on the database created in the above step (at a minimum, SELECT, UPDATE, INSERT, DELETE).
  • Do either of the following depending on the version of MediaWiki you are running:
    • If you run MediaWiki 1.42 or above, define the configuration $wgDatabaseVirtualDomains['virtual-globalblocking'] = 'globalblocking'; (replacing globalblocking with the name of the database created in the steps above). See Manual:$wgVirtualDomainsMapping for more detail on how this configuration value works.
    • If you run MediaWiki 1.41 or below, define the configuration $wgGlobalBlockingDatabase = 'dbname'; where dbname is replaced with the name of the database you created in the steps above. If you called your database globalblocking then you can skip this step.
  • Do either of the following depending on the version of MediaWiki you are using:
    • If you run MediaWiki 1.44 or newer, then run update.php on one wiki which will create the tables in the database you defined in the steps above.
    • If you run MediaWiki 1.43 or below, after creating the database, you should import the SQL from tables-generated-globalblocks.sql into the global blocking database.
  • You also need to run update.php on each of your local databases to add the local tables needed by the extension.
  •   Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration

Config variable Description
$wgApplyGlobalBlocks Whether to respect global blocks on this wiki. This is used so that global blocks can be set on one wiki, but not actually applied there (i.e. so people can contest them on that wiki).
$wgGlobalBlockingBlockXFF The flag $wgGlobalBlockingBlockXFF, set to true by default, causes blocks to apply to all of the IP addresses in the X-Forwarded-For (XFF) header. Set this flag to false to disable this feature. For more details, see task T25343.
$wgGlobalBlockingCIDRLimit Largest global rangeblocks allowed, set by CIDR prefix. The format is the same as $wgBlockCIDRLimit and the default values are /16 for IPv4 and /19 for IPv6, as with $wgBlockCIDRLimit.
$wgGlobalBlockingDatabase
MediaWiki version:
≤ 1.41
The name of the database used to store the globalblocks table. This table is on a different database because only one table is used for all wikis in a wiki farm.
$wgGlobalBlockRemoteReasonUrl Full path to api.php to use to expand templates in block reasons.
$wgGlobalBlockingAllowedRanges A list of ranges or IP addresses which are exempted from all global blocks which target the ranges or IP addresses. This exemption does not apply to global account blocks (even if the user is on an exempt range or IP address).
$wgGlobalBlockingCentralWiki The ID of the central wiki where global blocks are performed. Used to provide a link to the global block log which is likely to have entries, instead of the local log which is unlikely to contain entries. If the value is false, then the local log is used.
$wgGlobalBlockingMaximumIPsToRetroactivelyAutoblock
MediaWiki version:
≥ 1.43
The maximum number of IP addresses that can be retroactively autoblocked when a user is globally blocked and global autoblocking has been enabled for the global block.
$wgGlobalBlockingMassGlobalBlockMaxTargets
MediaWiki version:
≥ 1.44
The maximum number of targets that can be globally blocked or unblocked in one use of Special:MassGlobalBlock.

API

Two API modules are provided, one to (un)block users, and another to view existing global blocks. They are documented at Extension:GlobalBlocking/API.

Usage

Globally (un)blocking

The following requires appropriate permissions, assigned by default to stewards, which by default can be added or removed by bureaucrats.

GlobalBlock

To make a global block:

  1. Go to Special:GlobalBlock.
  2. Enter the target you want to block. This can be an account post MediaWiki 1.43, an IPv4 address or range up to $wgGlobalBlockingCIDRLimit (by default /16, and also /16 hardcoded before that variable was introduced), or any IPv6 address or range up to $wgGlobalBlockingCIDRLimit (by default /19; /4 before that variable was introduced).
  3. You may decide you want to only block anonymous users, which can only be done for blocks on IPv4 or IPv6 addresses. To only block anonymous users, check the checkbox.
  4. Submit the form. The target of the block is now globally blocked on your wikis that opt in to the global blocking. Account creation is blocked (even if you selected "anonymous users only": phab:T42190), and the blocked user cannot edit any associated user talk pages on any wiki affected and opted in to the global block. If Extension:AbuseFilter is installed, globally blocked IP addresses are prohibited from viewing the abuse log if the particular wiki is opted in to the block.
GlobalUnblock

To remove a global block:

  1. Go to Special:GlobalUnblock and click "Remove a global block".
  2. Enter the target of the block you want to remove and the reason, and submit the form. The account, IP address, or IP range will no longer be globally blocked.
MassGlobalBock
MediaWiki version:
≥ 1.44

You can remove, modify, and create global blocks using Special:MassGlobalBock for many targets at once. The first step of this form is to lookup the global block status of a list of targets provided in an input. Then you can use the form to globally block or globally unblock, with the relevant parameters applied to each target.

Local status

Administrators can disable the global block on the wiki where they have administrator rights. This is done through using the Special:GlobalBlockStatus page.

See also

Retrieved from "https://www.mediawiki.org/w/index.php?title=Extension:GlobalBlocking&oldid=6895756"