View source for Manual:Maintenance scripts/Running the scripts/fa

<languages />
__NOTOC__
{{Maintenance scripts}}

<span lang="en" dir="ltr" class="mw-content-ltr">The maintenance scripts must then be run from the command line.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">Users who do not access the server directly from its terminal will usually establish a connection through SSH.</span>

* <span lang="en" dir="ltr" class="mw-content-ltr">For Linux/Unix users this is by using the SSH client in a shell.</span>
* <span lang="en" dir="ltr" class="mw-content-ltr">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.</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
== Get into server ==
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
=== Linux/MacOS user===
</div>
<span lang="en" dir="ltr" class="mw-content-ltr">Most the Linux system and MacOS comes SSH client built-in.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">So you don't need to any SSH client.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">You can check SSH client in your system by running following command in your terminal.</span>
{{-}}
{{Terminal|text=
$ ssh -V

OpenSSH_8.6p1, LibreSSL 2.8.3
}}

<span lang="en" dir="ltr" class="mw-content-ltr">If this command gives error then you need to install SSH client in your system.</span>

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

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

<span lang="en" dir="ltr" class="mw-content-ltr">Once you get the SSH client in your system then you can run following command to get into server.</span>

{{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>}}

<span lang="en" dir="ltr" class="mw-content-ltr">The default port for SSH connection is <code>22</code> and user is <code>root</code>.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">But shared hosting provider gives the custom user and SSH port number.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">Replace these values with yours.</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
Now, you can [[#Running the script|run]] the MediaWiki maintenance script on server.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
=== Windows user ===
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
For Windows user, there are two ways to get into server.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
==== Native SSH client ====
</div>
<span lang="en" dir="ltr" class="mw-content-ltr">You can install/enable SSH client using Windows Settings on Windows Server 2019 and Windows 10 devices.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">They support the SSH natively.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">See [https://docs.microsoft.com/en-us/windows-server/administration/openssh/openssh_install_firstuse Official doc].</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
To install the OpenSSH component:
</div>

* <span lang="en" dir="ltr" class="mw-content-ltr">Open <code>Settings</code>, select <code>Apps</code> > <code>Apps & Features</code>, then select <code>Optional Features</code>.</span>
* <span lang="en" dir="ltr" class="mw-content-ltr">Scan the list to see if the OpenSSH is already installed. If not, at the top of the page, select <code>Add a feature</code>, then:</span>
** <span lang="en" dir="ltr" class="mw-content-ltr">Find <code>OpenSSH</code> Client, then click <code>Install</code>.</span>

<span lang="en" dir="ltr" class="mw-content-ltr">It will install the SSH client in your system.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">Now, you can SSH to server using PowerShell.</span>

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

<span lang="en" dir="ltr" class="mw-content-ltr">The default port for SSH connection is <code>22</code> and user is <code>root</code>.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">But shared hosting provider gives the custom user and SSH port number.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">Replace these values with yours.</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
Now, you can [[#Running the script|run]] the MediaWiki maintenance script on server.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
==== Putty (or other 3rd party SSH client) ====
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
You can use PuTTY or other 3rd party SSH client on Windows machine:
</div>

* <span lang="en" dir="ltr" class="mw-content-ltr">Step 1: Download and run [[w:PuTTY|PuTTY]], a [[w:Terminal_emulator|terminal emulator]].</span>
* <span lang="en" dir="ltr" class="mw-content-ltr">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'''.</span>
* <span lang="en" dir="ltr" class="mw-content-ltr">Step 3: A command screen will pop up. At the '''login as:''' line enter the [[w:File Transfer Protocol|FTP]] user name.</span>
* <span lang="en" dir="ltr" class="mw-content-ltr">Step 4: Enter the FTP password.</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
Now, you can [[#Running the script|run]] the MediaWiki maintenance script on server.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
== Running the script ==
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Once you get into to the server (See "Get into server" above) then you can follow these steps.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Step 1: Goto the MediaWiki root directory. In most cases, it would be <code>/var/www/html</code>
</div>
{{Terminal|text=
root@-s-1vcpu:~# cd /var/www/html/
}}

<span lang="en" dir="ltr" class="mw-content-ltr">Step 2: Run the script</span>

{{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
}}

<span lang="en" dir="ltr" class="mw-content-ltr">If you are using Windows server and get an error (for example: ''php.exe is no valid Win32 application''), try the following.</span>

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

<span lang="en" dir="ltr" class="mw-content-ltr">or</span>

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

{{Note|1=<span lang="en" dir="ltr" class="mw-content-ltr">Since MediaWiki 1.40, a maintenance script should be invoked directly through <code>maintenance/run.php</code>. Invoking maintenance scripts directly will trigger a warning.</span>}}

{{Note|1=<span lang="en" dir="ltr" class="mw-content-ltr">''If your script fails to run, and spews out a lot of error messages, the first thing to try is to set the <code>MW_INSTALL_PATH</code> environment variable to point to the root of your MediaWiki installation.''</span>  <span lang="en" dir="ltr" class="mw-content-ltr">''This will help scripts to find the necessary files, and is particularly relevant when running maintenance scripts provided by third-party extensions.''</span>}}


<div lang="en" dir="ltr" class="mw-content-ltr">
== Standard command-line options ==
</div>

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

<div lang="en" dir="ltr" class="mw-content-ltr">
== MediaWiki installs that use symlinks ==
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
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:
</div>

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

<div lang="en" dir="ltr" class="mw-content-ltr">
== MediaWiki installs that use shared settings (family type) ==
</div>

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

<div lang="en" dir="ltr" class="mw-content-ltr">
==No shell access==
</div>

<span lang="en" dir="ltr" class="mw-content-ltr">On many shared hosts, you won't have shell access.</span> <span lang="en" dir="ltr" class="mw-content-ltr">The following extensions may be useful to run maintenance scripts via the web.</span>
* {{ll|Extension:Maintenance|nsp=0}} 
* {{ll|Extension:MaintenanceShell|nsp=0}}

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