Manual:メンテナンススクリプト
メンテナンススクリプトは管理、取り込み、維持、レポート、アップグレードなどさまざまな仕事を行うときに使われます。スクリプトはPHPで書かれており、MediaWikiをインストールしたディレクトリ配下の maintenance にあります。
数十種のスクリプトがありますが、どれだけ一般的に役立ちどれだけの品質を持っているかはさまざまです。スクリプトを使う前には説明文書をしっかり読んでください。もし説明文書がなければ、スクリプトを実行する際さらに注意を払ってください。
設定
Manual:$wgDBuser で設定した利用者に必要な権限がない場合、$wgDBadminuser と $wgDBadminpassword の設定変数は必ず指定し、Manual:update.php のようにデータベースの構造を変更を必要とするメンテナンススクリプトを実行できるようにしてください。
あるいは、--dbuser と --dbpass のパラメーターを使ってこれらの値をスクリプトに渡すこともできます。
これら変数の値はMediaWikiのインストールでどのデータベースエンジンを使うよう指定したかによって変わります。
設定しない場合、Manual:$wgDBuser で設定したユーザが使われます。
MySQL
セキュリティ上の理由から、MediaWikiの主たるデータベースアカウントが持つべきではないデータベース権限を必要とするメンテナンススクリプトがあります。
'管理者'の権限を持つ別のデータベースアカウントを、MediaWikiデータベースだけのためにつくっておくべきです（もしまだ存在しないのであれば）。
MediaWikiで使うデータベースの名前が wikidb であれば、以下のSQLによりlocalhostにおいて管理者権限で実行できるそのような利用者を作成できます。
GRANT ALL PRIVILEGES ON wikidb.* TO 'wikidbadmin'@'localhost' IDENTIFIED BY 'strong-password';
アカウントが既に存在するなら、そのアカウント名を $wgDBadminuser に設定してください。
他の設定変数と同じように、$wgDBadminuser も LocalSettings.php に設定すべきです。
$wgDBadminuser のパスワードは $wgDBadminpassword 設定変数に必ず設定してください。
PostgreSQL
PostgreSQL は、MySQL とは異なるセキュリティ モデルを使用しており、MediaWiki インストレーションの日常的な操作に使用される同じ PostgreSQL サーバー アカウントを、メンテナンス スクリプトの実行にも使用する必要があります。
これは、メンテナンス スクリプトによって作成された新しいテーブルの所有者が正しく設定されていることを確認するために必要です。
$wgDBadminuser や $wgDBadminpassword を設定する必要は全くありません。
スクリプトの実行
その後、メンテナンス スクリプトをコマンド ラインから実行する必要があります。 端末から直接サーバーにアクセスしない利用者は、通常、ssh で接続を確立します。 Linux/Unix ユーザーの場合は、シェルで ssh クライアントを使用します。 Windows ユーザーの場合は、Windows 10 で導入された SSH コマンドライン ツールを使用するか、下記の PuTTY などのサード パーティ製ツールを使用するか、Windows Subsystem for Linux を使用できます。
Windows ユーザーに必須のプログラム: PuTTY または任意のターミナル エミュレーター。
- Step 1: Download and run PuTTY, a terminal emulator.
- 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.
- Step 3: A command screen will pop up. At the login as: line enter the FTP user name.
- Step 4: Enter the FTP password.
- Step 5: Change the current directory to the "maintenance" folder, which is found in the specific MediaWiki folder.
You can type pwd to see what folder you are currently in.
See Ubuntu.com MediaWiki for instructions or NameCheap on how to change the current directory to the "maintenance" folder.
Remember to type: cd[space]/home/NAME OF MAIN FOLDER/NAME OF WIKI FOLDER/maintenance
$ 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
- Windows ではコマンドは以下の通りです:
$ C:\path\to\php\php-win.exe C:\path\to\mediawiki\maintenance\rebuildall.php
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.
標準のコマンドラインオプション
/maintenance にあるほとんどすべてのPHPスクリプトでは以下に示す標準オプションが使えます。
- --help
- ヘルプ メッセージを表示します
- --conf <path>
- LocalSettings.php の場所。指定しない場合は既定値（スクリプトの親ディレクトリ）が設定されます。
- --dbuser <username>
- LocalSettings.php で指定したものとは異なるデータベースアカウントを指定します。データベース接続を必要としないスクリプトや、バックエンドデータベースとしてSQLiteを指定した場合、この指定は無視されます。
- --dbpass <password>
- LocalSettings.php で指定したものとは異なるデータベースアカウントのパスワードを指定します。データベース接続を必要としないスクリプトや、バックエンドデータベースとしてSQLiteを指定した場合、この指定は無視されます。
- --globals
- デバッグのため処理の最後にグローバル変数の内容を出力します。
- --memory-limit <value>
- スクリプトが使えるメモリの上限値を設定します。標準の php.ini で使える略記法（1024K、20M、1Gなど）を使った値を指定できます。
maxを指定すると制限なくメモリが使えます（指定しない場合の既定値）。defaultを指定すると設定を変更しません。 (1.17 で導入) - --quiet
- エラーではない内容は出力しない。
- --wiki <id>
- ウィキファームのウィキID。IDは
dbnameまたはdbname-prefixの形で指定します。LocalSettings.php はMW_DBとMW_PREFIXの定数に設定された値を使って実行されます。 - --profiler
- プロファイラーの出力書式（通常はtext）。 (1.22 で導入)
- --mwdebug
- あらかじめ用意されたMediaWiki開発者用設定を有効にする。 (1.31 で導入)
シンボリックリンクを使ったMediaWikiのインストール
MediaWikiのphpファイルが主となるインストールからのシンボリックリンクとなっていた場合、メンテナンススクリプトへのパスを LocalSettings.php ファイルに指定する必要があります。例えば、
php maintenance/importImages.php --conf /var/wwwdata/website.org/wiki/LocalSettings.php /tmp/wikiimages .jpg .png .svg
そうしないとこのようなエラーが表示されるでしょう。
A copy of your installation's LocalSettings.php must exist and be readable in the source directory.
共有設定を使ったMediaWikiインストール（ファミリー型）
多言語用ウィキファミリーとしてMediaWikiをインストールし、設定（LocalSettings.php）を共通部分と言語個別部分に分ける場合があります（Manual:Wiki family#Shared Settings参照）。このとき、共通部分は /w ディレクトリの外に配置し、相対リンク（require_once "../ExtensionSettings.php";）を使ってアクセスします。
この場合、メンテナンススクリプトを /w/maintenance ディレクトリで実行してもうまく動作しません。
そうではなく、/w ディレクトリで以下のように実行してください。
$ php maintenance/rebuildall.php
シェルでアクセスできない場合
多くの共有ホストでは、シェルを使ってアクセスすることができません。その場合、Maintenance と MaintenanceShell の拡張機能を使ってウェブからメンテナンススクリプトを実行できるようにするといいでしょう。
メンテナンススクリプトの一覧
Instead of this probably-outdated list,
- Browse the latest contents of the
maintenancedirectory. - https://doc.wikimedia.org/mediawiki-core/master/php/ - View its generated documentation summary. (Files > File List > maintenance in the tabs or left-hand navigation sidebar)
Here is the list of files included in the maintenance subdirectory located at the root of a MediaWiki installation.
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.).
Be aware that these were created and named on an ad hoc basis so have some usability issues.
maintenance/
maintenance/archives
maintenance/benchmarks
- Benchmarker.php
- bench_HTTP_HTTPS.php
- bench_delete_truncate.php
- bench_if_switch.php
- bench_strtr_str_replace.php
- bench_utf8_title_check.php
- bench_wfBaseConvert.php
- bench_wfIsWindows.php
- benchmarkHooks.php
- benchmarkParse.php
- benchmarkPurge.php
maintenance/dev/includes
maintenance/language
- StatOutputs.php
- alltrans.php
- checkDupeMessages.php
- checkExtensions.php
- checkLanguage.inc
- checkLanguage.php
- countMessages.php
- date-formats.php
- digit2html.php
- dumpMessages.php
- generateCollationData.php
- generateNormalizerDataAr.php
- generateNormalizerDataMl.php
- langmemusage.php
- listVariants.php
- languages.inc
- transstat.php
maintenance/oracle
maintenance/storage
- checkStorage.php
- compressOld.php
- dumpRev.php
- moveToExternal.php
- orphanStats.php
- recompressTracked.php
- resolveStubs.php
- storageTypeStats.php
- testCompression.php
- trackBlobs.php