Jump to content

Extension:HostStats

From mediawiki.org
MediaWiki extensions manual
HostStats
Release status: stable
Implementation Special page
Description Provides a special page that outputs information about the wiki's host.
Author(s) Hydriztalk
Latest version 2.0.0 (2019-09-16)
MediaWiki 1.32+
PHP 7.0+
Database changes No
License GNU General Public License 3.0 or later
Download
README
CHANGELOG
$wgHostStatsCommands
hoststats
Quarterly downloads 1 (Ranked 132nd)
Translate the HostStats extension if it is available at translatewiki.net
Issues Open tasks · Report a bug

The HostStats extension implements a special page "Special:HostStats" that outputs information about the wiki's hosting server. The extension will run a set of commands based on the $wgHostStatsCommands parameter, which the output will be displayed as different sections in the "Special:HostStats" special page.

This extension, if misused, can potentially expose your server and put it at risk! Please use with extreme care and if in doubt, do not install.

Installation

  • Download and move the extracted HostStats 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/HostStats
  • Add the following code at the bottom of your LocalSettings.php file:
    wfLoadExtension( 'HostStats' );
    
  • Configure at your convenience
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration

Parameter

$wgHostStatsCommands

An array of commands to output. Since version 2.0.0 empty by default. Example:

$wgHostStatsCommands = [
	'hostname',
	'df -h'
];
This example only applies for unix users only. Windows users might need to change this accordingly.

User right

The user right "hoststats" will have to be set for an existing user group, e.g. "sysop" or preferably for a new user group:

$wgGroupPermissions['hoststats']['hoststats'] = true;
$wgGroupPermissions['sysop']['hoststats'] = true;