diff options
| author | Nic Bernstein <nic@onlight.com> | 2017-12-07 22:02:13 +0300 |
|---|---|---|
| committer | Nic Bernstein <nic@onlight.com> | 2017-12-07 22:02:13 +0300 |
| commit | fe1036b62ea842b7420e054553b2857045156d71 (patch) | |
| tree | f6ef3df557249d531b771bff617f0df5e5091283 | |
| parent | 08037af19e8f4114d88d1d1a0222372368bcea90 (diff) | |
Misc. readme fixes
Add 'unzip' to apt-get install list for Debian.
Add notes on IMAP hierarchy separator, etc.
Add notes on possible configuration requirements for MySQL.
| -rw-r--r-- | README.md | 15 |
1 files changed, 13 insertions, 2 deletions
@@ -2,8 +2,15 @@ A Perl based tool to parse DMARC reports, based on John Levine's [rddmarc](http://www.taugh.com/rddmarc/), but extended by the following features: * Allow to read messages from an IMAP server and not only from the local filesystem. * Store much more XML values into the database (for example the missing SPF and DKIM results from the policy_evaluated section) and also the entire XML for later reference. -* Needed database tables and columns are created automatically, user only needs to provide a database. The database schema is compatible to the one used by rddmarc, but extends it by additional fields. Users can switch from rddmarc to dmarcts-report-parser without having to do any changes to the database by themself. +* Needed database tables and columns are created automatically, user only needs to provide a database. The database schema is compatible to the one used by rddmarc, but extends it by additional fields. Users can switch from rddmarc to dmarcts-report-parser without having to do any changes to the database by themselves. +* Due to limitations in stock configurations of MySQL/MariaSQL on some distros, it may be necessary +to add the following to your configuration (i.e. in /etc/mysql/mariadb.conf.d/50-server.cnf): +``` +innodb_large_prefix = on +innodb_file_format = barracuda +innodb_file_per_table = true +``` ## Installation and Configuration @@ -13,7 +20,7 @@ To install dependencies... ``` apt-get install libmail-imapclient-perl libmime-tools-perl libxml-simple-perl \ libclass-dbi-mysql-perl libio-socket-inet6-perl libio-socket-ip-perl libperlio-gzip-perl \ -libmail-mbox-messageparser-perl +libmail-mbox-messageparser-perl unzip ``` ### on Fedora (Fedora 23): ``` @@ -78,6 +85,10 @@ $delete_failed = 0; ``` The script is looking for `dmarcts-report-parser.conf` in the current working directory. If not found it will look by the calling path. If neither is found than it will abort. +Note: Be sure to use the proper hierarchy separator for your server in all folder specs, and +if your IMAP server flattens the hierarchy (i.e. Cyrus IMAP with "altnamespace: yes") then +leave "Inbox" off of the beginning of such specs. + ## Usage ``` |