08) webui.cf

If you use bounceHammer's WebUI (browser based control panel), create webui.cf configuration file. If bounceHammer has been built with --disable-webui option at build time, You don't need to do these operations in this page.

Create webui.cf

The configuration file webui.cf is a YAML format. Note that If there is any syntax error in the configuration file, bounceHammer WebUI will not work properly.

Configuration file webui.cf can be read from the user (apache, nobody, httpd, ..) who runs web server processes, such as Apache.

If you want to set a custom provider name (which is used by bin/mailboxparser command for classifying recipient), Proceed to the setting of neighbor-domains configuration file.

This sction describe the fields(keys) and the values of etc/webui.cf. You don't need to edit this file except copying as the name "webui.cf" after installation. But you want to set the limit (the number of maximum records, readonly flags) for database tables, please referer this section.
Configuration file webui.cf is a YAML format. Note that If there is any syntax error in the configuration file, bounceHammer WebUI will not work properly.

webui.cf/Whole Settoings

language

Default language for displaying pages on WebUI. As of present, Japanese(ja) and English(en) are available. The language for displaying pages is set by your browser's language, but if your browser's language is unknown or unsupported, pages will be displayed in the language of this value.

upload

Maximum size of the file which will be uploaded from your browser to Mail Parsing Test page. The default value is 512KB .

session

Expiration of the browser session. The default value is 9 hours.

name

Setting name. The value is displayed at the top of each page on WebUI.

database: Database Configuration

table

bouncelog

readonly

Readonly flag of BounceLog(t_bouncelog) table. If 1 is set, the table becomes readonly mode from WebUI only.

maxrecords

The number of maximum records in BounceLog(t_bouncelog) table. The value 0 means unlimited. This maximum value is referred from WebUI ( Mail Parsing Test) only.

senderdomains

readonly

Readonly flag of SenderDomains(t_senderdomains) table. If 1 is set, the table becomes readonly mode from WebUI only.

maxrecords

The number of maximum domains in SenderDomains(t_senderdomains) table. The value 0 means unlimited. This maximum value is referred from WebUI (Edit MasterTable/Sender Domain) only.

destinations

readonly

Readonly flag of Destinations(t_destinations) table, If 1 is set, the table becomes readonly mode from WebUI only.

maxrecords

The number of maximum domains in Destinations(t_destinations) table. The value 0 means unlimited. This maximum value is referred from WebUI (Edit MasterTable/Destination Domain) only.

archive: Compression Configurations for Downloading

expires

Expiration of each compressed file for downloading. The default value is 1 hour.

compress

type

A compression format of a file which will be downloaded. The default value is gzip, but other format will be available if there is IO::Compress::Bzip module or IO::Compress::Zip module on your system.

security: Encryption Configurations

crypt

salt

A salt value for URL encryption.

key

A secret key for URL encryption.

cipher

A cipher algorithm for URL encryption. The default value is DES.