View source for Manual:Maintenance scripts/Running the scripts

<languages />
__NOTOC__
{{Maintenance scripts}}

<translate><!--T:1--> The maintenance scripts must then be run from the command line.</translate>
<translate><!--T:2--> Users who do not access the server directly from its terminal will usually establish a connection through SSH.</translate>

* <translate><!--T:3--> For Linux/Unix users this is by using the SSH client in a shell.</translate>
* <translate><!--T:4--> For Windows users, one can use the SSH command line tool introduced in Windows 10 or alternatively use a third-party tool such as PuTTY shown below or use Windows Subsystem for Linux.</translate>

<translate>
== Get into server == <!--T:5-->

=== Linux/MacOS user=== <!--T:6-->
</translate>
<translate><!--T:7--> Most the Linux system and MacOS comes SSH client built-in.</translate>
<translate><!--T:8--> So you don't need to any SSH client.</translate>
<translate><!--T:9--> You can check SSH client in your system by running following command in your terminal.</translate>
{{-}}
{{Terminal|text=
$ ssh -V

OpenSSH_8.6p1, LibreSSL 2.8.3
}}

<translate><!--T:10--> If this command gives error then you need to install SSH client in your system.</translate>

'''Debian/Ubuntu''' - <code>sudo apt install openssh-client</code>

'''MacOS''' - <code>brew install openssh</code>

<translate><!--T:11--> Once you get the SSH client in your system then you can run following command to get into server.</translate>

{{Terminal|text=<nowiki>
$ ssh -p 22 root@examplewiki.com

Welcome to Ubuntu 18.04.5 LTS (GNU/Linux 4.15.0-161-generic x86_64)

 * Documentation:  https://help.ubuntu.com
 * Management:     https://landscape.canonical.com
 * Support:        https://ubuntu.com/advantage

  System information as of Tue Feb 15 10:32:00 UTC 2022

  System load:  0.0                Processes:           106
  Usage of /:   29.8% of 24.06GB   Users logged in:     0
  Memory usage: 51%                IP address for eth0: XXX.XXX.XXX.XXX
  Swap usage:   0%                 IP address for eth1: 10.116.0.2

Last login: Tue Feb 15 10:27:28 2022 from XX.XXX.XX.XXX

root@-s-1vcpu:~#
</nowiki>}}

<translate><!--T:12--> The default port for SSH connection is <tvar name=1><code>22</code></tvar> and user is <tvar name=2><code>root</code></tvar>.</translate>
<translate><!--T:13--> But shared hosting provider gives the custom user and SSH port number.</translate>
<translate><!--T:14--> Replace these values with yours.</translate>

