Manual:Maintenance scripts

From MediaWiki.org

Jump to: navigation, search
Crystal Clear app display.png Users Crystal Clear app terminal.png System Administrators Crystal Clear app tutorials.png Developers

The maintenance scripts are located in the maintenance subdirectory of a MediaWiki installation.

Contents

[edit] Executing the maintenance scripts

In order to run the maintenance scripts, you must first define the variables below:

  • MediaWiki 1.15 or so and later: define these in your LocalSettings.php file
  • earlier MediaWiki: rename the file AdminSettings.sample located in the root directory of your wiki to AdminSettings.php (now deprecated) and fill in the values below
$wgDBadminuser      = 'wikiadmin';
$wgDBadminpassword  = 'adminpass';

to an existing administration user allowed to modify the appropriate database of your MediaWiki instance within MySQL.

The maintenance scripts must then be executed from the command line.

$ ssh username@your.domain.com
  • Step 2: Change the current directory to the maintenance subdirectory:
$ cd maintenance
  • Step 3: Execute the maintenance script that needs to be run:
$ php rebuildall.php
If you get an error (for example: php.exe is no valid Win32 application), try the following:
$ php-cgi rebuildall.php
In Windows XP, the command is;
$ C:\path\to\php\php-win.exe C:\path\to\mediawiki\maintenance\rebuildall.php

[edit] Standard command-line options

Almost every PHP script in /maintenance supports several standard options:

--help 
Displays help message
--conf 
Location of LocalSettings.php, if not default (at parent directory of the script)
--dbuser 
Database account to use, not used for scripts that don't require a database connection or when SQLite database backend is used
--dbpass 
Database password to use, not used for scripts that don't require a database connection or when SQLite database backend is used
--globals 
Output globals at the end of processing for debugging
--quiet 
Whether to supress non-error output
--wiki 
For specifying the wiki ID


[edit] MediaWiki installs that use symlinks

In cases where the MediaWiki php files are symlinked to a central installation you will need to specify to the maintenance script the path of the LocalSettings.php file. For example:

php maintenance/importImages.php --conf /var/wwwdata/website.org/wiki/LocalSettings.php /tmp/wikiimages .jpg .png .svg

Otherwise you will get this error:

A copy of your installation's LocalSettings.php
must exist and be readable in the source directory.

[edit] List of maintenance scripts

Here is the list of files included in the maintenance subdirectory located at the root of a MediaWiki installation. This list was created from the documentation located in the Documentation trunk and may not accurately reflect the contents of the maintenance subdirectory of the current release of the software.

You can contribute to this manual by keeping this list up to date, adding a description of these files' specific purpose and of how an administrator should use them (command line examples, etc.).

[edit] /maintenance/

[edit] /maintenance/archives/

The scripts included in the archive subdirectory have been designed for updating databases from older versions of the software.

[edit] /maintenance/dtrace/

[edit] /maintenance/language/

[edit] /maintenance/storage/

[edit] See also

Manuals
Extensions
FAQ
Manual:FAQ/Running PHP and SQL queries