Manual:Maintenance scripts

From SoftOver
Jump to: navigation, search
Crystal Clear app display.png Users 30px System Administrators Crystal Clear app tutorials.png Developers

The maintenance scripts are used to perform various administrative, import, maintenance, reporting and upgrade tasks. The scripts are written in PHP and live in the maintenance subdirectory of MediaWiki installs.

There are dozens of scripts with varying degrees of general utility and quality - because of this, it is best to carefully read the documentation on a script before using it. If a script is not documented, this often indicates that additional care should be taken.

Contents

Configuration

The $wgDBadminuser and $wgDBadminpassword configuration variables must be set in order to run some maintenance scripts. The values for these variables differ based on the database engine that is being used to power your installation of MediaWiki.

MySQL

Some of the maintenance scripts require database permissions that, for security reasons, the main MediaWiki database account should not have. A separate database account with 'superuser' privileges for just the MediaWiki database should be created (if it does not already exist.) For example, if the database that you use for MediaWiki is called wikidb, then the following SQL would create such a user who can exercise superuser privileges on localhost.:

<source lang="sql"> GRANT ALL PRIVILEGES ON wikidb.* TO 'wikidbadmin'@'localhost' IDENTIFIED BY 'strong-password'; </source>

Once the account exists, the account name should be set in the $wgDBadminuser configuration variable. Like other configuration variables, $wgDBadminuser should be set in LocalSettings.php. A password for $wgDBadminuser must be set in the $wgDBadminpassword configuration variable.

PostgreSQL

PostgreSQL uses a different security model than MySQL and the same PostgreSQL server account used for day-to-day operation of the MediaWiki installation must also be used for running the maintenance scripts. This is necessary to ensure that the owner for new tables created by the maintenance scripts is set correctly. Simply set $wgDBadminuser to $wgDBuser and $wgDBadminpassword to $wgDBpassword.

Running the scripts

File:Web hosting site ip address.png
Example of IP address and FTP user name and password on the Godaddy.com hosting site.

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

Required program: PuTTY or any terminal emulator

File:Putty enter ip address.png
Under the Host Name (or IP address) enter the IP Address of your web hosting site.
  • Step 2: In PuTTy, under the Host Name (or IP address) enter the IP Address of your web hosting site (Contact your website provider if necessary) and click Open.
File:Putty command window.png
At the login as: line enter the FTP user name.
  • Step 3: A command screen will pop up. At the login as: line enter the FTP user name.
File:Putty command window password.png
On the FTP user name@IP Address's password line: type the FTP password.
  • Step 4: Enter the FTP password.
File:Putty command line.png
The putty command line.
  • Step 5: Change the current directory to the maintenance subdirectory. You can type pwd to see what folder you are currently in. The maintenance folder is in the root mediawiki folder.
 $ cd maintenance
  • Step 6: 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, the command is;
$ C:\path\to\php\php-win.exe C:\path\to\mediawiki\maintenance\rebuildall.php

Note: If your script fails to run, and spews out a lot of error messages, the first thing to try is to set the MW_INSTALL_PATH environment variable to point to the root of your MediaWiki installation. This will help scripts to find the necessary files, and is particularly relevant when running maintenance scripts provided by third-party extensions.

Standard command-line options

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

--help 
Displays help message
--conf <path> 
Location of LocalSettings.php, if not default (at parent directory of the script)
--dbuser <username> 
Database account to use, not used for scripts that don't require a database connection or when SQLite database backend is used
--dbpass <password> 
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
--memory-limit <value> 
Set memory limit for the script. Accepts ordinary numbers, standard php.ini abbreviations (1024K, 20M, 1G), max for no limit (will be used by default if omitted) and default for no change. Available only since MediaWiki 1.17.
--quiet 
Supress non-error output
--wiki <id> 
Wiki ID for wiki farms. This may be of the form dbname or dbname-prefix. LocalSettings.php will be run with the MW_DB and MW_PREFIX constants defined accordingly.

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.

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.).

/maintenance/

/maintenance/archives/

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

/maintenance/dtrace/

/maintenance/language/

/maintenance/storage/

See also

Manuals
Extensions
Language: English
Personal tools
Namespaces

Variants
Actions
Navigation
Tools