Extension:MaintenanceShell
From MediaWiki.org
 Release status: beta |
|||
|---|---|---|---|
 |
|||
| Implementation | Special page | ||
| Description | Provides access to the maintenance scripts via a special page. | ||
| Author(s) | SwiftlyTilting (FrantikTalk) | ||
| Last Version | 0.2.2 (01:13, 19 June 2009 (UTC)) | ||
| MediaWiki | Tested on 1.14. and 1.13, should work with lower versions as well | ||
| License | GNU GPL | ||
| Download | MaintenanceShell.v0.2.2.zip | ||
|
|||
|
|||
|
check usage (experimental) |
|||
MaintenanceShell provides access to the Maintenance scripts via a Special Page.
Maintenance scripts are powerful tools which can have a significant impact on your wiki. Many of them require users to have access to the file system. Do not grant rights to the MaintenanceShell lightly.
Contents |
[edit] Usage
- Chose the script from the list.
- Fill in the command line settings as if you were typing the commands via a terminal shell.
- Submit the form.
[edit] Working directories
The default working directory for the maintenance scripts is yourwikidir/maintenance/ . You may override this value using $wgMaintenanceShellDir.
# Default settings $wgMaintenanceShellDir = "$IP/maintenance/";
You may also use the magic word {{ROOT}} in the command line area. It will be replaced with the full path to the root folder of the web server.
Default folder of the MaintenanceShell script:
{{ROOT}}/w/extensions/MaintenanceShell/
[edit] Downloads
- MaintenanceShell 0.2.2 - 01:13, 19 June 2009 (UTC)
- MaintenanceShell 0.2.1 - 02:56, 2 June 2009 (UTC)
- MaintenanceShell 0.2.0 - 13:29, 30 May 2009 (UTC)
- MaintenanceShell 0.1.0 - 16:11, 29 May 2009 (UTC)
[edit] Installation
To install this extension:
- Download the installation package.
- Unzip and place all files in yourwikidir/extensions/MaintenanceShell/.
- Add the following to LocalSettings.php:
# Sysops will have access to the MaintenanceShell $wgGroupPermissions['sysop']['maintenanceshell'] = true; #Place this on the VERY LAST line of your Localsettings.php file: require_once("$IP/extensions/MaintenanceShell/MaintenanceShell.php");
Note: The require_once line MUST be the last line of your Localsettings.php to ensure all settings are loaded when the MaintenanceShell is run.
[edit] User rights
MaintenanceShell adds a new user right called maintenanceshell, which a user must be granted before they can access the MaintenanceShell page. You may add the right to an existing group, or assign it to a new group and add users to that group. Place the following code in Localsettings.php:
Existing group:
$wgGroupPermissions['sysop']['maintenanceshell'] = true;
New user group:
$wgGroupPermissions['maintainer']['maintenanceshell'] = true;
[edit] Change Log
[edit] v0.2.2
- Included support for double quote marks ("") which allow for parameters with spaces as well as parameters with null values.
- Added a few links to relevant info on the maintenance shell page.
[edit] v0.2.1
- Fixed some minor bugs
- Added message notifying user when MaintenanceShell is incorrectly configured.
[edit] v0.2.0
- Replaced buggy and annoying password system with Mediawiki based authentication
- Changed look of interface slightly
[edit] v0.1.0
- First public release
[edit] Notes
MaintenanceShell tricks maintenance scripts into thinking they are running from the command line instead of a web server. There may be unexpected results due to this fact -- however, all scripts tested so far are working normally. Please report any unexpected results on talk page.
