Extension:MaintenanceShell

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manualManual:Extensions
Crystal Clear action run.png
MaintenanceShell

Release status:Extension status beta

MaintenanceShell-v0.4.0-screenshot.png
ImplementationTemplate:Extension#type Special page
DescriptionTemplate:Extension#description Provides access to the maintenance scripts via a special page.
Author(s)Template:Extension#username Andrew Fitzgerald
Timo Tijhof
Latest versionTemplate:Extension#version 0.5.0 (2014-04-01)
MediaWikiTemplate:Extension#mediawiki 1.21+
LicenseTemplate:Extension#license GNU General Public License 2.0 or later
Download
ParametersTemplate:Extension#parameters

$wgMaintenancePath

Added rightsTemplate:Extension#rights

maintenanceshell

Hooks usedTemplate:Extension#hook
UnitTestsListManual:Hooks/UnitTestsList

Translate the MaintenanceShell extension if it is available at translatewiki.net

Check usage and version matrix.

IssuesPhabricator

Open tasks · Report a bug

The MaintenanceShell extension provides access to the maintenance scripts via a Special Page.

Installation[edit]

  • Download and place the file(s) in a directory called MaintenanceShell in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
require_once "$IP/extensions/MaintenanceShell/MaintenanceShell.php";
  • Configure the user rights and grant yourself access to that group from a bureaucrat account.
  • YesY Done - Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration[edit]

Parameters[edit]

$wgMaintenanceShellPath
By default the extension lists maintenance scripts of MediaWiki core. Change this path to a different directory if you'd like to list different scripts instead (of a certain extension for example).

User rights[edit]

maintenanceshell
This right (for security reasons not assigned to any group by default) grants the right to use Special:MaintenanceShell.
// Grant access to Special:MaintenanceShell to the "developer" user group:
$wgGroupPermissions['developer']['maintenanceshell'] = true;

# Or

// Create a new "maintenanceshell" user group for Special:MaintenanceShell:
$wgGroupPermissions['maintenanceshell']['maintenanceshell'] = true;

Usage[edit]

Go to page Special:MaintenanceShell

Change log[edit]

See the page containing the change log.

See also[edit]

  • Extension:GoToShell — a much simpler shell extension that only launches one command specified in a configuration setting