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

TABLE OF CONTENTS


NAME

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


SYNOPSYS


DESCRIPTION

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

RepositoryType

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

Archive

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

エイリアス名

Compressed

初期状態で利用可能か

IO::Zlibがパッケージに入っているため、利用可能

BDB

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

エイリアス名

BerkeleyDB

初期状態で利用可能か

BerkeleyDBがインストールされている必要がある

CDB

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

エイリアス名

CDB_File

初期状態で利用可能か

CDB_Fileがインストールされている必要がある

DD

DBM::Deepを使ったエンジンです。Perlのみでかかれているため移植性に優れており、 実行時に値を読み込むため、メモリ消費もSimpleに比べると少ないことが利点です。 ただし、やや遅い問題があります。

エイリアス名

DBMDeep

初期状態で利用可能か

DBM::Deepがパッケージに入っているため、利用可能

Qdepot

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

エイリアス名

DepotまたはQDBMs

初期状態で利用可能か

Depot(libqdbm)がインストールされている必要がある

Qvilla

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

エイリアス名

Villa

初期状態で利用可能か

Villa(libqdbm)がインストールされている必要がある

Simple

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

エイリアス名

FlatFile

初期状態で利用可能か

利用可能

Storable

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

初期状態で利用可能か

Storableがインストールされている必要がある

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.htmli/index.htmlsubback.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 で入手可能です。

repng2jpeg 1.0.x(zipかtar.gz形式)をダウンロードし、 その中に含まれるcheck.cgiをアップロード、パーミッションを0755で実行可能にし、 アクセスしてどのrepng2jpegが利用可能かを確認してください。

移植性が高く、サムネイルの画質が優れていますが、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サーバーのアドレスを指定します。 [pop3]のserverと同等で、互換性のため現在でも利用可能です。

POP3User

メール経由の投稿に利用するPOP3Serverにログインするためのユーザー名を指定します。 [pop3]のuserと同等で、互換性のため現在でも利用可能です。

POP3Pass

メール経由の投稿に利用するPOP3Serverにログインするためのパスワードを指定します。 [pop3]のpassと同等で、互換性のため現在でも利用可能です。

UseAPOP

現在この項目は利用していません。 指定されていてもAPOPを利用せずにやりとりが行われます。 より安全にやりとりを行うのであればSSLに対応した[pop3]を参照してください。

MailPostAddress

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

MailRawAddress

メール経由の投稿に利用する投稿先のメールアドレスを指定します。 この値はエラーメールのヘッダーのFromに利用するため、 本物のメールアドレスを指定する必要があります。

AcceptMailPostFromAnother

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

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

SendmailPath

メール配信プログラム(MTA)のひとつであるsendmailのパスを指定します。 この値が指定された場合エラーを通知するメールを配信する方法として sendmailが利用されるようになります。これは[smtp]ディレクティブおよび QmailPathの値より優先されて利用されます。

QmailPath

メール配信プログラム(MTA)のひとつであるqmailのパスを指定します。 この値が指定された場合エラーを通知するメールを配信する方法として qmailが利用されるようになります。これは[smtp]ディレクティブより 優先されて利用されます。

IPCountryType

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

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

Fast

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

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

MaxMind

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

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

GeoIPDat

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

DraftExpire

お絵書き途中ファイルの保有有効期限を秒数単位で指定します。 指定されない場合は86400秒(一日)になります。

OekakiTempPath

旧版(v1.2.5以前)スクリプトのためのお絵書き途中のファイルが 納められたディレクトリのパスを指定します。

これは旧版の「お絵書き設定」の「お絵描き仮保存ファイル保存パス」に相当します。

EnableAnnotation

アノテーション機能を有効にするかを指定します。

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

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に配置してください。

smtp

エラーメールを送信するときにSMTPを使ってメールを送信するための設定を行います。

  [smtp]
  host = smtp.mail.ne.jp
  port = 465
  ssl  = 1
  tls  = 1

host

SMTPメールサーバーのアドレス(ホスト名)を指定します。

port

SMTPメールサーバーに接続するためのポート番号を指定します。 sslまたはtlsを使用するときはポート番号を明示的に指定する必要があります。

ssl

STMPメールサーバーとの通信のやりとりにSSLを利用するかを指定します。 有効にする場合はこの値を1に指定してください。

tls

