06) Directory Tree

This page explains and lists the directory structure of bouncehammer after installing. make install command make these directories and set permissions.

bin/

The bin/ directory contain command line tools of bouncehammer. all of the commands in this directory are perl script and all users on the system can execute these commands.

databasectl

This command read parsed data from a YAML file and write bounced records into the database. More information and usage of this command are available at databasectl .

datadumper

This command dump/output bounced records in the database as a YAML/JSON/CSV format. More information and usage of this command are available at datadumper.

logger

This command merge/concatenate log files which include parsed data (created by bin/mailboxparser command) by date. More information and usage of this command are available at logger.

mailboxparser

This command read and parse bounced emails and output parsed data as a YAML/JSON format. More information and usage of this command are available at mailboxparser.

messagetoken

This command prints a message token string. More information and usage of of this command are available at messagetoken.

summarizer

This command prints a summary of data in a database or a yaml file. More information and usage of of this command are available at summarizer.

tablectl

This command is an administration tool for database table (we call it Mastertable). More information and usage of this command are available at tablectl.

etc/

The etc/ Directory contain configuration files and sample configuration files of bouncehammer.

aliases-example

Example configuration file of /etc/mail/aliases

available-countries-example

Example configuration file for available-countries. If you use this configuration file, save the file as the file name which does not include -example at the end of the file name. bouncehammer works properly if this file does not exist in the etc/ directory.

bouncehammer.cf-example

Example file of bouncehammer's main configuration file. bouncehammer does NOT work properly if this configuration file does not exist. More information about this file is available at bouncehammer.cf.

crontab-example

Example configuration file for /etc/crontab. To run bouncehammer periodically, see crontab page.

httpd.conf-example

Example configuration file of Apache's httpd.conf for running BounceHammer's WebUI (browser based control panel) and HTTP-based API with mod_perl2 on Apache 2.

neighbor-domains-example

Example configuration file for neighbor-domains for defining custom classification. If you use this file, save the file as the file name which does not include -example at the end of the file name. bouncehammer works properly if this file does not exist.

prove.cf

This file is a configuration file of bouncehammer for the command make test at build time. You can remove this file after installation.

test-run.cf

This file is a configuration file of bouncehammer in Test Mode (running with -T, --test option) of commands in the bin/ directory.

webui.cf-example

Example configuration file of WebUI and HTTP-Based API. WebUI and HTTP-API require this file. If you use this file, save the file as the file name which does not include -example at the end of the file name.

lib/

The lib/ Directory contain all libraries and modules of bouncehammer.

libexec/

The libexec/ Directory currently contains a script file for mod_perl2.

mp-startup.pl

This is a script file for mod_perl2 which is called from httpd.conf .

share/

The share/ Directory contain SQL scripts, CGI scripts, and template files for WebUI.

script/

MySQL*.sql

SQL Script file to build tables of bouncehammer for MySQL 4 or 5.

PostgreSQL*.sql

SQL Script file to build tables of bouncehammer for PostgreSQL.

SQLite*.sql

SQL Script file to build tables of bouncehammer for SQLite3.

api.cgi

CGI Script for HTTP-API.

bouncehammer.cgi

CGI Script for WebUI.

mastertable-*.sql

SQL Script file to insert records into master table for all DBs.

more-example-senderdomains.sql

More example domains for t_senderdomains for all DBs.

records-example.sql

SQL Script of example bounce records.

template/l10n/

en/

Language files of WebUI template(English)

ja/

Language files of WebUI template(Japanese)

template/standard/

element/

Partial HTML files of WebUI template for PC.

javascript/

Javascript files of WebUI template for PC.

page/

HTML page files of WebUI template for PC.

stylesheet/

Style sheets of WebUI template for PC.

var/

The var/ Directory contain miscellaneous files.

cache/

This directory will contain cache files for downloading which are created at WebUI.

db/

By default, a database file for SQLite3 will be here. If you use MySQL or PostgreSQL as a database system, this directory will not be used.

incoming/

As of present, this directory is unused. For future release of bouncehammer.

log/

Log files which include merged data created by logger command will be saved in this directory.

mail/

As of present, this directory is unused. For future release of bouncehammer.

run/

Each pid file of command line tool in the bin/ direcotry will be saved in this directory.

spool/

This directory hold YAML files which include parsed data created by mailboxparser command. bin/logger command read files in this directory and merge.

tmp/

Generic temporary directory.