<translate>
<!--T:52-->
Now, you can [[<tvar name=1>#Running the script</tvar>|run]] the MediaWiki maintenance script on server.

=== Windows user === <!--T:15-->

<!--T:16-->
For Windows user, there are two ways to get into server.

==== Native SSH client ==== <!--T:17-->
</translate>
<translate><!--T:18--> You can install/enable SSH client using Windows Settings on Windows Server 2019 and Windows 10 devices.</translate>
<translate><!--T:68--> They support the SSH natively.</translate>
<translate><!--T:69--> See [<tvar name=1>https://docs.microsoft.com/en-us/windows-server/administration/openssh/openssh_install_firstuse</tvar> Official doc].</translate>

<translate>
<!--T:19-->
To install the OpenSSH component:
</translate>

* <translate><!--T:53--> Open <tvar name=1><code>Settings</code></tvar>, select <tvar name=2><code>Apps</code> > <code>Apps & Features</code></tvar>, then select <tvar name=3><code>Optional Features</code></tvar>.</translate>
* <translate><!--T:54--> Scan the list to see if the OpenSSH is already installed. If not, at the top of the page, select <tvar name=1><code>Add a feature</code></tvar>, then:</translate>
** <translate><!--T:55--> Find <tvar name=1><code>OpenSSH</code></tvar> Client, then click <tvar name=2><code>Install</code></tvar>.</translate>

<translate><!--T:20--> It will install the SSH client in your system.</translate>
<translate><!--T:21--> Now, you can SSH to server using PowerShell.</translate>

{{Terminal|title=PowerShell|text=
$ ssh -p 22 root@examplewiki.com
}}

<translate><!--T:56--> The default port for SSH connection is <tvar name=1><code>22</code></tvar> and user is <tvar name=2><code>root</code></tvar>.</translate>
<translate><!--T:57--> But shared hosting provider gives the custom user and SSH port number.</translate>
<translate><!--T:58--> Replace these values with yours.</translate>

<translate>
<!--T:59-->
Now, you can [[<tvar name=1>#Running the script</tvar>|run]] the MediaWiki maintenance script on server.

==== Putty (or other 3rd party SSH client) ==== <!--T:60-->

<!--T:61-->
You can use PuTTY or other 3rd party SSH client on Windows machine:
</translate>

* <translate><!--T:62--> Step 1: Download and run [[w:PuTTY|PuTTY]], a [[w:Terminal_emulator|terminal emulator]].</translate>
* <translate><!--T:63--> Step 2: In PuTTy, under the '''Host Name (or IP address)''' enter the [[w:IP Address|IP Address]] of your web hosting site (Contact your website provider if necessary) and click '''Open'''.</translate>
* <translate><!--T:64--> Step 3: A command screen will pop up. At the '''login as:''' line enter the [[w:File Transfer Protocol|FTP]] user name.</translate>
* <translate><!--T:65--> Step 4: Enter the FTP password.</translate>

<translate>
<!--T:67-->
Now, you can [[<tvar name=1>#Running the script</tvar>|run]] the MediaWiki maintenance script on server.

== Running the script == <!--T:22-->

<!--T:23-->
Once you get into to the server (See "Get into server" above) then you can follow these steps.

<!--T:24-->
Step 1: Goto the MediaWiki root directory. In most cases, it would be <tvar name=1><code>/var/www/html</code></tvar>
</translate>
{{Terminal|text=
root@-s-1vcpu:~# cd /var/www/html/
}}

<translate><!--T:25--> Step 2: Run the script</translate>

{{Terminal|text=
root@-s-1vcpu:/var/www/html# php maintenance/run.php showSiteStats

Total edits       : 11
Number of articles:  3
Total pages       :  6
Number of users   :  2
Active users      :  0
Number of images  :  0
}}

<translate><!--T:26--> If you are using Windows server and get an error (for example: <tvar name=1>''php.exe is no valid Win32 application''</tvar>), try the following.</translate>

<syntaxhighlight lang="text" style="overflow:auto;">
$ php-cgi maintenance/run.php showSiteStats
</syntaxhighlight>

<translate><!--T:27--> or</translate>

<syntaxhighlight lang="text" style="overflow:auto;">
$ C:\path\to\php\php-win.exe C:\path\to\mediawiki\maintenance\run.php showSiteStats
</syntaxhighlight>

{{Note|1=<translate><!--T:70--> Since MediaWiki 1.40, a maintenance script should be invoked directly through <tvar name=1><code>maintenance/run.php</code></tvar>. Invoking maintenance scripts directly will trigger a warning.</translate>}}

{{Note|1=<translate><!--T:28--> ''If your script fails to run, and spews out a lot of error messages, the first thing to try is to set the <tvar name=1><code>MW_INSTALL_PATH</code></tvar> environment variable to point to the root of your MediaWiki installation.''</translate>  <translate><!--T:29--> ''This will help scripts to find the necessary files, and is particularly relevant when running maintenance scripts provided by third-party extensions.''</translate>}}

<translate>

== Standard command-line options == <!--T:30-->

<!--T:31-->
Almost every PHP script in <tvar name=1><code>/maintenance</code></tvar> supports several standard options:
</translate>
{| class="wikitable"
|-
! width="20%" | <translate><!--T:32--> Option</translate> !! <translate><!--T:33--> Description</translate>
|-
| --help || <translate><!--T:34--> Displays help message</translate>
|-
| --conf ''&lt;path&gt;'' || <translate><!--T:35--> Location of <tvar name=1>LocalSettings.php</tvar>, if not default (at parent directory of the script)</translate>
|-
| --dbuser ''&lt;username&gt;'' || <translate><!--T:36--> Database account to use instead of the one specified in <tvar name=1>LocalSettings.php</tvar>, not used for scripts that don't require a database connection or when SQLite database backend is used</translate>
|-
| --dbpass ''&lt;password&gt;'' || <translate><!--T:37--> Database password to use instead of the one specified in <tvar name=1>LocalSettings.php</tvar>, not used for scripts that don't require a database connection or when SQLite database backend is used</translate>
|-
| --globals || <translate><!--T:38--> Output globals at the end of processing for debugging</translate>
|-
| --memory-limit ''&lt;value&gt;'' || <translate><!--T:39--> Set memory limit for the script. Accepts ordinary numbers, standard <tvar name=1>php.ini</tvar> abbreviations (1024K, 20M, 1G), <tvar name=2><code>max</code></tvar> for no limit (will be used by default if omitted) and <tvar name=3><code>default</code></tvar> for no change.</translate> {{introduced-inline|1.17}}
|-
| --quiet || <translate><!--T:40--> Suppress non-error output</translate>
|-
| --wiki || <translate><!--T:41--> Wiki ID for [[<tvar name=1>Special:MyLanguage/Manual:Wiki family</tvar>|wiki farms]]. This may be of the form <tvar name=2><code>dbname</code></tvar> or <tvar name=3><code>dbname-prefix</code></tvar>. <tvar name=4>LocalSettings.php</tvar> will be run with the <tvar name=5><code>MW_DB</code></tvar> and <tvar name=6><code>MW_PREFIX</code></tvar> constants defined accordingly.</translate>
|-
| --profiler || <translate><!--T:42--> Profiler output format (usually "text").</translate> {{introduced-inline|1.22}}
|-
| --mwdebug || <translate><!--T:43--> Enable built-in MediaWiki development settings.</translate> {{introduced-inline|1.31}}
|}

<translate>
== MediaWiki installs that use symlinks == <!--T:44-->

<!--T:45-->
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 <tvar name=1>LocalSettings.php</tvar> file. For example:
</translate>

<syntaxhighlight lang="text" style="overflow:auto;">
php maintenance/importImages.php --conf /var/www/html/LocalSettings.php /tmp/wikiimages .jpg .png .svg
</syntaxhighlight>

<translate>
== MediaWiki installs that use shared settings (family type) == <!--T:46-->

</translate>
<translate><!--T:47--> Sometimes MediaWiki is installed as a family for many languages and settings (<tvar name=1>LocalSettings.php</tvar>) are split to common part and language parts (see {{<tvar name=2>ll|Manual:Wiki_family#Shared_Settings</tvar>|Wiki family#Shared Settings}}) where common part is located outside of <tvar name=3><code>/w</code></tvar> directory and accessed using relative link (<tvar name=4><syntaxhighlight lang="php" inline>require_once "../ExtensionSettings.php";</syntaxhighlight></tvar>).</translate> <translate><!--T:48--> In this case maintenance scripts will not work when running them in <tvar name=1><code>/w/maintenance</code></tvar> directory. Run them from <tvar name=2><code>/w</code></tvar> directory instead.</translate>

<translate>
==No shell access== <!--T:49-->

</translate>
<translate><!--T:50--> On many shared hosts, you won't have shell access.</translate> <translate><!--T:51--> The following extensions may be useful to run maintenance scripts via the web.</translate>
* {{ll|Extension:Maintenance|nsp=0}} 
* {{ll|Extension:MaintenanceShell|nsp=0}}

[[Category:MediaWiki administration{{#translation:}}|{{PAGENAME}}]]
[[Category:Maintenance scripts{{#translation:}}]]