
!  目次

* [[CGI としてインストールする場合|#CGI としてインストールする場合]]
* [[サーバにする場合|#サーバにする場合]]

! CGI としてインストールする場合

!! 事前準備
以下のものがインストールされている必要があります．

* [[Ruby]] バージョン 1.6 以降
* テンプレートエンジン [[misen]]
* パーザジェネレータ [[Racc]]

!! 配置先の決定

以下のディレクトリを決定する必要があります．

* <CGIを置くディレクトリ>
* <テンプレートを置くディレクトリ>
* <テーマを置くディレクトリ>
* <データを置くディレクトリ>

<CGIを置くディレクトリ>は CGI が実行可能である必要があります．

<テンプレートを置くディレクトリ>は CGI から読み込み可能である必要があります．

<テーマを置くディレクトリ>は CGI から読み込み可能であり，
かつ Web ブラウザでアクセスできる必要があります．

<データを置くディレクトリ>は CGI から読み書きできる必要があります．
Web ブラウザで直にアクセスできない場所に置くのが望ましいです．


!! ソースコードを展開

 # tar xvfz KakiWiki-x.x.x.tar.gz
または
 # gzip -d -c KakiWiki-x.x.x.tar.gz | tar xvf -
のようにして展開します．

!! ファイルのコピー

#以下のファイルやディレクトリを <CGIを置くディレクトリ> にコピーします．
** kaki.cgi 
** sample.kaki.conf
** sample.htaccess
** src/ 
# template ディレクトリを <テンプレートを置くディレクトリ> にコピーします．
# theme ディレクトリを <テーマを置くディレクトリ> にコピーします．
# data ディレクトリを <データを置くディレクトリ> にコピーします．


!! 設定ファイルの編集
<CGI を置くディレクトリ> に置かれた kaki.conf が設定ファイルとなります．
sample.kaki.conf を kaki.confにコピーして編集します．

以下の変数を設定します．

* data_dir : <データを置くディレクトリ>を絶対パスまたは
<CGIを置くディレクトリ>からの相対パスで記述
* template_dir : <テンプレートを置くディレクトリ>を絶対パスまた
は相対パスで記述
* theme_dir : <テーマを置くディレクトリ>を絶対パスまたは
<CGIを置くディレクトリ>からの相対パスで記述
* theme_base_url : <テーマを置くディレクトリ>を参照できるURLを
設定します(相対URIでも構いません)．

* use_cache : ドキュメントツリーのキャッシュを有効にするかどうかです．
キャッシュを有効にするならば true しないならば false です．
* use_memory_cache : ドキュメントツリーのメモリキャッシュをするかどうかです．
メモリキャッシュを有効にするならば true しないならば false です．

キャッシュの設定は CGI として起動する場合以下の設定がいいでしょう．
 use_cache=true
 use_memory_cache=false

!! CGI としてインストールする場合の例

以下のような条件の場合の手順を説明します．
* HTMLを置くディレクトリ : /home/www/htdocs/
* CGI を置くディレクトリ : /home/www/cgi-bin/
* CGI のユーザ名 : www
* CGI のグループ名 : www
* /home/www/cgi-bin/ 以下には CGI しか置くことができない
(置いてもCGIと見なされてしまう)．

各ディレクトリを以下のように決定します．
* <CGIを置くディレクトリ> を /home/www/cgi-bin/
* <テンプレートを置くディレクトリ> を /home/www/cgi-bin/template
* <テーマを置くディレクトリ> /home/www/htdocs/theme/
* <データを置くディレクトリ> /home/www/kaki_data/

各ファイルをコピーします．
 # gzip -d -c KakiWiki-x.x.x.tar.gz | tar xvf -
 # cd KakiWiki-x.x.x
 # cp kaki.cgi /home/www/cgi-bin/
 # cp sample.kaki.conf /home/www/cgi-bin/kaki.conf 
 # cp sample.htaccess /home/www/cgi-bin/.htaccess
 # cp -r src/ template/ /home/www/cgi-bin/
 # mkdir /home/www/htdocs/theme
 # cp -r theme/* /home/www/htdocs/theme/
 # mkdir /home/www/kaki_data
 # cp -r data/* /home/www/htdocs/kaki_data/
 # su -
 # chown -R www.www /home/www/htdocs/kaki_data/
 # chmod -R o-rwx /home/www/htdocs/kaki_data/


config.rb を編集します．
 # data and conig file directory
 data_dir=../kaki_data
 
 # template 
 template_dir=./template/
 
 # theme
 theme_dir=../htdocs/theme/
 theme_base_url=/theme/
 
 # cache option
 use_cache=true
 use_memory_cache=false



----
! サーバにする場合

!! 事前準備
以下のものがインストールされている必要があります．

* [[Ruby]] バージョン 1.6 以降
* テンプレートエンジン [[misen]]
* パーザジェネレータ [[Racc]]
* Web Server [[WEBRick]]


!! ソースコードを展開

 # tar xvfz KakiWiki-x.x.x.tar.gz
または
 # gzip -d -c KakiWiki-x.x.x.tar.gz | tar xvf -
のようにして展開します．


!! 設定ファイルの編集
展開したディレクトリに置かれた kaki.conf が設定ファイルとなるので
これを編集します．

* data_dir : <データを置くディレクトリ>を絶対パスまたは
相対パスで記述
* template_dir : <テンプレートを置くディレクトリ>を絶対パスまた
は相対パスで記述
* theme_dir : <テーマを置くディレクトリ>を絶対パスまたは
相対パスで記述
* theme_base_url : <テーマを置くディレクトリ>を参照できるURLを
設定します(相対URIでも構いません)．

template_dir, theme_base_url は特に変更しないでいいでしょう．

* use_cache : ドキュメントツリーのキャッシュを有効にするかどうかです．
キャッシュを有効にするならば true しないならば false です．
* use_memory_cache : ドキュメントツリーのメモリキャッシュをするかどうかです．
メモリキャッシュを有効にするならば true しないならば false です．

キャッシュの設定は WEBRick に組込む場合以下の設定がいいでしょう．
 use_cache = true
 use_memory_cache = true

さらに HTTP サーバのポート番号を KakiServ_config.rb に設定します．

 # port number
 $port_number = 8888

!! KakiServ.rb の起動

KakiServ.rb を起動します．

 $ ./KakiServ.rb 


!! WEBRick に組み込む場合の例

以下のような条件の場合の設定を説明します．
* KakiWikiのソースを置くディレクトリ : /home/hoge/KakiWiki
* ポート番号 : 80 番

config.rb の例
 # data and conig file directory
 data_dir=/home/hoge/KakiWiki/data/

 template_dir=/home/hoge/KakiWiki/template/
 
 theme_dir=/home/hoge/KakiWiki/theme/
 theme_base_url=theme/
 
 use_cache=true
 use_memory_cache=true

KakiServ_config.rb の例
 # port number
 $port_number = 80

