Manual:LocalSettings.php

From MediaWiki.org
Jump to: navigation, search
This page is a translated version of the page Manual:LocalSettings.php and the translation is 84% complete.

Outdated translations are marked like this.
Other languages:
български • ‎Deutsch • ‎Ελληνικά • ‎English • ‎español • ‎français • ‎français cadien • ‎magyar • ‎Bahasa Indonesia • ‎italiano • ‎日本語 • ‎한국어 • ‎Nederlands • ‎polski • ‎português • ‎português do Brasil • ‎русский • ‎Türkçe • ‎Tiếng Việt • ‎中文
警告 警告: BOM (バイトオーダーマーク) を追加してしまうテキストエディター (メモ帳、TextEdit など該当するものすべて) で LocalSettings.php を編集しないでください。 これらはウィキでの PHP の実行を阻害します。 代わりに、Vim、Notepad++、Atom のようなコード エディターを使用してください。 これらはファイルのエンコーディングを適切に処理できます。 さらに、テキストエディターで以前破損してしまったファイルを復元することもできます。

LocalSettings.phpファイルは (Manual:DefaultSettings.php|DefaultSettings.php ファイルに基づいて) MediaWiki|MediaWiki インストレーションのManual:Configuration settings|基本的な構成設定を提供します。このファイルの設定を確認するためには時間が必要です。ファイルは通常、Web ベースの MediaWiki インストーラーによって生成されますが、Apache の設定と協調してパラメーターを変更できます。ウィキ ファームとして構成された MediaWiki インストレーションでは、Manual:CommonSettings.php|CommonsSettings.php を使用できます。

サーバー内での場所

LocalSettings.php ファイルはウィキページではないため、ウェブブラウザーで開くことができません。 これはサーバーのファイルシステム上のファイルだからです。その内容はウィキのセットアップ時に生成され、できたファイルは手動でサーバーに複写する必要があります。ファイルは MediaWiki をインストールしたフォルダに置き、includes/skins/api.php などと同じ階層にします。もしこのファイルがそこにない場合にはウィキは動作せず、ウィキが動作する場合はファイルはそこにあるわけです。場所を探すにはターミナルウィンドウに find / -iname LocalSettings.php -print などのコマンドを入力します。

