DokuWikiの特徴のほとんどは、様々な設定オプションを通して変更することができます。これらのオプション変更の簡単な方法は、設定マネージャーを使うことです。
このページは、有効な設定や可能な値を説明しています。すべてのデフォルトの値は、conf/dokuwiki.phpというファイルに格納されています。もし、設定を変更したい場合は、conf/local.phpというファイルを編集してください。このファイルは、後のアップグレードでも上書きされずに設定が保持されます。設定マネージャーもこのファイルを使用します。
conf/local.phpのサンプルです:
<?php $conf['title'] = "Admin's Wiki"; $conf['useacl'] = 1; $conf['superuser'] = 'admin'; ?>
設定ファイルにいくつかの注意があります。ファイルは、PHPコードの一部です。そのため、PHP文法で保持されます。それぞれの行は、セミコロンで終わっていなければなりません。変数には以下に示すとおりいくつかの型があります。
9'foo bar'trueかfalse、または1か0のどちらかです。| |
|---|
| このページの記載を変更してもWikiの設定オプションには反映されません。マニュアルの改善のためにだけ編集してください。 |
インストールしたWikiの名前を指定します。お好きなタイトルを指定してください。同じサーバに複数のDokuWikiをインストールする場合に、それぞれに異なるタイトルを付けることができます。
DokuWiki各名前空間(ルート名前空間を含む)のデフォルトページの名前を指定します。ページ名が指定されない場合にここで指定した名前のページ(ホームページ)が読み込まれます。
startこのオプションは、インタフェースで使用する言語を指定します。詳細はMultilanguage Supportを参照してください。
enファイルの保存先のパスを指定します。次の「ベースディレクトリ」で指定するディレクトリからのファイルシステム上の相対パスを指定します。このディレクトリは、Webサーバから書き込み可能でなければなりません。
./dataこのディレクトリ配下には複数のサブディレクトリとchangelogが存在します。以下に示す設定ファイルのパラメータを設定することで、サブディレクトリやchangelogの配置を変更することができます。
| パラメータ | savedir配下のデフォルト配置 |
|---|---|
| datadir | pages |
| olddir | attic |
| mediadir | media |
| cachedir | cache |
| lockdir | locks |
| changelog | changes.log |
| metadir | meta |
通常、DokuWikiはインストール先のディレクトリを自動検出します。しかし、さまざまな理由で自動検出がうまくいかない場合があります。Webページの画像を見つけられないなど、DokuWikiが正常に機能しない場合ここでディレクトリを指定してみてください。
ここで指定するパスは、サーバのドキュメントルートからDokuWikiのインストールディレクトリまでの絶対パスです。たとえば、WikiのURLがhttp://www.yourserver.com/dokuwiki/である場合は、「ベースディレクトリ」に/dokuwiki/を指定します。先頭と末尾のスラッシュを忘れないように注意してください。
プロトコル部を含むサーバのURLを指定します(指定しない場合は自動検出)。
ここで指定するパスは、サーバのドキュメントルートです。WikiのURLがhttp://www.yourserver.com:port/dokuwiki/である場合は、「ベースURL」にはhttp://www.yourserver.com:portを指定します(末尾のスラッシュは付けない)。
注意: ':port'の部分はWebサーバが標準ポート以外(ポート番号80以外)で動作している場合にポート番号を指定します。標準ポートで動作しているWebサーバの場合は、この部分は省略可能です。
このオプションはディレクトリが作成されるときのパーミッションを設定します。このオプションには、ディレクトリに設定するモードの8進数(文字列ではなく0で始まる数値)で指定します。デフォルトでは、UNIXの0755(rwxr-xr-x)のパーミッションでディレクトリが作成されます(パーミッションの数値については次の「ファイル作成マスク」の説明を参照)。
0755この設定は、Windowsサーバーには影響しません。設定に当たってはSetting up file permissionsおよびセキュリティのページをよく読んでください。
このオプションは、作成したいファイルのパーミッションを指定します。ここで設定する値は、8進法で指定します(数値は常に0から始まります)。デフォルトは、UNIXの0644(rw-r–r–)のパーミッションでファイルが作成されます。
0644この設定は、Windowsサーバーには影響しません。設定に当たってはSetting up file permissionsおよびセキュリティのページをよく読んでください。
最初のゼロではない数値(上記のデフォルトは6)は、ユーザー(ファイルの所有者)のパーミッションを決定します。2つ目の数値はグループのパーミッションで、最後の数値は、その他(つまり他の全部)のパーミッションです。パーミッションを適切な数値に変換するには、次のキーを使います。
そして、各グループについて上記の数値を合計します。たとえば、ファイルを所有するユーザーに読み書きのパーミッションを与えるには、ゼロの後の最初の数字に4+2=6を指定します。また、ファイルが所属するグループに読み込みと実行のパーミッションを与えるには、ゼロの後の2番目の数字に4+1=5を指定します。したがって、デフォルトのパーミッション値は、userに読み込みおよび書き込みパーミッション、groupとothersに読み込み専用パーミッションを与えるものと解釈されます。
サポートの対応をスムーズにするために、DokuWikiにはリクエストに対する詳細なデバッグ文字列を出力する機能を持っています。デバッグ出力を得るには、次の例のようにURLに”/?do=debug”(文字”を除く)を付加します。
http://hostname.domain/your-dokuwiki/doku.php?id=playground&do=debug
この機能は、Wikiの最初にセットアップで発生するさまざまな設定の問題を解決するのに非常に役立ちます。しかし、同時にDokuWikiが稼働しているサーバに関する情報の漏洩にもつながります。
セキュリティ確保のため、適切にWikiをセットアップし終えたらこのオプションをオフにしてデバッグ機能を無効にしてください。
0最近の更新で1ページあたりに表示するドキュメントの数を指定します。ここで指定した値は、最近の変更のXML XML Syndicationに出力されるアイテムのデフォルト値、XML XML Syndicationのドキュメントリストに出力されるアイテム数としても使われます。
20Breadcrumbsトレースに表示される閲覧履歴の数を指定します。0を指定すると閲覧履歴の表示が無効になります。
10上記の「トレース」とは異なり、名前空間の階層を示すパンくずリストを表示します。この機能を使う場合、上記の標準のパンくずリストは無効にしてもよいでしょう。
0このオプションをオンにすると、表示されているドキュメントのファイルシステム上のフルパスが表示されます。
特定の文字の組み合わせを対応する正しい活字に置き換えます。
1
日付のフォーマットを指定します。ここで設定した値は、PHPのdate関数にそのまま渡されます。たとえば、%d.%m.%Y %H:%iのように設定してもよいでしょう。
%Y/%m/%d %H:%Mログインユーザーの署名がどのように表示されるかを設定します。strftime関数で定義されているすべての変数と以下に示す特殊変数を使用できます。
| 変数 | 変換結果 |
|---|---|
| @USER@ | ユーザーのログイン名 |
| @NAME@ | ユーザーの氏名 |
| @MAIL@ | ユーザーのe-mailアドレス |
| @DATE@ | dformオプションの指定によってフォーマットされた現在の日付 |
--- //[[@MAIL@|@NAME@]] @DATE@//
もう少し短い形式にしたい場合は、 --- //[[@MAIL@|@USER@]] %b%e//のように設定するとよいでしょう。また、ユーザーのページを用意したい場合は、 --- //[[user:@USER@|@NAME@]] @DATE@//のように設定します。
自動生成される目次のトップレベルとなる見出しレベルを指定します。
1自動生成される目次の最下位となる見出しレベル(最大値)を指定します。
30を指定すると目次の生成が無効になります。
個別に編集可能なセクションとして扱う最下位の見出しレベル(最大値)を指定します。
30を指定するとページ内に表示されるEditボタンが無効になります。
キャメルケース(ラクダ記法)リンクを有効にするかどうかを指定します。キャメルケースリンクはWikiでリンクを作成する方法として一般的ですが、その善し悪しについては議論の分かれるところです。このオプションをいったん有効にした後、再度無効にすると孤立ページができてしまうことがありますので注意してください。
0
このオプションを1に設定すると、ページ名に含まれるアクセント記号付きの文字を、対応する同等のアクセント記号のつかないASCII文字に置き換えられます。たとえば、はueに、はaに置き換えられます。2を設定するとページ名のRomanizationが有効になり、非ラテンアルファベットのシンボルを近似のASCII文字に置き換えられます。0を設定すると両方の機能が無効になります。
0-2)1このオプションを有効にすると、Wikiページ名へのリンクに関する以下のものについて、ページ内で最初に現れる見出しを使うようになります。
詳細については、Using the first heading as the page nameを参照してください。
0メディアファイルを削除する際に被参照をチェックするかどうかを指定します。
1参照元をいくつ表示するかを指定します(5を設定するのが適切でしょう)。
5このオプションをオンにするとアクセスコントロールを利用してユーザごとにWikiに対する操作を制限することができます。
0DokuWikiは、新規ユーザーが登録された後にパスワードを処理する2種類の方法をサポートしています。この設定オプション変数は、パスワード処理にどちらの方法を使うかを指定します。
1)autopasswdを1に設定してください(DokuWikiがすべてのメールを送信するときに使う”From” アドレスは、mailfromオプションにより設定できます)。0)autopasswdを0に設定してください。1 認証の際に使用するバックエンド機構を指定します。
DokuWikiはいくつかの認証バックエンド機構をサポートしています。詳細については、Authentication Methodsを参照してください。
plainパスワードは暗号化したハッシュとして保存する必要があります。DokuWikiは複数のハッシュ方式をサポートしており、このオプションではそのうちどの方式を使うかを指定します。どの方式を選択したらよいかは、管理者が要求するセキュリティレベルや既存の認証データベースを利用するかどうかによって異なります。DokuWikiは使用された暗号化パスワードからどの方法が使われているのか判断することができるので、バックエンド機構がサポートしている方式であればいつでも暗号化方式を変更できます。
saltによるハッシュ化を利用する場合は、ユーザーが最初にパスワードを割り当てられたとき、およびパスワードを変更したときにランダムsaltが生成されます。saltはパスワード内に格納されます。DokuWikiがsaltを適用できるかどうかは、使用する認証バックエンド機構に依存します。
利用できる方式は下の表のとおりです。
| オプション | 説明 |
|---|---|
| smd5 | salt付きMD5ハッシュ |
| md5 | 単純なMD5ハッシュ(古いバージョンで使われていた方式) |
| sha1 | SHA1ハッシュ |
| ssha | salt付きSHA1ハッシュ(LDAPで使われている方式) |
| crypt | Unixのcrypt関数 |
| mysql | バージョン4.1.1以前のMySQLで使われていたパスワード |
| my411 | バージョン4.1.1以降のMySQLで使われているパスワード |
smd5
サインアップを完了したユーザーが自動的に参加するグループを指定します(openregisterを使う場合)。
userDokuWikiのスーパーユーザー権限を持ったユーザーを設定します。スーパーユーザーはACLの制限に関わらず、全ての権限を持っています。ACLの制限そのものを編集することも出来ます。いわゆるrootのようなものです。
このオプションにはユーザ名またはグループ名(グループ名の場合は名前の先頭に@を付ける)を指定します。
!!not set!!注意: 現行バージョンでは、ユーザー名かグループ名に特殊記号を使っている場合は、以下の表に基づいて変換して記述する必要があります。
表の記述は現状の動作と食い違っているようです。たとえば、@wiki%5fwriteと設定すると@wiki%255fwriteに二重にエンコードされます。
| Space | %20 | ! | %21 | ” | %22 | # | %23 | $ | %24 | % | %25 | & | %26 | ' | %27 | ( | %28 | ) | %29 | * | %2a |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| + | %2b | , | %2c | - | %2d | . | %2e | / | %2f | : | %3a | ; | %3b | < | %3c | = | %3d | > | %3e | ? | %3f |
| @ | %40 | [ | %5b | \ | %5c | ] | %5d | ^ | %5e | _ | %5f | ` | %60 | { | %7b | | | %7c | } | %7d | ~ | %7e |
例: ユーザー名がadmin@foo.barの場合は、このオプションにはadmin%40foo%2ebarを設定します。グループ名の先頭に付ける@はエンコードしないでください。
DokuWikiのマネージャー権限を持つユーザーを指定します。マネージャーは、Revert Managerなど管理メニューのうちの一部の権限にアクセスできます。
ユーザ名または先頭に@を付けたグループ名を指定します。
!!not set!!DokuWikiのユーザ情報を更新するときに確認のために現在のパスワードを要求するかどうかを指定します。
このオプションにemailアドレスを指定すると、Wikiに新しいユーザの登録があったときにそのアドレスにお知らせが送信されます。
''?do=something''コマンドのいくつかを無効にします。
たとえば、indexmenuプラグインを導入した場合に、$conf['disableactions']=“index”と設定することですべてのページのデフォルトの索引を無効にすることができます。
アクションのリストは、設定マネージャプラグインをご覧ください。
このオプションを有効にすると、ユーザーが特定の名前空間読み取り権限を持たない場合、そのユーザーにはその名前空間の索引が表示しないようにします。下位階層の名前空間が上位の名前空間より高い権限を要求する一般的なケースでは、この設定によって索引ページの表示が乱れることがあります。完璧主義者にしかお勧めしません。
BlacklistingによるWikiスパム対策を有効にします。
1
外部リンクに<a rel=“nofollow” …>のようにrel=“nofollow”を使うかどうかを指定します。
nofollowについては、このページや、別の視点から書かれたこのページが参考になります。
1
ページの作成/編集の後、検索エンジンのインデックス化を許可するまでの時間を秒で指定します。
このオプションで指定した秒数が経過するまでは、ページの出力に<meta name=“robots” content=“noindex,follow” />を追加することで検索エンジンのインデックス化をブロックします。
60*60*24*5 (5日)メール収集ロボット対策としてメールアドレスの難読化を行うかどか、および行う場合の方式を指定します。
visible – @を[at]に、.を[dot]に、-を[dash]にそれぞれ置き換えるhex – 16進数値参照によりアドレスをエンコードするnone – 難読化を行わないhexメディアマネージャーによるHTMLのアップロードによる攻撃(ほかのHTMLでないファイルに隠されている場合にも有効)からWikiを保護します。この機能はMicrosoft Internet Explorerのバグ対策です。
自動保存(ドラフト)機能を有効にするかどうかを指定します。
1
<html>タグによるHTMLの埋め込みを許可するかどうかを指定します。このオプションをオンにすると、間違ったHTMLの挿入でレイアウトが崩れたり、XHTMLへの準拠が失われる場合があります。
このオプションをオンにすると、自由にアクセスできるサイトでは重大なセキュリティ上の問題となりますので注意してください。
0
<php>タグによるPHPの埋め込みを許可するかどうかを指定します。
このオプションをオンにすると、自由にアクセスできるサイトでは重大なセキュリティ上の問題となりますので注意してください。
0このオプションには、ページが追加されたり更新されたときに通知するemailアドレスを指定します。空文字列を指定した場合は通知メールは送信されません。複数のメールアドレスを指定するには、各エントリをコンマ(',')で区切って記述します(DokuWikiがすべてのメールを送信するときに使う”From” アドレスは、mailfromオプションにより設定できます)。
特定のページについての更新通知機能(notityオプションと類似の機能)を有効にするかどうかを指定します。このオプションをオンにすると、ログインユーザに対して「変更履歴配信の登録」ボタンが表示されるようになります(DokuWikiがすべてのメールを送信するときに使う”From” アドレスは、mailfromオプションにより設定できます)。
ファイルロックの存続期間を指定します。詳細はPage Lockingを参照してください。
15*60 (15分)ページキャッシュの存続期間を秒で指定します。詳細はCachingを参照してください。
60*60*24 (1日)このオプションはリンクの種類ごとにHTMLでのtarget属性の値を設定します。target属性の値は、Webブラウザに要求されたリンクをどのウィンドウで開くかを指示します。target属性の値が空の場合は同じページでリンク先を開きます。
可能な配列のキーを以下に示します。
wikiinterwiki : InterWikiリンクに対する指定externmedia : アップロードファイルに対する指定windows : Windows共有に対する指定target属性として指定できる値を以下に示します。
_blank : リンクを新しいウィンドウで開く_selfまたは空文字列 : リンクを同じウィンドウで開く_parent or _top or framenameなどの値は、フレームを使ったテンプレートを利用している場合に指定する。指定すべき値はフレームの設定によって異なる
PHPのlibGDが利用できる場合、DokuWikiはこのライブラリを使用してimagesをリサイズします。DokuWikiは利用できるlibGDのバージョンを自動的に検出しますが、PHPのバージョンが古い場合、検出に失敗します。このオプションではそうした場合にバージョンを強制的に指定できます。指定できる値は、'0'(libGDサポートなし)、'1'(libGD 1.xを使用)、または'2'(自動検出によるlibGD 2を使用)のいずれかです。
DokuWikiはデフォルトではPHPのlibGDライブラリ(上記参照)を使用しますが、さらに強力な機能を持ったImageMagickを使用することもできます。ImageMagickを利用できる環境は限られますが、もし利用できるならこのオプションでパスを指定することでlibGDの代わりにImageMagickを利用できます。
jpgのリサイズ画像を作成する際の圧縮品質を指定します。小さい値を指定すればファイルサイズが小さくなりますがjpg圧縮による劣化が生じます。0~100までの値を指定できます。
fetch.phpが外部からダウンロードする際の最大サイズを指定します。この値は外部画像を必要に応じてリサイズしてキャッシュする際に使われます。この機能を完全に無効にする場合は、0を指定します(セキュリティページでは0を指定するように推奨)。
0新リリースのメッセージをチェックするかどうかを指定します。詳細はUpdate Checkを参照してください。
1ナイスなURLに書き換える機能を利用するかどうかを指定します。Apacheのmod_rewriteモジュール、またはDokuWikiによるURL書き換えが利用できます。
0指定できる値は以下のとおりです。
| 値 | 情報 | URLの例 |
|---|---|---|
| 0 | URL書き換えを行わない(デフォルト) | http://example.com/dokuwiki/doku.php?id=wiki:syntax |
| 1 | ApacheモジュールによるURL書き換えを行う(.htaccessファイルの編集が必要) | http://example.com/dokuwiki/wiki:syntax |
| 2 | DokuWikiによる書き換えを行う | http://example.com/dokuwiki/doku.php/wiki:syntax |
詳細についてはURLの書き換えを参照してください。
上記のURL書き換えを有効にした場合、このオプションを設定することでURL中の名前空間の区切り文字をコロンからスラッシュに置き換えることができます。
0この設定オプションは、ページIDに含まれる単語の区切り文字を指定します。ページIDに含まれる有効でないページ文字はこのオプションで指定した文字に置き換えられます。
ページIDとはURLのうちのページを指定する部分を指します。たとえば、doesn't existというリンクは、www.dokuwiki.org/wiki:doesn_t_existというURLになります。このうちのwiki:doesn_t_existの部分がページIDです。sepcharのデフォルト値は'_'なので、リンクに含まれるアポストロフとスペースが'_'に置き換えられています。
sepcharを別の文字に変更することで、'_'を別の文字に変えることができます。sepcharに指定できる有効な文字は、ページIDとして有効な文字、すなわち英字、数字、アンダースコアー(_)、ダッシュ(-)、およびドット(.)です。sepcharには正確に1文字だけを指定してください。
このオプションの扱いには注意が必要です。このオプションを変更すると、以前のsepcharの設定のときに作成したページにアクセスできなくなります。新規ページを作成するとそのページIDがページの内容を保存するファイルの名前になります。sepcharの設定値が'_'のときにページを作成し、後に'-'に変更すると、以前の設定のときに作成したページへのリンクは新しい設定に基づくURLに変わるのに対して、ファイル名は変更されないためにリンクが壊れてしまうためです。
_
このオプションを有効にすると、リンクがhttp://server/pathのような絶対URLになります。以前のDokuWikiでは絶対URLがデフォルトでしたが、現在ではサーバルートからの相対URLの方が望ましいでしょう。
0
このオプションはおそらく英語のWikiにのみ有益です。このオプションに1を設定すると、単数形のリンクページが見つからない場合、自動的に複数形のページを試みます(逆も同様)。したがって、pagenamesとpagenameは、存在する同一のページに自動的にリンクされます。
0DokuWikiから送信されるメールの送信者アドレスを指定します。使用するメールサーバがここで指定したメールアドレスを受け付けることが必要です。このオプションを指定しない場合は、PHPのデフォルトアドレス(通常はwebserveruser@webserverhostname)が使われます。
CSSとJavaScriptから空白文字とコメントを取り除くシンプルな圧縮を有効にするかどうかを指定します。compressionオプションとは異なりますので注意してください。混乱を避けるためコンパクト化と呼ばれることもあります。
gzipまたはdeflateによるコンテンツエンコーディングを扱うことができるブラウザに対して、圧縮したページをネットワーク経由でページを送信するかどうかを指定します。Apacheのmod_gzipなどの外部ツールによる圧縮を適用する場合は、この設定を無効にしてください。
特定のページを自動リスト(RSS、最近の更新、検索結果、索引)からフィルタするための正規表現を指定します。このオプションは、特定のページをサイドバーのテンプレートなどから除外したいときに役立ちます。指定した正規表現は、先頭にコロンの付いたページIDとマッチされ、マッチした場合そのページは非公開ページとみなされます。このオプションは、セキュリティ対策というよりは見た目を整える目的で使用します。
誰かが存在しないページへのリンクをたどった場合、DokuWikiは通常の200 HTTP応答を返します。Wikiとしてはこの動作は望ましいものですが、DokuWikiをCMSシステムとして使う場合には”not found”を表す404応答が望ましいでしょう。このオプションを有効にすることで404応答を返す動作を実現できます。注意: この設定はHTTPステータスを変更するだけで、送出されるコンテンツは変わりません。
ページの古いバージョン(以前のリビジョン)を保存する方法を指定します。デフォルトはgzでgzipにより圧縮しますが、bz2を指定するとbzip2による圧縮を行います。0を指定すると圧縮が無効になります。compressオプションと混同しないように注意してください。
gzリビジョンが作成された後に圧縮方法を変更すると、「以前のリビジョン」ボタンで過去のリビジョンにアクセスすることができなくなるので注意してください。この問題を解決するには、古いリビジョンを変更後の圧縮方法で圧縮しなおすか、古いリビジョンを解凍する必要があります。
DokuWikiは、検索エンジンのGoogleに提出するためのXML サイトマップを自動的に生成することができます。このオプションは、サイトマップを何日おきに再生成するかを指定します。デフォルトではサイトマップを生成しません。詳細はGoogle Sitemapを参照してください。
作成するXMLフィードの種類を指定します。詳細はXML Syndicationを参照してください。
XMLフィードのリンク先を指定します。詳細はXML Syndicationを参照してください。
RSSの更新頻度を秒で指定します。更新頻度の間の時間はキャッシュされたRSSが使用されます。更新ペースが遅いWikiでは、更新頻度の設定値は1時間程度で十分でしょう。詳細はXML Syndicationを参照してください。
グローバルの「最近の更新」リストに何日前までの更新を表示するかを指定します。
フィードのアイテムタイトルに編集サマリーを付加するかどうかを指定します。DokuWikiをブログまたはCMSとして使用している場合は、このオプションをオフにした方がよいでしょう。
このオプションは、PHPのignore_user_abort関数が機能しないプラットフォームのための回避策です。現在のところ、対象となるのはIIS上でPHPがCGIとして稼働しているシステムのみです。
外部への接続のためにWebプロキシを使用するための設定オプションです。詳細はProxy-Supportを参照してください。
このページはConfiguration Optionsの2008/06/10 15:52に更新されたリビジョンを元に翻訳しています。オリジナル文書の新しい更新に気づいた方は、差分を参照してアップデートしてください。
翻訳を更新したら以下に日付つきの署名を追加してください。