08) webui.cf

bounceHammerのブラウザベースの管理画面(WebUI)を使用する場合はこのページの作業も行ってください。 インストールしたオペレーティングシステムの環境に依存する設定項目は、現在のところほとんどありませんので、多くの場合は、サンプルの設定ファイルを"webui.cf"の名前でコピーするだけです。

構築時に--disable-webuiを指定した場合、このサンプルの設定ファイルはインストールされていませんので、このページも読み飛ばしてください。

webui.cfの作成

設定ファイル"webui.cf"はbouncehammer.cfと同様にYAMLフォーマットです。YAMLフォーマットとして無効な記述をした場合はbounceHammerの管理画面(WebUI)が正しく動作できませんのでご注意下さい。

webui.cfはApache等のウェブサーバを実行しているユーザ(apache, nobody, httpd等)から読出せるパーミッションである必要があります。

メール解析器(bin/mailboxparser)がバウンスメールをデータ化する際に、自社・自組織が保有しているドメイン名を含む場合、独自の宛先所属(Provider,小分類)に入れたい場合はneighbor-domainsの作業も行ってください。

etc/webui.cfの各項目について説明します。インストール直後にwebui.cfとしてコピーする以外は特に編集する必要もありませんが、テーブルへの書き込み制限や上限数などを設定したい場合はこのページを参考にしてください。
webui.cfはYAMLファイルとして読込まれます。YAMLファイルとして無効な記述や誤った文法があるとエラーとなりますのでご注意下さい。

webui.cf/全体設定

language

WebUIのページ内容を表示する際の既定の言語。対応言語は日本語(ja)と英語(en)です。ブラウザの設定言語でページの言語が決定されますが、取得できない場合はこの設定値が使われます。

upload

現在はmaxsizeの一項目のみ設定可能です。この値はブラウザからバウンスメールを解析する際にアップロード可能なファイルの最大サイズを指定します。既定値は512KBです。

session

現在はexpiresの一項目のみ設定可能です。この値はブラウザで開いた時のセッションの有効期限を指定します。既定値は9時間です。

name

設定名です。複数の設定ファイルを表示上区別するために使用します。ここで設定された値はブラウザ開いたWebUIの各ページ上部に表示されます。

database: データベース設定

table

bouncelog

readonly

BounceLog(t_bouncelog)テーブルを読取専用とするかどうかの設定です。1を設定するとテーブルは、WebUIからは読取専用となります。

maxrecords

BounceLog(t_bouncelog)テーブルに保存できるバウンス記録の最大値です。0を設定すると無制限になります。この設定値は、WebUIからバウンスメールを解析した時に、解析結果を同時に登録する際にのみ参照されます。

senderdomains

readonly

SenderDomains(t_senderdomains)テーブルを読取専用とするかどうかの設定です。1を設定するとテーブルは、WebUIからは読取専用となります。

maxrecords

SenderDomains(t_senderdomains)テーブルに登録できる発信者ドメインの最大値です。0を設定すると無制限になります。この設定値は、WebUIから発信者ドメインを登録する際にのみ参照されます。

destinations

readonly

Destinations(t_destinations)テーブルを読取専用とするかどうかの設定です。1を設定するとテーブルは、WebUIからは読取専用となります。

maxrecords

Destinations(t_destinations)テーブルに登録できる受信者(宛先)ドメインの最大値です。0を設定すると無制限になります。この設定値は、WebUIから受信者(宛先)ドメインを登録する際にのみ参照されます。

archive: ダウンロード時の圧縮関連設定

expires

圧縮済ファイルのキャッシュ有効期限です。圧縮済ファイルのキャッシュがありタイムスタンプが有効期限内であれば、新たに検索結果を取得して圧縮せずにキャッシュを使います。既定値は1時間です。

compress

type

ダウンロードするファイルの圧縮形式です。既定値はgzipですが、IO::Compress::Bzip2やIO::Compress::Zipモジュールがあれば他の形式も利用できます。

security: 暗号化の設定

crypt

salt

URLを暗号化する際に使用するソルトです。

key

URLを暗号化する際に使用するキーです。

cipher

URLを暗号化する際の暗号化方式です。既定値はDESです。