Jump to content

Extension:MultiPurge

From mediawiki.org
MediaWiki extensions manual
MultiPurge
Release status: stable
Implementation Page action , Special page
Description Allows purging of pages for multiple services in a defined order.
Author(s) Octfxtalk
Latest version 1.1.1 (2023-01-29)
MediaWiki 1.39+
PHP >=8.0
Composer octfx/multipurge
License GNU General Public License 2.0 or later
Download
  • $wgMultiPurgeCloudFlareZoneId
  • $wgMultiPurgeServiceOrder
  • $wgMultiPurgeVarnishServers
  • $wgMultiPurgeEnabledServices
  • $wgMultiPurgeCloudFlareApiToken
  • $wgMultiPurgeStaticPurges
  • $wgMultiPurgeRunInQueue

The MultiPurge extension allows the purging of pages from multiple caches in a defined order. It was developed to allow the use-case of first purging data from a varnish cache, and then from CloudFlare.

Special page

[edit]

MultiPurge adds a special page for sysops which allows purging of load.php URLs.

The page can be found at Special:PurgeResources.

Only users with editinterface permissions can access this page.

The page works by requesting the actual HTML output of a given title, and parsing all load.php calls.

All found links can then be selected to be purged.

Installation

[edit]
  • Download and place the file(s) in a directory called MultiPurge in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php file:
    wfLoadExtension( 'MultiPurge' );
    
  • Configure as required.
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration

[edit]

Usage and configuration information can be found in the README.md file in the extension's repository.

Variable Default Value Type Description
$wgMultiPurgeCloudFlareZoneId null String Zone ID the Wiki Domain is contained in
$wgMultiPurgeCloudFlareApiToken null String API Token found in your dashboard
$wgMultiPurgeVarnishServers null String/Array Array of URLs pointing to your Varnish Servers. Can be IPs
$wgMultiPurgeEnabledServices null Array List of enabled services. Possible values are 'Cloudflare', 'Varnish'
$wgMultiPurgeServiceOrder null Array List of service purge order. Possible values are 'Cloudflare', 'Varnish'. Example: ['Varnish', 'Cloudflare'] purges varnish, then cloudflare