STMPメールサーバーとの通信のやりとりにTLSを利用するかを指定します。 有効にする場合はこの値を1に指定してください。

akismet

Img0ch::Plugin::Filter::Akismetの設定を行います。

  [akismet]
  apikey  = (wordpress.comで取得したAPIキー)
  mail    = 1
  referer = 1

apikey

Akismetを利用するためのhttp://www.wordpress.comでのアカウント登録で 登録したAPIキーを設定します。これを設定しないとImg0ch::Plugin::Filter::Akismetを 有効にした後にエラーが発生して書き込めなくなります。

mail

Akismetに投稿情報を送信する際にメールアドレスを送信するかを設定します。 この値が有効でない限りは投稿情報にメールアドレスを含めて送信されることはありません。 有効にする場合はこの値を1に指定してください。

referer

Akismetに投稿情報を送信する際にリファラーを送信するかを設定します。 この値が有効でない限りは投稿情報にリファラーを含めて送信されることはありません。 有効にする場合はこの値を1に指定してください。

zeromin2

Zeromin2関連の設定を行います。

  [zeromin2]
  session_dir  = /path/to/session_dir
  session_name = zeromin_session

session_dir

Zeromin2で利用するセッションを保存するためのディレクトリを指定します。 この値は必須であり、値が空の場合エラーを出力します。 値のディレクトリ先が存在しない場合は自動的に作成を試みます。

session_name

セッション名を指定します。この値は通常入力または変更する必要がありません。 デフォルトでzeromin_sessionが入るようになっています。

cookie_path

セッションIDを保管するためのクッキーの有効パスを指定します。 この値は通常入力または変更する必要がありません。 デフォルトでzeromin2.cgiまでのディレクトリ先が入るようになっています。

secured_cookie

クッキーをSSLを介したURLのみで有効にするかを指定します。

url

zeromin2.cgiの相対または絶対URLを指定します。 デフォルトでzeromin2.cgiが入ります。

random774

Img0ch::Plugin::BBS::Random774の設定を行います。

  [random774]
  data_file  = ../_system/774.txt
  location_file = ../_system/location.txt

data_file

名前欄のデータを格納するファイルを指定します。 ファイルは以下のような形式でかつ文字コードがShiftJISで保存されている必要があります。 なお、空白のみまたは#(シャープ)と;(セミコロン)が先頭に入っている行は無視されます。

  ; この行は無視される
  # この行も無視される
  名無し1
  名無し2
  名無し3
  ...

このファイルは出来るだけRepositoryRootと同じように第三者が直接 ダウンロードできないパスに設定するべきです。

location_file

ホストの正規表現とそれに対応するデータを格納するファイルを指定します。 ファイルは以下のような形式でかつ文字コードがShiftJISで保存されている必要があります。 なお、空白のみまたは#(シャープ)と;(セミコロン)が先頭に入っている行は無視されます。

  ; この行は無視される
  # この行も無視される
  # 最初に見つかった行はフォーマットとして扱う
  # {1}にはランダム名無しの名前が、{2}には対応したデータが置換される
  # 例えばホスト名に.co.jpが含まれた場合は{2}には「会社」が置換される
  # 二行目以降は左辺にホストの正規表現、右辺に対応するデータを並べる
  {1}({2})
  localhost=ローカルホスト
  .co.jp=会社
  .go.jp=政府
  .ac.jp=学校
  ...

このファイルは出来るだけRepositoryRootと同じように第三者が直接 ダウンロードできないパスに設定するべきです。

location_fileに関しては必須ファイルではありません。 また、パスにファイルが存在しても内容が空なら無視されます。

pop3

メール経由による投稿に必要なPOP3関連の設定を行います。 SSLを介したPOP3の通信に対応しています。

  [pop3]
  server = pop.gmail.com
  user = img0ch@gmail.com
  pass = password
  port = 995
  ssl = 1

server

POP3サーバーのホスト名を指定します。

user

POP3サーバーに接続するために必要なユーザー名を指定します。

pass

POP3サーバーに接続するために必要なパスワードを指定します。

port

POP3サーバーに接続するためのポート番号を指定します。 指定されていなければ110番が自動的に指定されます。

ssl

POP3サーバーとの通信のやりとりにSSLを利用するかを指定します。 有効にする場合はこの値を1に指定してください。


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

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