Improved setup and README

This commit is contained in:
Patrik Kernstock 2020-08-08 23:02:00 +01:00
parent c7fd05d4f8
commit 0c1897af2d
4 changed files with 18 additions and 9 deletions

1
.gitignore vendored Normal file
View file

@ -0,0 +1 @@
data/conf/parsedmarc/config.ini

View file

@ -4,11 +4,17 @@ Note: The standalone `parsedmarc` docker image can also be used, if interested:
## Setup: ## Setup:
``` ```
$ cd /opt/ $ git clone https://github.com/patschi/parsedmarc-dockerized.git /opt/parsedmarc-dockerized/
$ git clone https://github.com/patschi/parsedmarc-dockerized.git $ cd /opt/parsedmarc-dockerized/ && cp data/conf/parsedmarc/config.sample.ini data/conf/parsedmarc/config.ini
$ cd parsedmarc-dockerized/
$ nano docker-compose.yml # Edit docker-compose.yml and change environment variables below for geoipupdate from maxmind. # Create environment file for your geoipupdate API settings (fill in your data)
$ cat > geoipupdate.env <<EOF
GEOIPUPDATE_ACCOUNT_ID=YOUR_ACCOUNT_ID
GEOIPUPDATE_LICENSE_KEY=YOUR_LICENSE_KEY
EOF
$ nano data/conf/parsedmarc/config.ini # Edit parsedmarc config file (and change test to False when testing done!) $ nano data/conf/parsedmarc/config.ini # Edit parsedmarc config file (and change test to False when testing done!)
$ docker-compose up -d $ docker-compose up -d
``` ```

View file

@ -10,10 +10,10 @@ host = imap.example.com
port = 993 port = 993
user = dmarcresports@example.com user = dmarcresports@example.com
password = $uperSecure password = $uperSecure
ssl = True
# advanced # advanced
watch = True watch = True
ssl = True
archive_folder = Processed archive_folder = Processed
delete = False delete = False

View file

@ -78,11 +78,13 @@ services:
geoipupdate: geoipupdate:
image: maxmindinc/geoipupdate image: maxmindinc/geoipupdate
env_file:
- geoipupdate.env
environment: environment:
- GEOIPUPDATE_ACCOUNT_ID=TO_BE_SET - GEOIPUPDATE_ACCOUNT_ID=${GEOIPUPDATE_ACCOUNT_ID}
- GEOIPUPDATE_LICENSE_KEY=TO_BE_SET - GEOIPUPDATE_LICENSE_KEY=${GEOIPUPDATE_LICENSE_KEY}
- GEOIPUPDATE_EDITION_IDS=TO_BE_SET - "GEOIPUPDATE_EDITION_IDS=GeoLite2-ASN GeoLite2-City GeoLite2-Country"
- GEOIPUPDATE_FREQUENCY=24 - GEOIPUPDATE_FREQUENCY=${GEOIPUPDATE_FREQUENCY:-24}
- GEOIPUPDATE_PRESERVE_FILE_TIMES=1 - GEOIPUPDATE_PRESERVE_FILE_TIMES=1
restart: always restart: always
volumes: volumes: