07) bouncehammer.cf

bounceHammerが無事に/usr/local/bouncehammerにインストールされ、データ蓄積用のデータベースも準備できたら、bounceHammerの設定ファイルを作成します。インストール時にサンプルの設定ファイルが/usr/local/bouncehammer/etc以下にコピーされているので、それを元に作成し、準備したデータベースの設定に合わせて編集します。

bouncehammer.cfの作成

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

# データベースの所を編集する↓
database:
  # Database type(Available values are PostgreSQL, MySQL or SQLite)
  # If you use SQLite database, please specify a path into the dbname value.
  # dbtype: 'SQLite'
  # dbname: '/usr/local/bouncehammer/var/db/bouncehammer.db'
  dbtype: 'MySQL' ← データベースソフトウェアに合わせる
  dbname: 'bouncehammer' ← 作成したデータベース名を記述

  # Database name, username and password of the db-user
  username: 'bouncehammer' ← 作成したデータベースのユーザ名を記述
  password: '794-uguisu-heiankyo' ← 設定したパスワードを記述

  # Database host or IP address, and port number
  #  Postgresql = 5432, MySQL = 3306 by default. If the dbtype value is
  #  'SQLite', the system ignores the 'port' value.
  hostname: '127.0.0.1' ← データベースが動いているホスト名またはIPアドレスを記述
  port: 3306 ← MySQLがListenしているポート番号を指定

SQLiteを使う場合

データベースをSQLiteで構築した場合は、dbname:の値にSQLiteデータベースファイルの位置をフルパスで記述してください。

UNIXドメインソケットで接続する場合

あるいはUNIXドメインソケットで接続する場合は、hostname, portを空の値にするかコメントアウトしてください。SQLiteの場合は、hostname:とport:はいかなる値を記述しても無視されます。

syslogの設定

bounceHammer 2.7.0から、幾つかのコマンドとWebUIで行った更新系の作業結果の概要がsyslogに記録されるようになりました。ただし、既定値は記録しないようになっていますので、syslogを使用する場合は下記のような設定を行ってください。

                               
# UNIX syslog(3) configuration, Beginning with bounceHammer 2.7.0
# mailboxparser, logger, databasectl, and tablectl use this configuration
syslog:
  # By default, messages will not be sent syslog(3). If you want to
  # use syslog(3), set 1 to the value of enabled:.
  enabled: 1 ← 1に設定するとsyslogが使用されます
  facility: 'local6' ← 使用環境に合わせて変更してください

書込む先のログファイルは、インストールしたディレクトリ/etc/syslog.conf-exampleに例示している内容を参考に、お使いの環境のsyslog.confを設定してください。

ブラウザベースの管理画面(WebUI)を使用する場合は、webui.cfもご覧ください。

etc/bouncehammer.cfの各項目について説明します。前述のデータベースに関する設定値以外は変更する必要がありませんが、出力先のディレクトリやファイル名など変更したい場合はこのページを参考にしてください。
bouncehammer.cfはYAMLファイルとして読込まれます。YAMLファイルとして無効な記述や誤った文法があるとエラーとなりますのでご注意下さい。

bouncehammer.cf/全体設定

system

システムの名称。現在のところ設定ファイルの読み込み確認で使用されています。特に明確な理由がない限り変更しないでください。

version

設定ファイルのバージョン(非システムのバージョン)。現在のところ設定ファイルの読み込み確認で使用されています。特に明確な理由がない限り変更しないでください。

name

設定名です。複数の設定ファイルを使用する際に区別する事を目的としています。

file: ファイル設定

maxsize

bin/mailboxparserコマンドが処理する1ファイルの上限サイズです。不用意に巨大なファイルを読込ませてメモリを使い果たす事を避けるためのものです。既定値は約128MBです。

templog

prefix

bin/mailboxparserコマンドを-l(--og)オプション付きで解析した結果を書き出すファイル名の先頭につく文字列です。既定値はhammerです。

suffix

bin/mailboxparserコマンドを-l(--og)オプション付きで解析した結果を書き出すファイル名の末尾につく文字列(拡張子)です。既定値はtmpです。

storage

prefix

mailboxparserコマンドが作った解析結果のファイルをbin/loggerコマンドが纏める際に書き出すファイル名の先頭につく文字列です。既定値はhammerです。

suffix

mailboxparserコマンドが作った解析結果のファイルをbin/loggerコマンドが纏める際に書き出すファイル名の末尾につく文字列(拡張子)です。既定値はlogです。

directory: ディレクトリ設定

conf

設定ファイルの格納ディレクトリです。既定値はインストールしたディレクトリ/etcです。

pid

bin/ディレクトリのコマンドを実行した時にプロセスIDのファイルが作られるディレクトリです。既定値はインストールしたディレクトリ/var/pidです。

log

bin/loggerコマンドが出力するファイルの書き出すディレクトリです。既定値はインストールしたディレクトリ/var/logです。

tmp

bin/ディレクトリ以下のコマンドを実行した際に一時ファイル置き場として作られるディレクトリです。既定値は/tmpです。

cache

現在の所、WebUI(管理画面)からファイルをダウンロードする際に使用されるディレクトリです。一度ダウンロード用に作られたファイルはこのディレクトリに保存されます。既定値はインストールしたディレクトリ/var/cacheです。

spool

bin/mailboxparserコマンドが出力する解析結果のファイルが保存されるディレクトリです。既定値はインストールしたディレクトリ/var/spoolです。

database: データベース

dbtype

データベースの種類を指定します。有効な値は、PostgreSQL, MySQL, SQLiteの三つです。

dbname

bouncehammer用に作成したデータベース名を指定します。データベースがSQLiteの場合はデータベースファイルのPATHを指定してください。データベースの作成手順はデータベースの準備をご覧ください。

username

データベースへ接続するユーザ名を指定します。

password

データベースへ接続するパスワードを指定します。パスワードを設定していない場合は空白文字列を指定してください。

hostname

データベースのホスト名またはIPアドレスを指定します。TCP/IPではなく、ソケットで接続する場合は、localhostまたは空白を指定してください。

port

データベースのポート番号を指定します。TCP/IPで接続する場合は5432(PostgreSQL)、3306(MySQL)などListenしているポートを指定してください。ソケット接続をする場合は空白か、ソケットのPATHを指定してください。

environment: その他環境設定

timeout

bin/以下のコマンドラインツールが標準入力(STDIN)からデータを読込む際のタイムアウトまでの秒数を指定します。指定した秒数が経過するまでの間に標準入力からデータが入ってこない場合は、コマンドは処理を中断します。既定値は180秒です。

syslog: ログの設定

enabled

syslogを使用するかどうかの設定です。1を指定するとsyslogに書き出す、0ならsyslogを使用しない、となります。

facility

syslogファシリティです。既定値はlocal6ですが使用する環境によって変更してください。