INSTALL.txt

   1 名前
   2     PukiWiki  - 自由にページを追加・削除・編集できるWebページ構築スクリプト
   3
   4     Version 1.5.3
   5     Copyright
   6       2001-2020 PukiWiki Development Team
   7       2001-2002 yu-ji (Based on PukiWiki 1.3 by yu-ji)
   8     License: GPL version 2 or (at your option) any later version
   9
  10 インストール
  11     PukiWikiはPHPスクリプトであるため、(例えばPerlのように)スクリプトに実行権
  12     を付ける必要はありません。CGI起動でないのであれば、スクリプトの一行目を修
  13     正する必要もありません。
  14
  15     Webサーバーへのシェルアクセスが可能であれば、PukiWikiのアーカイブをそのま
  16     まサーバーに転送し、サーバー上で解凍(tar pzxf pukiwiki*.tar.gz) するだけ
  17     でパーミッションの設定も行われ、すぐに使い始める事ができるでしょう。
  18
  19     スクリプトの中の日本語は(あれば、基本的に)UTF-8で、また改行コードはLFで
  20     記述されています。スクリプトを直接編集する場合は、日本語文字コードと改行
  21     コードの自動判別ができ、それを元のまま保存できるテキストエディタを使用し
  22     て下さい。
  23
  24     以下に、事前にクライアントPCで作業を行う場合の例を記します。
  25
  26     1. PukiWikiのアーカイブを展開します。
  27
  28     2. 設定ファイル(*.ini.php)の内容を確認します。何も修正せずとも動作します
  29        が、公開された場所に設置するのであれば、念のため事前に管理者パスワード
  30        を修正して下さい。
  31
  32        設定ファイルのほとんどの項目は pukiwiki.ini.php に集約されています。
  33
  34         全体設定           : pukiwiki.ini.php
  35         ユーザ定義         : rules.ini.php
  36
  37        その他、ユーザーエージェントごとの設定が用意されています。
  38
  39         デスクトップPC     : default.ini.php
  40         携帯電話およびPDA  : keitai.ini.php
  41            (旧 i_mode.ini.php/jphone.ini.php)
  42
  43       PukiWikiの管理者パスワードは、pukiwiki.ini.php にある変数 $adminpass
  44       です。簡単に試すだけであるならば、以下のような内容で充分でしょう。
  45       ('YourPassWord' の部分を、あなただけのキーワードで置き換えて下さい)
  46
  47          $adminpass = '{x-php-md5}' . md5('YourPassWord');
  48
  49       ※設定を「有効にする」とは、多くの場合、設定値を数字の 0 でない値(例え
  50         ば1)にする事です。一部の設定は名前に DISABLE ないし $noXXX とあります
  51         が、それらは値を 0 でないものにすることで、その設定値に対応する機能が
  52         無効になります。(無効にする役割が有効になります)
  53
  54       ※インターネットに公開するPukiWikiであるならば、PKWK_SAFE_MODE を有効に
  55         することをお薦めします。(詳細:BugTrack/787)
  56
  57       ※他人に編集させない環境をご要望であれば、PKWK_READONLY を有効にするこ
  58         とをお薦めします。(詳細:BugTrack/744)
  59
  60     3.  ファイルをFTPなどでサーバに転送します。
  61       基本的に何の変換も行わず、「そのまま」転送して下さい
  62       ・ファイル名や、ファイル名の大文字小文字などを変更しないで下さい
  63       ・FTPの転送モードは「バイナリ(bin)」を使用して下さい
  64
  65     4.  サーバ上のファイルおよびディレクトリのパーミッションを確認します。
  66
  67     ディレクトリ パーミッション
  68       attach         777        添付ファイル格納ディレクトリ
  69       backup         777        バックアップファイル格納ディレクトリ
  70       cache          777        キャッシュファイル格納ディレクトリ
  71       counter        777        カウンタファイル格納ディレクトリ
  72       diff           777        差分ファイル格納ディレクトリ
  73       image          755        画像ファイル
  74       image/face     755        (画像ファイル)フェイスマーク
  75       lib            755        ライブラリ
  76       plugin         755        プラグイン
  77       skin           755        スキン、CSS、JavaScirptファイル
  78       wiki           777        データの格納ディレクトリ
  79
  80     ファイル    パーミッション データの種類(参考)
  81       .htaccess      644       ASCII
  82       .htpasswd      644       ASCII
  83       */.htaccess    644       ASCII
  84
  85     ファイル    パーミッション データの種類(参考)
  86       *.php          644       ASCII
  87       */*.php        644       ASCII
  88       attach/*       666       BINARY (はじめは存在せず)
  89       backup/*.gz    666       BINARY (インストール時は存在せず)
  90       backup/*.txt   666       ASCII  (多くの環境では存在せず)
  91       cache/*        666       ASCII
  92         (一部のプラグインはバイナリファイルを保存します)
  93       counter/*      666       ASCII  (はじめは存在せず)
  94       diff/*.txt     666       ASCII  (はじめは存在せず)
  95       wiki/*.txt     666       ASCII
  96       image/*        644       BINARY
  97       image/face/*   644       BINARY
  98       lib/*          644       ASCII
  99       plugin/*       644       ASCII
 100       skin/*         644       ASCII
 101
 102     5. サーバーに設置した PukiWiki の index.php あるいは pukiwiki.php に、Web
 103       ブラウザからアクセスし、PukiWikiが動作するか様子を見ます。
 104
 105       ※エラーが出る場合: 下記を参照して下さい
 106
 107     6.  必要に応じて、さらに設定やデザインを調整して下さい。
 108
 109       ※CSS(外見)は skin/スキン名.css にあります。どのようなCSS
 110         が求められているかはスキンに記述されています。
 111       ※スキン(外見の骨組み)に関する設定項目は skin/スキン名.skin.php の先頭に
 112         あります。
 113       ※プラグイン独自の設定項目は plugin/プラグイン名.inc.php の先頭にありま
 114         す
 115       ※tDiaryテーマ(tDiaryスキン)の使用法は BugTrack/769 を参照して下さい。
 116
 117 エラーが出る場合
 118     CGI版のPHPが設置されたサーバー(特にsuExecと組み合わされている環境)で動作
 119     させようとした場合に "Internal Server Error" などと表示される場合がありま
 120     す。詳しくはサーバー管理者がPHPスクリプト向けに提供している情報を確認して
 121     下さい。
 122
 123       1. 実行するPHPスクリプト(PukiWikiの場合 index.php か pukiwiki.php)の
 124         一行目に、PHPバイナリへのパスを追加する必要があるかもしれません。
 125         (例: #!/usr/local/bin/php)この値はサーバーにより異なります。
 126
 127       2. たいていの場合、より厳密なパーミッションが求められます。
 128
 129 エラーが出る場合: .htaccessファイル
 130     PukiWiki 1.4.4 から .htaccess ファイルを添付する様になっていますが、
 131     Apache Web サーバーの設定によっては "Internal Server Error" を起こす場合
 132     があります。
 133
 134     具体例:
 135       Webブラウザに "Internal Server Error" と表示され
 136       Webサーバーのエラーログには "order not allowed here" というエラーが記録
 137       される
 138
 139     これはPukiWikiを設置したい場所で .htaccess による設定変更が許可されていな
 140     い(特に "AllowOverride Limit" でない)のが原因です。
 141
 142     回避策: .htaccess、および skin/.htaccess を削除する
 143
 144     解決策：
 145       Apache設定ファイル(httpd.conf)の、PukiWikiを設置したいディレクトリに関
 146       する部分に "AllowOverride Limit" を追加する
 147
 148 エラーが出る場合: Parse error
 149     "Parse error: parse error, unexpected XXXX in .... on line NNN"
 150
 151     PHPスクリプトに矛盾がある場合、このようなメッセージが表示されます。指定さ
 152     れているファイルの、指定された行の付近をチェックし、問題があれば修正して
 153     下さい。理由としては以下のようなケースが考えられます。
 154
 155       1. 末尾にあったセミコロンを消してしまった
 156
 157       2. 文字列をシングルクォートかダブルクォートで囲むはずが、片方を消して
 158          しまった / 文字列の中に(文字列を囲んでいるのと同じ)シングルクォート
 159          やダブルクォートがある
 160
 161 エラーが出る場合: Runtime error
 162     Error message : Directory is not found or not writable (xxx_DIR)
 163
 164     データを書き込むディレクトリ(やファイル)に書き込み権限が無い場合、このよ
 165     うなメッセージを表示します。xxx_DIR がどこにあたるかは、設定ファイルで同
 166     名の定数を定義している部分を参照して下さい。
 167
 168 バックアップとリストア
 169     ページの最新データを収めているディレクトリ(デフォルトの名前は wiki)以下
 170     を、また必要に応じて他のデータを収めているディレクトリ以下をバックアップし
 171     て下さい。(同 attach, backup, cache, counter, diff)
 172
 173     cacheディレクトリもバックアップすることをお薦めします。
 174     1. cache/*.rel ファイルと cache/*.ref ファイルは linksプラグイン で再生
 175        成可能ですが、この処理は非常に重く、環境によっては処理が必ず失敗する
 176        (中断する)場合があります。
 177     2. cache/*.rel ファイルがPukiWikiに全くない時に既存のページを編集すると、
 178       linksプラグインを実行した状態とほぼ同等の負荷がかかります。
 179       (詳細:BugTrack2/56)
 180     3. amazonプラグインはここに画像(のキャッシュ)を保存します。
 181
 182     データを配置した時は、ファイルのパーミッションが期待されている通りかどう
 183     か、また実際に動作するかどうかを確認して下さい。(例: 配置したページの更新
 184     を試みる)
 185
 186     PukiWiki 1.4.5 以降では、添付されている dumpプラグイン で、wiki/attach/
 187     backup ディレクトリのリモートバックアップ(*.tar.gzないし*.tar形式)が可能で
 188     す。
 189       起動の例: index.php?plugin=dump
 190
 191     dumpプラグインにはdumpプラグインで取得したファイルの中身をPukiWikiに展開す
 192     る機能(リモートリストア)も用意されています。ただしファイルに含まれていない
 193     データをPukiWikiから削除する機能はありません(常に上書きになります)し、Web
 194     サーバーやPHPのアップロードファイルサイズ制限を越えるファイルを利用するこ
 195     とはできません。またこの機能はデフォルトで無効になっています。
 196
 197     その他、PukiWikiの更新内容をメールで通知する機能は、既存のデータを失わない
 198     ための機能としてとらえる事ができるでしょう。