Skip to content

WikiTeq/mediawiki-extension-StatusCheck

Repository files navigation

The extension allows to perform on-site checks for various issues

Requirements

  • MediaWiki 1.39+

Installation

  • Clone the extension into the extensions directory
  • Add wfLoadExtension( 'StatusCheck' ); to the bottom of your settings file
  • Configure as required

Configuration

  • $wgStatusCheckEmailAddress - receiving email address for email function testing

Usage

  • Navigate to Special:StatusCheck
  • Use statuscheck API endpoint to run checks via API

Bundled checks

  • Stuck jobs - verifies if there are any jobs with an excessive number of attempts
  • File uploads - verifies that files can be uploaded, no file permissions errors in place
  • Email sending - verified that email can be sent ( it sends a real email to the address specified in the configuration )
  • Composer dependencies - verifies that lock file and dependencies are in sync ( e.g., to catch situations when the wiki was updated but composer packages were not )
  • Search engine check - verified that search works and can find some text from the wiki homepage

Permissions

  • status-check permission allows to use the API and perform checks via Special page, granted to sysop group by default

Development

  • src/Checks/BaseCheck.php - is the base abstract class for creating new Checks
  • src/ChecksRunner.php - class performs Checks runs
  • src/CheckResult.php - class represents result of running a single Check

See bundled checks to learn how to create new ones, e.g.: src/Checks/EmailSendCheck.php

About

Extension to check functionality of the wiki

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors