diff --git a/_modules/index.html b/_modules/index.html index ec339ac..eda9549 100644 --- a/_modules/index.html +++ b/_modules/index.html @@ -5,14 +5,14 @@
-Increasing this value increases resource usage.
+Any configuration option can be set via environment variables using the
+naming convention PARSEDMARC_{SECTION}_{KEY} (uppercase). This is
+especially useful for Docker deployments where file permissions make it
+difficult to use config files for secrets.
Priority order: CLI arguments > environment variables > config file > defaults
+# Set IMAP credentials via env vars
+export PARSEDMARC_IMAP_HOST=imap.example.com
+export PARSEDMARC_IMAP_USER=dmarc@example.com
+export PARSEDMARC_IMAP_PASSWORD=secret
+
+# Elasticsearch
+export PARSEDMARC_ELASTICSEARCH_HOSTS=http://localhost:9200
+export PARSEDMARC_ELASTICSEARCH_SSL=false
+
+# Splunk HEC (note: section name splunk_hec becomes SPLUNK_HEC)
+export PARSEDMARC_SPLUNK_HEC_URL=https://splunk.example.com
+export PARSEDMARC_SPLUNK_HEC_TOKEN=my-hec-token
+export PARSEDMARC_SPLUNK_HEC_INDEX=email
+
+# General settings
+export PARSEDMARC_GENERAL_SAVE_AGGREGATE=true
+export PARSEDMARC_GENERAL_DEBUG=true
+export PARSEDMARC_CONFIG_FILE=/etc/parsedmarc.ini
+parsedmarc
+When no config file is given (neither -c flag nor PARSEDMARC_CONFIG_FILE),
+parsedmarc will still pick up any PARSEDMARC_* environment variables. This
+enables fully file-less deployments:
export PARSEDMARC_GENERAL_SAVE_AGGREGATE=true
+export PARSEDMARC_GENERAL_OFFLINE=true
+export PARSEDMARC_ELASTICSEARCH_HOSTS=http://elasticsearch:9200
+parsedmarc /path/to/reports/*
+services:
+ parsedmarc:
+ image: parsedmarc:latest
+ environment:
+ PARSEDMARC_IMAP_HOST: imap.example.com
+ PARSEDMARC_IMAP_USER: dmarc@example.com
+ PARSEDMARC_IMAP_PASSWORD: ${IMAP_PASSWORD}
+ PARSEDMARC_MAILBOX_WATCH: "true"
+ PARSEDMARC_ELASTICSEARCH_HOSTS: http://elasticsearch:9200
+ PARSEDMARC_GENERAL_SAVE_AGGREGATE: "true"
+ PARSEDMARC_GENERAL_SAVE_FORENSIC: "true"
+For sections with underscores in the name, the full section name is used:
+Section |
+Env var prefix |
+
|---|---|
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
|
+
For large mailbox imports or backfills, parsedmarc can consume a noticeable amount