diff --git a/data/conf/parsedmarc/config.sample.ini b/data/conf/parsedmarc/config.sample.ini index 7908ebd..35062d0 100644 --- a/data/conf/parsedmarc/config.sample.ini +++ b/data/conf/parsedmarc/config.sample.ini @@ -1,27 +1,63 @@ -# See docs at: domainaware.github.io/parsedmarc/#configuration-file -### ADJUST YOUR SETTINGS +######################################################## +# Please read the docs to fit your needs: +# https://domainaware.github.io/parsedmarc/usage.html +######################################################## +# IMPORTANT! +# You might need to keep the config up-to-date with +# parsedmarc's changes (see above). +# +# This is only an example file to get started easily. +# Project is NOT (automatically) keeping your +# custom config up-to-date. +######################################################## + +### ADJUST YOUR SETTINGS BELOW + [general] save_aggregate = True save_forensic = True + +# nameservers to use (default is Cloudflare). +# Using internal DNS could speed up DNS resolution +# and hence also speed up email processing. +nameservers = 1.1.1.1,1.0.0.1 + +# Disable using reverse DNS and geolocation. Will speed up +# the processing noticably but also reduces the variety and +# precision of statistics. +# Can be useful for troubleshooting/testing. +offline = False + +# For best troubleshooting, toggle both booleans below. +# Debug logging. (default) debug = False +# Only report errors. (default) +silent = True [imap] # IMAP login host = imap.example.com port = 993 user = dmarcresports@example.com +# % character in password must be replaced with %% password = $uperSecure ssl = True -# advanced [mailbox] +# Using IDLE command to process when email arrives. watch = True +# Delete emails after processing. delete = False -# advanced advanced +# Folder where to look for reports and where to move processed ones. +reports_folder = INBOX +archive_folder = Processed + +# When TRUE, it will NOT move or delete messages. test = False -### NO EDIT REQURIED DOWN BELOW +######################################################## +### NO EDIT REQUIRED BELOW [elasticsearch] hosts = elasticsearch:9200 ssl = False