parsedmarc-dockerized/README.md

31 lines
1.5 KiB
Markdown
Raw Normal View History

2020-08-08 21:32:53 +02:00
# parsedmarc-dockerized
2020-08-08 23:24:53 +02:00
Note: The standalone `parsedmarc` docker image can also be used, if interested: [hub.docker.com/r/patschi/parsedmarc](https://hub.docker.com/r/patschi/parsedmarc).
## Setup:
2020-08-08 21:32:53 +02:00
```
2020-08-09 00:02:00 +02:00
$ git clone https://github.com/patschi/parsedmarc-dockerized.git /opt/parsedmarc-dockerized/
$ cd /opt/parsedmarc-dockerized/ && cp data/conf/parsedmarc/config.sample.ini data/conf/parsedmarc/config.ini
# 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
2020-08-08 23:24:53 +02:00
$ nano data/conf/parsedmarc/config.ini # Edit parsedmarc config file (and change test to False when testing done!)
2020-08-09 00:02:00 +02:00
$ docker-compose up -d
2020-08-08 21:32:53 +02:00
```
2020-08-08 23:24:53 +02:00
### What's happening then?
1. First, the whole stack is being created and started.
2. During the startup of the "init" container, all required steps are being taken care of - like generating a self-signed certificate for the webserver.
3. Once kibana container is started up, the corresponding parsedmarc dashboard is automatically imported into Kibana.
4. After a while you can access the Kibana dashboard under the shipped reverse proxy with at `https://IP:9999`.
## Credits
Built on top of the awesome [parsedmarc](https://github.com/domainaware/checkdmarc), [Elasticsearch and Kibana](https://www.elastic.co/), [nginx](https://nginx.org), [Docker](https://docker.com) and using [MaxMind GeoIP](https://dev.maxmind.com/geoip/geoip2/geolite2/).