Issue tracker: #GlobalBlocking

Extension:GlobalBlocking

From Linux Web Expert

MediaWiki extensions manual
File:OOjs UI icon advanced.svg
GlobalBlocking
Release status: beta
File:Global block interface (2021-04-29).png
Implementation Special page , User identity , API
Description Allows IP addresses to be blocked on multiple wikis
Author(s) Andrew Garrett (Werdnatalk)
MediaWiki 1.13-alpha and later
Database changes Yes
Tables globalblocks
global_block_whitelist
License GNU General Public License 2.0 or later
Download
<translate> Download extension</translate>
<translate> Git</translate> [?]:
Parameters
  • $wgApplyGlobalBlocks
  • $wgGlobalBlockingBlockXFF
  • $wgGlobalBlockingAllowedRanges
  • $wgGlobalBlockRemoteReasonUrl
  • $wgGlobalBlockingAllowGlobalAccountBlocks
  • $wgGlobalBlockingCIDRLimit
Added rights
  • globalblock
  • globalblock-whitelist
  • globalblock-exempt
Hooks used
Hooks provided
Quarterly downloads Lua error in Module:Extension at line 172: bad argument #1 to 'inNamespace' (unrecognized namespace name 'skin').
Public wikis using Lua error in Module:Extension at line 172: bad argument #1 to 'inNamespace' (unrecognized namespace name 'skin').
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 or IP address range (but not accounts) 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

  • <translate> [[<tvar name=2>Special:ExtensionDistributor/GlobalBlocking</tvar>|Download]] and move the extracted <tvar name=name>GlobalBlocking</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/GlobalBlocking
  • <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar> file:</translate> 
    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.
  • 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, or otherwise import the SQL schema in tables-generated-global_block_whitelist.sql to them.
  • 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

$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 <translate> task <tvar name=1>T25343</tvar></translate>.
$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.
<td class="mw-version-versionbox" title="<translate nowrap> MediaWiki <tvar name=1>1.41</tvar> is stable version</translate>">
<translate> ≤</translate> 1.41
<translate> MediaWiki version:</translate>
$wgGlobalBlockingDatabase
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.

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

The following requires appropriate permissions, assigned by default to stewards, which by default can be added or removed by bureaucrats. To make a global block:

  1. Go to Special:GlobalBlock.
  2. Enter the IPv4 address or range up to $wgGlobalBlockingCIDRLimit (by default /16, and also /16 hardcoded before that variable was introduced) that you wish to block (or any IPv6 address or range up to $wgGlobalBlockingCIDRLimit (by default /19; /4 before that variable was introduced) if you made the schema changes prescribed in the installation instructions section of this page or you have the latest revision), and decide if you want to only block anonymous users. To only block anonymous users, check the checkbox.
  3. Submit the form. The IP address or range 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 IP or range 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.

To remove a global block:

  1. Go to Special:GlobalUnblock and click "Remove a global block".
  2. Enter the IP address or range to unblock and the reason, and submit the form. The IP address or range will no longer be globally blocked.

See also

Retrieved from "https://www.linuxwebexpert.com/wiki/index.php?title=Extension:GlobalBlocking&oldid=5606"