You are browsing a read-only backup copy of Wikitech. The primary site can be found at wikitech.wikimedia.org

Difference between revisions of "Maintenance server"

From Wikitech-static
Jump to navigation Jump to search
imported>Krinkle
 
imported>Krinkle
m
Line 1: Line 1:
'''Maintenance servers''' are where we run scheduled and ad-hoc command-line scripts relating to [[MediaWiki]]. Most commonly.
'''Maintenance servers''' are where we run scheduled and ad-hoc command-line scripts relating to [[MediaWiki]].


==Service==
==Service==
Line 12: Line 12:
When running a long-running maintenance script, consider using [[screen]].
When running a long-running maintenance script, consider using [[screen]].


To run a maintenance script, log into the active maintenance server:<pre>
To run a maintenance script, log into the active maintenance server:
cd /srv/mediawiki/php-1.27.0-wmf.23
<pre>
</pre>Use the mwscript command-line utility:<pre>
cd /srv/mediawiki/php-1.27.0-wmf.23</pre>
Use the mwscript command-line utility:
<pre>
mwscript scriptname.php --wiki dbname
mwscript scriptname.php --wiki dbname
</pre>The above command will run the script scriptname.php located in the <code>/maintenance</code> directory of the specified wiki's php directory.
</pre>The above command will run the script scriptname.php located in the <code>/maintenance</code> directory of the specified wiki's php directory.
Line 41: Line 43:


* [[Deployment server]]
* [[Deployment server]]
*[[mw:Manual:Maintenance scripts|Manual:Maintenance scripts]]

Revision as of 16:10, 30 June 2021

Maintenance servers are where we run scheduled and ad-hoc command-line scripts relating to MediaWiki.

Service

As of June 2021, the servers are:

Runbook

Run a maintenance script on a wiki

When running a long-running maintenance script, consider using screen.

To run a maintenance script, log into the active maintenance server:

cd /srv/mediawiki/php-1.27.0-wmf.23

Use the mwscript command-line utility:

mwscript scriptname.php --wiki dbname

The above command will run the script scriptname.php located in the /maintenance directory of the specified wiki's php directory.

You can also use a path relative to the MediaWiki installation, for example to run a script from an extension rather than core. It is recommended that in this case you first change a MediaWiki directory to allow for tab completion:

, change to the directory for the version of MediaWiki that you want to run the maintenance script from (for example php-1.27.0-wmf.23)

$ cd /srv/mediawiki/php-1.xx-someversion/
$ mwscript extensions/MyExtension/maintenance/scriptname.php --wiki dbname

IIt will run the version of the maintenance script in /home/wikipedia/common. If you want to run the version under /usr/local/apache/common-local/, or you're on a box without /home mounted, you need to change to /usr/local/apache/common-local/multiversion and run ./MWScript.php instead.

Example:

$ mwscript eval.php enwiki
> print $wgDBname;
enwiki
> print $wgVersion;
1.18wmf1
> exit
$

If you need to pass parameters to your maintenance script, you can add them to the end. You may also want to explicitly declare the database parameter to avoid confusion:

mwscript scriptname.php --wiki=enwiki --days=1

In this case, the 'wiki' parameter is handled by mwscript and the 'days' parameter is handled by scriptname.php. The "wiki" must be in wikiversions.cdb so the maintenance script machinery can figure out what MediaWiki version it is running.

Many maintenance scripts are used to run heavy database queries; remember to check the replication lag and other possible byproducts.

See also