(Vagrant を使用する場合は MediaWiki-Vagrant#MediaWiki_settings も参照)。

セキュリティ

通常LocalSettings.phpにはデータベースログインなどの機密情報が書かれています。このデータは決して一般に公開してはいけません! サーバのどこかにセキュリティ侵害があると、他のユーザがファイルの内容を閲覧できてしまうかもしれません。あなたのデータをより安全に守るため、このファイルのUNIXアクセス権を以下のように設定してください。ウェブサーバーの実行ユーザはこのファイルにアクセスできる必要があります。このユーザがファイルの所有者と同じであった場合、アクセス権を 600 に設定してください。ウェブサーバの実行ユーザが、ファイルの所有者とは異なるが同じグループに属しているという場合が時々あります。この場合、アクセス権は 640 に設定するのがいいでしょう。より安全にするため、アクセス権はできるだけ狭めておくべきです。

さらに、ウィキが使うデータベースだけに権限を制限したMySQLユーザをつくり、そのユーザの認証情報をLocalSettings.phpに記しておくことができます。またデータベースサーバへはlocalhostからしかせつぞくできないよう設定することもできます。これにより認証情報が流出した場合も外部からのアクセスを防ぐことができます。

ファイルの内容

LocalSettings.php を編集するときは、適切なエンコーディングで上書き保存してください。Windows のメモ帳の場合エンコーディングは「ANSI」にしてください。(英語版 MediaWiki の直訳。テキストに日本語が含まれるとこの方法は使えないので、やはり Vim などのコードエディターを使うべきでしょう)

LocalSettings.php contains PHP code; mainly the definition of variables and their values. Changing a setting usually means changing the value of a PHP variable. Your changes will take effect immediately after saving the file again on the server: There is no need to manually "restart" anything. Anyway, in some cases you may need to clear your browser's cache to actually see the changes you made.

The default values of many more settings are set in includes/DefaultSettings.php, which should not be edited; if the variable you want to change is not already mentioned in your LocalSettings.php, copy the appropriate line from DefaultSettings.php and modify it appropriately in LocalSettings.php. Within LocalSettings.php you can add new lines at the end.

Within the file, there can also be several lines such as 'require_once "$IP/extensions/extension.php";', which point to extensions. These lines enable the according extension in the wiki. Those extensions may require setting the values of more variables in LocalSettings.php; check the documentation of the according extension for further instructions.

注 注: In MediaWiki 1.16 and earlier it was important to not place extensions before the require_once "includes/DefaultSettings.php"; line; that will blank the extension setup function arrays, causing no extensions to be installed, and probably making your wiki inaccessible. Since 1.17 it's no longer necessary for LocalSettings.php to include DefaultSettings.php.

Like most PHP files in MediaWiki, LocalSettings.php does not end with the closing PHP tag ?>. This prevents admins from accidentally adding new information after this tag. PHP works fine without a closing tag.

MediaWiki ウィキファーム上でウィキを持つ場合、LocalSettings.php ファイルへの書き込み権限 (および読み込み権限でさえ) がないかもしれません (例えば次を参照: [1])。ウィキファーム企業はあなたの望みに合わせて変更してくれないことがあります。おそらくはウィキファームのすべてのウィキ群上でほとんど同じ設定をすることが望まれています。

Before 1.17, this file was automatically generated by the installer script and placed in the config folder. As of 1.17, this file is no longer written to your webserver for security reasons. It is now offered as a download, which you must then upload to your server for your wiki to begin working. For a more complete explanation, see this explanation.

利用できる設定の概要

See the configuration settings index and the comments included in the settings files for help on what all the variables do. A short listing of the most important variables, as well as the most requested features, is listed below.

標準設定

インクルードパス

$IP (インクルードパス) 変数はウィキのベースインストールへのローカルファイルのパスを保持します。MediaWiki 1.17から$IPの設定は自動化され、LocalSettings.phpの手動の設定は不要になりました。自動的に現在の作業ディレクトリがデフォルトになるため、手動で構成せずに済みます。

DefaultSettings.php ファイルは IP 変数に指定されたディレクトリから読み込まれます。

サイト名

$SiteName 変数はウィキのセットアップの名前を保持します。この名前は、MediaWiki:Pagetitle などシステム全体で多く含まれます。例えばウィキペディアのタグラインの「From Wikipedia, the free encyclopedia」はこの設定を使用しています。

サイト名の語形変化

いくつかの表示言語はサイト名の語形変化に対応しています。$wgGrammarFormsManual:$wgGrammarForms の変数に適切な語形を設定することができます(事例については $wgSitenameManual:$wgSitename 文書ページを参照してください)。

サイトの言語

ウィキの表示言語は $wgLanguageCodeManual:$wgLanguageCode の設定で制御します。 ウィキユーザはこの設定にかかわらず個人設定で表示言語を変更することができます。この変数はすべての非ログインユーザと大半の登録ユーザに適用される初期設定言語を設定するものです。

スクリプトパス

$wgScriptPathManual:$wgScriptPath は MediaWiki の中心的なコードのアクティングピースであるメインの MediaWiki スクリプトにアクセスするための URL パスの接頭辞です。この設定は、とりわけ Apache の rewrite ルールを利用している場合、必ずApache 設定と一致しなければなりません。

サーバー名

自動検知を上書きするために$wgServerManual:$wgServer を使う方法もあります。ウィキの動作しているローカルホストか、イントラネットまたはインターネットからか、メール通知と他のコンピューターメッセージは通常、アクセス元により異なる URL で配信されます。$wgServer は検知を上書きしサーバー名は定数になります。

www.example.com がインターネットから見られるウィキのサーバーアドレスである場合、次のような行を追加する:

$wgServer = 'http://www.example.com';

The magic word variable {{SERVER}} can be used on wiki pages; it equals the value of $wgServer; however, on a wiki, such as those in the WikiMedia family, where relative urls are used, it will not fully expand, for example here it displays //www.mediawiki.org, which can neither be clicked nor copy-pasted into the address bar as it is.

スクリプト名

$wgScriptManual:$wgScript はメインの MediaWiki の PHP スクリプトの名前で、既定では index.php です。スクリプト名を変更するのはおそらく好ましくありません。しかし、変更したい場合は、変更する場所はこの変数です。やろうとしていることを理解してから変更してください。

リダイレクトスクリプト名

$wgRedirectScriptManual:$wgRedirectScript 変数は、MediaWiki でリダイレクトを取り扱う リダイレクト スクリプト への URL パスを指定します。この設定は正確なスクリプト名を設定できる wgScript と似ています。上記で説明したように、本当に何をしようとしているのか理解していない場合、変更するのは好ましくありません。

記事へのパス

$wgArticlePathManual:$wgArticlePath は MediaWiki のページにアクセスする際に使用するパスです。パスはメインスクリプト (通常は $wgScript を使用) へのパスを含み、記事名部分に $1 プレースホルダーを使用します。

プリティURLまたはショートURLを作成するためにApacheのリライトルールを使用する場合、おそらく正しいパスを指し示す$wgArticlePathを調整する必要がある。wgArticlePathはMediaWikiの範囲内からURLを構築ために使用されることに注意。間違いがあった場合、正しいURLを手作業で指定することでメインページにアクセスできるかもしれない一方で内部リンクは不正に表示される。詳細は Manual:Short URL を参照してください。

典型的な値は以下の通り:

"$wgScript/$1" セパレーター「/」による記事名を渡す
"$wgScript?title=$1" パラメーターとして記事名を渡す (古いスタイル)
"/mypath/$1" カスタムパス。「mypath」をメインスクリプトにアクセスする適切なパスに変換するために Apache のリライトルールを使用する

スタイルシートの位置

設置されている MediaWiki インストールのために CSS がある場所への URL を設定するには $wgStylePathManual:$wgStylePath 変数を使用します。$wgStyleDirectoryManual:$wgStyleDirectory 変数は同じ場所を指定しますが、ファイルシステムにアクセスする内部スクリプトで使用されるためのローカルファイルシステムであることにご注意ください。

アップロードの位置

アップロードディレクトリは利用者によってアップロードされたファイルが保存される場所です。$wgUploadPathManual:$wgUploadPath 変数には URL パスを、$wgUploadDirectoryManual:$wgUploadDirectory にはローカルファイルシステムパスを指定します。

ロゴ

$wgLogoManual:$wgLogo は、すべての MediaWiki のページに既定で左上隅に表示されるグラフィカルなロゴを指定します。初期設定で指定されたロゴのディレクトリ /wiki/skins/common/images/ の /wiki を、MediaWiki ソフトウェアをインストールしたディレクトリのパスに置き換えます。

First, copy whatever logo you want into the /wiki/skins/common/images/ directory (replacing /wiki with the path to the directory where you installed the MediaWiki software).

Next, try to find the line that looks like this in LocalSettings.php:

$wgLogo        = "{$wgStylePath}/common/images/wiki.png";

If there's no such line, you can copy and paste the line above at the end of the file.

Then, modify that line to point to your logo. The logo must be web accessible. The value of this variable is passed to the web browser, which uses it to fetch the logo. If in doubt, a good way to pick what to put here is navigate to the logo in your web browser (for example, this wiki the url of the logo is http://upload.wikimedia.org/wikipedia/mediawiki/b/bc/Wiki.png ), and put the full url as the value of this variable.

Some people just replace the skins/common/images/wiki.png file with their logo. This is not recommended, as the customized logo would be overwritten on upgrade.

コンタクト情報

$wgEmergencyContactManual:$wgEmergencyContact 変数は何か問題が発生した際に連絡するための利用者のメールアドレスです。メールアドレスは内部バグ報告を送るために使用されます。管理者として、あなたのメールアドレスをここに掲載しておきます。

$wgPasswordSenderManual:$wgPasswordSender 変数は、パスワードを忘れた利用者にパスワードが送信される際に使用されるメールアドレスです。トラブルや混乱の際に、利用者がメールを送信できるメールアドレスを指定します。

データベースの設定

ページ、利用者情報や多くのものを保存するために MediaWiki はデータベース (現在は MySQLPostgreSQL のいずれか) にアクセスする必要があります。

$wgDBserverManual:$wgDBserver はデータベースのホスト名を含みます。多くの場合、同じシステム上で動作しているデータベースとしては「localhost」が当てはまりますが、さまざまなインストールのために、データベースが動作しているコンピューターの十分に確認されたドメイン名を入力する必要があります。

$wgDBnameManual:$wgDBname は MediaWiki によって使用される データベース名 です。単独の MySQL または PostgreSQL では一つ以上のデータベースを保存することができ、一つのサーバーで多くの MediaWiki を動作させることができます。正しいデータベース名を記載して同じデータベースサーバー上の異なるウィキインストールのために異なるデータベース名を使用することを確認します。

$wgDBuserManual:$wgDBuser 変数と $wgDBpasswordManual:$wgDBpassword 変数はデータベースにアクセスするために MediaWiki によって使用されるログイン名とパスワードを含みます。データベースサーバー上でウィキのテーブルを操作できる適切なアクセス権を指定された利用者が所有することで確認できます。

利用者の権限

$wgGroupPermissionsManual:$wgGroupPermissions は連想配列で、異なる利用者グループのためにページを作成と編集する権限を制限します。この配列において、カスタムパーミッションレベルが作成され、異なる利用者グループのためにパーミッションレベルが設定されます。異なるパーミッションと利用可能な利用者グループについては Help:User rights/ja でより詳細な情報を見ることができます。

大文字リンクの強制

既定では、小文字 (ラテン文字) でページ名は始まらず、最初の文字を大文字に変換されます。リンクターゲット、含まれるページ、画像またはカテゴリは小文字で始まる名前で指定され、実際のターゲットなどは大文字で始まるページに対応します。

代替的にはページ名は大文字、数字に加えて、小文字で始めることができます。そのためには $wgCapitalLinksManual:$wgCapitalLinks 変数を調整しなければなりません。false に設定することで小文字を許可し、true は既定の振る舞いをします。

下位ページの有効化

LocalSettings.php において、$wgNamespacesWithSubpagesManual:$wgNamespacesWithSubpages 変数を使用することで名前空間ごとに下位ページを有効にします。例えばメインの名前空間で下位ページを有効にする場合。

$wgNamespacesWithSubpages[NS_MAIN] = 1;

画像のアップロード

MediaWiki システムにファイルをアップロードすることを利用者に許可する前に、この機能を有効にしなければなりません。アップロードディレクトリが適切に設定され、Apache ウェブサーバープロセスによって書き込み可能でなければなりません。$wgEnableUploadsManual:$wgEnableUploads 変数を true に設定することでウェブユーザーインターフェイスでアップロードすることが可能になります。

次のコードは LocalSettings.php の設定例で includes/DefaultSettings.php から由来しています:

$wgUploadPath       = "$wgScriptPath/uploads";      ## Wiki 1.5 defaults to /images, but allows more than just images
$wgUploadDirectory  = "$IP/uploads";                ## Wiki 1.5 defaults to /images, but allows more than just images

## To enable image uploads, make sure the above '$wgUploadPath' directory is writable by Apache User or group.
## ''(i.e.  chmod og+w uploads images)''  then the following should be true:
$wgEnableUploads       = true;

$wgUseImageMagick      = true;
$wgImageMagickConvertCommand = "/usr/bin/convert";

## If you want to use image uploads under safe mode, create the directories images/archive, images/thumb and
## images/temp, and make them all writable. Then uncomment this, if it's not already uncommented:
$wgHashedUploadDirectory = false;

動作中に素早く画像をリサイズできるようにしてサムネイルをサポートしたい場合、MediaWiki には有効なImageMagickが必要です。ImageMagick をシステムにインストールしてテストが済んだら $wgUseImageMagickManual:$wgUseImageMagicktrue に設定します。$wgImageMagickConvertCommandManual:$wgImageMagickConvertCommandconvert コマンドのインストールの適切な位置を指定し、コマンドがウェブサーバーのプロセスによって実行可能であること、$wgMaxShellMemoryManual:$wgMaxShellMemory が十分に大きいことを確認します。詳細な情報と障害探索の方法は Manual:Image administration#Image thumbnailingManual:Image administration#Image thumbnailing を参照してください。

また、利用可能な拡張子の修正を行いたい場合、次のように $wgFileExtensionsManual:$wgFileExtensions 配列を設定します:

$wgFileExtensions = array('png','jpg','jpeg','ogg','doc','xls','ppt','mp3','sxc','pdf');

ImageMagick で次のようなエラーメッセージが表示された場合。

Fatal error: mime_magic could not be initialized, magic file is not available in includes/MimeMagic.php on line 506

さらに以下の行を LocalSettings.php に追加してみてください:

$wgMimeDetectorCommand = "file -bi";

インターウィキのサポート

インターウィキサポートはMediaWikiに組み込まれていますが、内部リンクのために使用される接頭辞を設定する必要があります。この接頭辞は通常 $wgSitename と同じですが、変更する場合、$wgLocalInterwiki 変数をご希望の名前に設定します。

ユーザーインターフェイスの言語

MediaWikiは様々なローカライズされたユーザーインターフェイスの言語を利用できます。英語ではない言語でウィキを運営する場合、$wgLanguageCode を適切な言語コードに設定します (例えば、ドイツ語なら「de」、スペイン語なら「es」、など)

languages/i18n ディレクトリ内にファイルがあれば、あらゆる言語を使用できます。例えば es.json がある場合は、スペイン語に「 es 」を使用できます。先頭が大文字の「Es」を使用しないでください。動作するかもしれませんが、すべてのテキストが翻訳されていないこともあります。

Note: After changing the language code, you will need to run a PHP script to make it work. In a terminal window, change to your wiki directory, change to the maintenance folder, and enter php rebuildMessages.php --rebuild. On Windows, the PHP folder might not be in your PATH environment variable and you'll have to prefix php with the path to the program.

Not all languages are supported. See here for a list of the localisation statistics of 1.31.0-wmf.12 (5056cef). See translatewiki.net for the statistics per released version.

サイトのための著作権の設定

サイトの著作権宣言を修正するために次の行をLocalSettings.phpに追加します:

$wgRightsPage = "YourWiki:Copyright"; 
$wgRightsText = "copyright YourWiki";

後で適切なメッセージを表示するためにMediaWiki:Copyrightを編集します。"$1"を使用して著作権ページへのリンクの位置を示します。

例: クリエイティブ・コモンズライセンスを設定します

クリエイティブコモンズライセンスを設定するために以下のように行います:

 <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/3.0/">
 <img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights30.png" />
 </a>
 This work is licensed under a
 <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/3.0/">
 Creative Commons Attribution-NonCommercial-ShareAlike 3.0 License</a>.
  • $wgRightsURLのために、最初のアンカーからhref情報を入力します:
$wgRightsUrl = "http://creativecommons.org/licenses/by-nc-sa/3.0/";
  • $wgRightsTextのために2番目のアンカーからテキストを入力する(文法的に正しいバージョンであるために"a"をウィキ変数に追加します)
$wgRightsText = "a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 License";
  • $wgRightsIconのために最初のアンカーのimgリンクからソースの情報を入力します。Crative Commonsサイトからあなたのサイトにバッジをコピーしたい場合は以下のコードを追加します。
$wgRightsIcon = "http://creativecommons.org/images/public/somerights30.png";
  • 著作権についてのRDFメタデータを使用するためには、LocalSettings.phpに次の行を追加します。
$wgEnableCreativeCommonsRdf = true;
$wgEnableDublinCoreRdf = true;

カスタムの名前空間

$wgExtraNamespacesManual:$wgExtraNamespaces 配列を宣言して $wgNamespacesWithSubpagesManual:$wgNamespacesWithSubpages$wgNamespacesToBeSearchedDefaultManual:$wgNamespacesToBeSearchedDefault 配列を修正すると、 MediaWiki インストールに名前空間を追加できます。また $wgNamespaceAliases 配列を宣言すると名前空間のエイリアスを追加できます。同じ名前空間で既に命名したページ、例えば「Technical:Support」というページがあるのに「Technical:」という名前空間を作成すると、そのページは消え、そればかりか Special:Allpages から除去できなくなることに留意が必要です。これを修正するにはまず名前空間を削除、「Technical:Support」をメインの名前空間の「Support」に移動させてリダイレクトを削除します。次に名前空間を再び作成して「Technical:Support」に戻します。 詳細な情報はCustom namespacesをご覧ください。

外装

サイトの既定の外装 (スキン) は $wgDefaultSkinManual:$wgDefaultSkin 変数で修正できます。

関連項目