config - img0ch-config.cgiの各ディレクティブの解説

# NAME

config - img0ch-config.cgiの各ディレクティブの解説

# SYNOPSYS

# DESCRIPTION

img0ch-config.cgiで利用可能な各ディレクティブの名前とその説明です。

## RepositoryType

レポジトリを保存するためのモジュール名を指定します。以下から選択することになります。 これに該当しない、あるいは値が無い場合はSimpleが選択されます。

Archive

  Simpleにzlibによる圧縮機能をつけて消費サイズを小さくするようにしたエンジンです。 利用可能であればPerlIO::gzipを使用し、そうで無い場合はIO::Zlibを利用します。 短所はSimpleと同じくメモリ消費が大きい点です。

  エイリアス名：Compressed

BDB

  BerkeleyDBを使ったエンジンです。BerkeleyDBを使用する場合さらにBDBHomeを 追加してBerkeleyDBのデータベースを格納するパスを指定する必要があります。

  エイリアス名：BerkeleyDB

CDB

  CDB_Fileを使ったエンジンです。CDBは非常に高速であることを引き換えに 更新及び削除が出来ないため、保存方法はSimpleに似ていますが、 全てのデータをメモリに読み出さないため、スピードとメモリ消費のバランスにとれています。

  エイリアス名：CDB_File

Qdepot

  Depot(QDBMのストレージエンジンのひとつ)を使ったエンジンです。CDBに次いで高速です。 データがある程度大きくなった場合このエンジンの利用を推奨します。 ただし、トランザクションが利用できないため、処理途中でエラーが発生すると 整合性が取れず、中途半端な状態で保存されるおそれがあります。

  エイリアス名:DepotまたはQDBMs

Qvilla

  Villa(QDBMのストレージエンジンのひとつ)を使ったエンジンです。 トランザクションが利用可能ですが、速度はQvillaに比較すると劣ります。

  エイリアス名:Villa

Simple

  デフォルトで使用される単純なエンジンです。モジュール依存度が低いため、移植性が高く、 そこそこ高速ですが、全てのデータをメモリに格納するため、巨大なデータ格納に向いていません。

  エイリアス名：FlatFile

Storable

  Storableを使ったエンジンです。読み出しと書き出しがSimpleより高速になっていますが、 全てのデータをメモリに格納するため、巨大なデータ格納に向いていないというSimpleと同様の 問題があります。

## RepositoryRoot

レポジトリファイルを格納するディレクトリのパスを指定します。レポジトリのファイルは重要な情報が 含まれているため、パスはpublic_htmlの下といった誰でも見られるパスではなく、 public_htmlよりも上といった直接アクセスできないパスに指定するようにしてください。

どうしても訳があって誰にでも見られるパスに指定せざるを得ない場合はそのパスに.htaccess またはRepositoryFileExtensionをcgiに指定してください。 .htaccessの記述例は以下の通りです。

      order deny,allow
      deny from all

指定されたディレクトリは必ず読込、書込、実行それぞれ実行権限をあたえる必要があります。 そのため、パーミッションは0700(エラーが発生するのであれば0707、0777の順に変更)にする 必要があります。

## RepositoryFileExtension

レポジトリファイルに保存する拡張子名を指定します。通常この値を変更する必要はないでしょう。 RepositoryRootを参照してください。

## Renderer

read.cgiの代替となるものを指定します。read.cgiの代わりに標準に含まれている read.htmlに変更したい時にこの値をread.htmlと指定する必要があります。

## UseQueryString

read.cgi以下のパスにPATH_INFOではなくQUERY_STRING形式で表示するかを指定します。 QUERY_STRING形式でパスを表示する場合はこの値を1に設定するようにしてください。

## RendererSeparator

read.cgiまたはread.htmlとパラメータをわける文字を指定します。read.htmlを使う場合は #を入れる必要があります。read.cgiの場合はこのディレクティブの値を入れる必要はありません。

## EnableIDN

IDN(International Domain Name)形式のドメインをリンク対象にするかを指定します。 有効にする場合はこの値を1に指定してください。 Img0ch::Plugin::Rewrite::AutoLinkで利用されます。

## UseFileSeek

携帯からの画像の縮小変換にhttp://www.pic.toを使用するかを指定します。 有効にする場合はこの値を1に指定してください。 Img0ch::Plugin::Rewrite::Imageで利用されます。

## UsePicto

携帯からの動画あるいは音声の変換にhttp://www.fileseek.netを使用するかを指定します。 有効にする場合はこの値を1に指定してください。 Img0ch::Plugin::Rewrite::Imageで利用されます。

## ResMAX

1スレッドの書き込み可能最大数を指定します。指定されない限りは1000になります。

## OmitDefaultNoName

r.cgiで名前がSETTING.TXTのBBS_NONAME_NAMEと合致した場合名前を省略するかを指定します。 有効にする場合はこの値を1に指定してください。

## MobileRenderer

r.cgiの代替となるものを指定します。使用される箇所を除けばRendererとほぼ一緒です。

## Ankers

本文に含むことの出来るアンカー数を指定します。指定されない限りは15になります。

## SambaCount

SAMBAの対象となる書き込み間隔の秒数を指定します。指定されない限りは30になります。

## SambaWait

SAMBA規制が入ったとき次に書き込むことの出来る秒数を指定します。 指定されない限りは3600になります。

## LogStackMax

レス書き込み規制で1ホストで保存可能なログ数を指定します。 多いと書き込み規制確認処理に時間がかかり、規制が厳しくなります。 少ないと書き込み規制確認処理が素早く終わりますが、規制が緩くなります。 指定されない限りは256になります。

## FastWriteMode

レス書き込みでindex.html、i/index.html、subback.htmlの 更新処理を省略するかを指定します。有効にする場合はこの値を1に指定してください。

## RedirectWait

書き込み終了後index.htmlに戻るまでの秒数を指定します。指定されない限りは5になります。

## DefaultCharset

dat等の保存時のエンコーディングを指定します。指定しない限りはShift_JISになります。

## DynamicArchive

過去ログを生成する代わりに過去ログのインデックスからプールされているスレッドを 動的に過去ログに変換するかを指定します。このディレクティブを使用するにはarchive.cgiと mod_rewriteが必要です。 有効にする場合はこの値を1に指定してください。

## ZerominUseGzip

zeromin.cgiに送出するデータ(JSON)をgzipで圧縮するかを指定します。 有効にする場合はこの値を1に指定してください。

## ImageHandler

Img0ch::Plugin::Upload::Thumbnailでサムネイルを作成するための モジュールまたはプログラムを指定します。指定可能な値は以下の通りです。 これ以外の値を指定した場合サムネイルが作成されません。 標準でrepng2jpegが選択されます。

repng2jpeg

  repng2jpegを利用するにはrepng2jpegをSystemPathに配置し、 なおかつ実行可能にする必要があります。 repng2jpegは http://sugachan.dip.jp/download/komono.php で入手可能です。

  移植性が高く、サムネイルの画質が優れていますが、open()関数のパイプを経由して サムネイルを作成するため、セキュリティ的なリスクが他に比べると大きい問題があります。

GD

  GDを利用するにはGDをインストールする必要があります。 そこそこ高速ですが、サムネイルの作成画質が他に比べると劣ります。 また、GDのバージョンが2.15以下の場合gifの縮小画像が作成されません。

PerlMagick

  PerlMagickを利用するにはImage::Magickをインストールする必要があります。 サムネイルの作成画質が優れていますが、多くのメモリが消費されます。

## BBSPath

自分のサイトに設置する全ての掲示板を格納するディレクトリのパスを指定します。 初期設定値は..(testやstatic等が格納されているディレクトリ)です。

## SystemPath

システム全体で利用される設定情報ファイルが格納されているディレクトリパスを指定します。 初期設定値は../_systemです。

## ShellPath

TemplatePathのエイリアスです。TemplatePathを指定するようにしてください。

## TemplatePath

テンプレートのディレクトリ及びファイルが格納されているディレクトリパスを指定します。 初期設定値は../_templateです。

## TemplateEngine

テンプレートを解析するエンジンとなるモジュールを指定します。以下から選択することになります。 これに該当しない、あるいは値が無い場合はHTML::Templateが選択されます。

HTML::Template

  移植性の高い汎用的なテンプレートエンジンです。 使用する場合はTemplateFileExtensionをhtにする必要があります。 (HTML::Templateを使う場合通常TemplateFileExtensionを指定する必要はありません)

HTML::Template::Compiled

  HTML::Templateより拡張性があるHTML::Template互換のテンプレートエンジンです。 HTML::Template::Compiled特有のタグを使用する場合はTemplateFileExtensionを htcにする必要があります。HTML::Templateで利用可能なテンプレートを使用する場合は 設定しなくてもそのまま利用可能です。

ClearSilver

  テンプレートエンジンの核がC言語でかかれた高速なテンプレートエンジンです。 使用する場合はTemplateFileExtensionをcsにする必要があります。

最初から入っているテンプレート(defaultとtype)は上記に挙がっている テンプレートエンジンに全て対応しています。

## TemplateFileExtension

TemplateEngineを参照してください。

## Server

自分のサイトに設置するBBSPathまでの絶対URLを指定します。 この値は設置するサーバーによって異なるため、初期値はありません。

## CGIServer

cgi-binディレクトリまたはCGI実行サーバーでしかCGIが動作しない時にそのURLを指定します。 これによってbbs.cgi及びread.cgi等の*.cgiのパスが変更されますが、専用ブラウザが 利用出来なくなることが発生しうるため、可能であればmod_rewriteを使って回避するべきでしょう。

## Static

CSSやJavaScriptの外部ファイルを格納するディレクトリを指定します。 初期設定値は../staticです。

## EnableXHTMLBreak

<br>を<br />に変換するかを指定します。 これはtype等のXHTMLに準拠するテンプレートに使用することになります。 有効にする場合はこの値を1に指定してください。

## SignatureType

バージョンの表記方法を指定します。以下から選択することになります。 これに該当しない、あるいは値が無い場合はMinorが選択されます。

Product

        img0ch(CGI)

Major

        img0ch(CGI)/2

Minor

        img0ch(CGI)/2.1

Full

        img0ch(CGI)/2.1.0

Debug

        img0ch(CGI)/2.1.0 SVN-rev:1

## BDBHome

RepositoryTypeのBDBを参照してください。

## EnableEditName

ぜろみんでのレス編集に名前の変更を可能にするかを指定します。 指定しない限り名前の編集を行うことは出来ません。

有効にする場合はこの値を1に指定してください。

## TagsRuleConfig

Img0ch::Plugin::BBS::HTMLTagでのタグ使用ルールを記述した ファイル名を指定します。特に指定しない限り、HTML-tags-rule.iniの 名前で読み込みます。

## ZerominScript

zeromin.cgiのスクリプトファイル名を変更したときのファイル名を指定します。 ファイル名を変更しない限りこの値を変更する必要はありませんが、他人から zerominのスクリプトファイル名を推測されることを防ぐためにファイル名を変更する場合、 この値にそのファイル名を指定することによってログインした後zeromin.cgiに アクセスしたために404でアクセス出来なくなる事態を防ぐことが出来ます。

## TemplateCacheRoot

HTML::Template及びHTML::Template::Compiledで生成したキャッシュを 格納するディレクトリを指定します。

指定されたディレクトリは必ず読込、書込、実行それぞれ実行権限をあたえる必要があります。 そのため、パーミッションは0700(エラーが発生するのであれば0707、0777の順に変更)にする 必要があります。

## TemplateCacheRootMode

HTML::Templateで生成されるサブディレクトリのパーミッションを設定します。 ファイルの所有者とCGIの実行者が異なる場合、パーミッションがなくて削除できない場合があります。 そのため、必要であればこの値を変更することになります。設定されない限り700になります。 通常この値は変更する必要はありません。

値を設定するときは必ず3桁の数字、すなわち700といった値にする必要があります。 間違って0700といった値にした場合の結果は不定です。

## Seed

書き込み時のIDの生成、バージョンをMD5関数を使って隠すときに使用する、 サーバー側のパスワードを設定します。この値は極力他人に推測されない任意の値をいれます。

## POP3Server

メール経由の投稿に利用するPOP3サーバーのアドレスを指定します。

## POP3User

メール経由の投稿に利用するPOP3Serverにログインするためのユーザー名を指定します。

## POP3Pass

メール経由の投稿に利用するPOP3Serverにログインするためのパスワードを指定します。

## UseAPOP

POP3サーバーへの認証にAPOPを利用するかを指定します。APOPが利用できるかどうかは メールアドレスを管理するサイトから調べてください。

有効にする場合はこの値を1に指定してください。

## MailPostAddress

メール経由の投稿に利用する投稿先のメールアドレスを指定します。 この値はr.cgiのデフォルトテンプレートのメールリンク(「携帯からﾒｰﾙで投稿する」)に 利用されるため、可能であればHTMLエンティティにエンコードするべきでしょう。

## AcceptMailPostFromAnother

メール経由の投稿を携帯電話会社のメールアドレス以外のメールアドレスでも 投稿できるようにするかを指定します。

有効にする場合はこの値を1に指定してください。

## IPCountryType

IP::Countryで利用するモジュールを指定します。 以下の値から指定します。指定されない、または以下以外を指定した場合は Fastが指定されます。

installの「Img0ch::Plugin::Filter::JPOnlyを使う」の項目と pluginのImg0ch::Plugin::Filter::JPOnlyを参照してください。

Fast

  IP::Country::Fast::*以下のNICのデータベースを参照します。

  エイリアス名：MediumまたはSlow

MaxMind

  Geo::IP(::PurePerl)を経由します。

  エイリアス名：MediumまたはSlow

## GeoIPDat

IPCountryTypeがMaxMindに指定された場合の GeoIPのデータベースのファイル先を指定します。

## Maintenance

スクリプトをzeromin.cgiを除いて停止させます。

有効にする場合はこの値を1に指定してください。

## multibyte

マルチバイト表記の変更を行うことが出来ます。書き方は以下のようになります。

      [multibyte]
      ATMARK = ＠
      STOP   = 停止
      MOVE   = 移動

## ATMARK

名前とキャップ名の間にはさむ文字を指定します。指定されない場合は「＠」になります。

### STOP

スレッド停止に入れる文字列を指定します。指定されない場合は「停止」になります。

### MOVE

スレッド移動に入れる文字列を指定します。指定されない場合は「移動」になります。

### TRUE_CAP

キャップのシンボル文字を指定します。指定されない場合は「★」になります。

### FALSE_CAP

キャップを騙ったときのシンボル文字を指定します。指定されない場合は「☆」になります。

### TRUE_TRIP

トリップの先頭文字を指定します。指定されない場合は「◆」になります。

### FALSE_TRIP

トリップを騙ったときの先頭文字を指定します。指定されない場合は「◇」になります。

### RECOVER

復帰人の肩書の文字列を指定します。指定されない場合は「復帰」になります。

### RECOVER_ESCAPED

復帰人の肩書を騙ったときの文字列を指定します。指定されない場合は「”復帰”」なります。

### DELETER

削除人の肩書の文字列を指定します。指定されない場合は「削除」になります。

### DELETER_ESCAPED

削除人の肩書を騙ったときの文字列を指定します。指定されない場合は「”削除”」なります。

### LEADER

案内人の肩書の文字列を指定します。指定されない場合は「案内」になります。

### LEADER_ESCAPED

案内人の肩書を騙ったときの文字列を指定します。指定されない場合は「”案内”」なります。

### ADMIN

管理人の肩書の文字列を指定します。指定されない場合は「管理」になります。

### ADMIN_ESCAPED

管理人の肩書を騙ったときの文字列を指定します。指定されない場合は「”管理”」なります。

### ADNIN

