Extension:MultiPurge

Category:Extensions without an imageCategory:Extensions without a compatibility policyCategory:GPL licensed extensions
MediaWiki extensions manual
MultiPurge
Release status: stableCategory:Stable extensions
Implementation Page action Category:Page action extensions, Special page Category:Special page extensions
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+Category:Extensions with manual MediaWiki version
PHP >=8.0
Composer octfx/multipurgeCategory:Extensions supporting Composer
License GNU General Public License 2.0 or later
Download

GitHub:

Note:
No localisation updates are
provided by translatewiki.net .

Category:Extensions in GitHub version control
Parameters
  • $wgMultiPurgeCloudFlareZoneId
  • $wgMultiPurgeServiceOrder
  • $wgMultiPurgeVarnishServers
  • $wgMultiPurgeEnabledServices
  • $wgMultiPurgeCloudFlareApiToken
  • $wgMultiPurgeStaticPurges
  • $wgMultiPurgeRunInQueue
Hooks used
Category:All extensions

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

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

  • 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

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

Variable Default Value Type Description
$wgMultiPurgeCloudFlareZoneIdnull String Zone ID the Wiki Domain is contained in
$wgMultiPurgeCloudFlareApiTokennull String API Token found in your dashboard
$wgMultiPurgeVarnishServersnull String/Array Array of URLs pointing to your Varnish Servers. Can be IPs
$wgMultiPurgeEnabledServicesnull Array List of enabled services. Possible values are 'Cloudflare', 'Varnish'
$wgMultiPurgeServiceOrdernull Array List of service purge order. Possible values are 'Cloudflare', 'Varnish'. Example: ['Varnish', 'Cloudflare'] purges varnish, then cloudflare
$wgMultiPurgeStaticPurgesnullString/Array Array of urls that can be purged using the special page. Key is displayed as the selection label. Example: ['Startup script' => 'load.php?lang=en&modules=startup&only=scripts&raw=1&skin=citizen', 'Site styles' => 'load.php?lang=en&modules=site.styles&only=styles&skin=citizen'].
$wgMultiPurgeRunInQueuefalseString Push purge jobs to the job queue instead of running it in sync.
Category:All extensions Category:ArticlePurge extensions Category:Extensions in GitHub version control Category:Extensions supporting Composer Category:Extensions with manual MediaWiki version Category:Extensions without a compatibility policy Category:Extensions without an image Category:GPL licensed extensions Category:LocalFilePurgeThumbnails extensions Category:Page action extensions Category:Special page extensions Category:Stable extensions