Extension:MaintenanceShell
 | Please expand this page. |
 | This extension mocks a command line environment, it does not actually execute scripts from the command line. There may be unexpected results due to this fact. Use at your own risk. If you can, you should execute maintenance scripts from the command line instead. Please report any unexpected results on talk page. |
 Release status: experimental |
|
|---|---|
 |
|
| Implementation | Special page |
| Description | Provides access to the maintenance scripts via a special page. |
| Author(s) | |
| Latest version | 0.5.0 |
| MediaWiki | >= 1.37.0 |
| License | GNU General Public License 2.0 or later |
| Download | |
|
|
| Quarterly downloads | 24 (Ranked 142nd) |
| Translate the MaintenanceShell extension if it is available at translatewiki.net | |
| Issues | 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
MaintenanceShellin yourextensions/folder. - Add the following code at the bottom of your LocalSettings.php file:
wfLoadExtension( 'MaintenanceShell' );
- Configure the user rights and grant yourself access to that group from a bureaucrat account.
Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
To users running MediaWiki 1.24 or earlier:
The instructions above describe the new way of installing this extension using wfLoadExtension().
If you need to install this extension on these earlier versions (MediaWiki 1.24 and earlier), instead of wfLoadExtension( 'MaintenanceShell' );, you need to use:
require_once "$IP/extensions/MaintenanceShell/MaintenanceShell.php";
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]
| Do not grant rights to the MaintenanceShell lightly. Maintenance scripts are powerful tools which can have a significant impact on your wiki. They are implemented as command line scripts instead of Special pages because they are irreversible and leave no trace. |
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