"菅直"人の肩書の文字列を指定します。指定されない場合は「菅直」になります。

### ADNIN_ESCAPED

"菅直"人の肩書を騙ったときの文字列を指定します。指定されない場合は「”菅直”」になります。

## compatible

1.2.5以前のバージョンのログ形式の対応を行います。書き方は以下のようになります。

      [compatible]
      bbs  = 1
      cap  = 1
      log  = 0
      user = 1

### bbs

掲示板のIDと掲示板ディレクトリの対応づけを自動的に行うかを設定します。 有効にする場合はこの値を1に指定してください。

### cap

キャップ及びキャップグループ情報の対応づけを行うかを設定します。 有効にする場合はこの値を1に指定してください。 その際に過去のキャップ情報ファイルを[BBSPath]/info/cap.cgiに、 キャップグループ情報ファイルを[BBSPath]/info/groupc.cgiに配置してください。

### category

カテゴリ情報の対応づけを行うかを設定します。 有効にする場合はこの値を1に指定してください。 その際に過去のカテゴリ情報ファイルを[BBSPath]/info/category.cgiに配置してください。

### meta

メタデータ及びバナーの対応づけを行うかを設定します。 有効にする場合はこの値を1に指定してください。

### setting

SETTING.TXTの対応づけを行うかを設定します。 有効にする場合はこの値を1に指定してください。

### upload

アップロード情報の対応づけを行うかを設定します。 有効にする場合はこの値を1に指定してください。

### user

ユーザー及びユーザーグループ情報の対応づけを行うかを設定します。 有効にする場合はこの値を1に指定してください。 その際に過去のユーザー情報ファイルを[BBSPath]/info/user.cgiに、 ユーザーグループ情報ファイルを[BBSPath]/info/group.cgiに配置してください。

# SEE ALSO

Img0ch::Config

http://hikarin.jp ( alias to http://img0ch.sourceforge.jp )

# AUTHOR

hkrn <hikarin at users dot sourceforge dot jp>

config - img0ch-config.cgiの各ディレクティブの解説

# INDEX

- ADMIN
- ADMIN_ESCAPED
- ADNIN
- ADNIN_ESCAPED
- ATMARK
- AUTHOR
- AcceptMailPostFromAnother
- Ankers
- Archive
- BBSPath
- BDB
- BDBHome
- CDB
- CGIServer
- ClearSilver
- DELETER
- DELETER_ESCAPED
- DESCRIPTION
- Debug
- DefaultCharset
- DynamicArchive
- EnableEditName
- EnableIDN
- EnableXHTMLBreak
- FALSE_CAP
- FALSE_TRIP
- Fast
- FastWriteMode
- Full
- GD
- GeoIPDat
- HTML::Template
- HTML::Template::Compiled
- IPCountryType
- ImageHandler
- LEADER
- LEADER_ESCAPED
- LogStackMax
- MOVE
- MailPostAddress
- Maintenance
- Major
- MaxMind
- Minor
- MobileRenderer
- NAME
- OmitDefaultNoName
- POP3Pass
- POP3Server
- POP3User
- PerlMagick
- Product
- Qdepot
- Qvilla
- RECOVER
- RECOVER_ESCAPED
- RedirectWait
- Renderer
- RendererSeparator
- RepositoryFileExtension
- RepositoryRoot
- RepositoryType
- ResMAX
- SEE ALSO
- STOP
- SYNOPSYS
- SambaCount
- SambaWait
- Seed
- Server
- ShellPath
- SignatureType
- Simple
- Static
- Storable
- SystemPath
- TRUE_CAP
- TRUE_TRIP
- TagsRuleConfig
- TemplateCacheRoot
- TemplateCacheRootMode
- TemplateEngine
- TemplateFileExtension
- TemplatePath
- UseAPOP
- UseFileSeek
- UsePicto
- UseQueryString
- ZerominScript
- ZerominUseGzip
- bbs
- cap
- category
- compatible
- meta
- multibyte
- repng2jpeg
- setting
- upload
- user

config - img0ch-config.cgiの各ディレクティブの解説