SunRed/parsedmarc-dockerized
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
Dockerized self-initializing parsedmarc docker stack for lazy people
20 commits 1 branch 0 tags 67 KiB
Shell 85.3%
Dockerfile 14.7%
Find a file
Manuel dd4bbc4b22
Several changes and updated formatting 
* Update ElasticSearch and Kibana version
* Remove nginx config and cert generation for use of
  reverse proxy on host
* Replace geoip updater with crazymax image
* Update formatting to have unix line endings
* Rename docker-compose.yml to compose.yml
* Add explicit network to compose.yml for use with ipv6 (optional)
2021-10-17 20:40:03 +02:00
.github/workflows Update 2020-08-08 23:28:40 +01:00
data Several changes and updated formatting 2021-10-17 20:40:03 +02:00
.gitignore Improved setup and README 2020-08-08 23:02:00 +01:00
compose.yml Several changes and updated formatting 2021-10-17 20:40:03 +02:00
LICENSE Update 2020-08-08 23:28:40 +01:00
README.md Tiny README tweak 2020-08-09 01:29:27 +01:00

README.md

parsedmarc-dockerized

Note: The standalone parsedmarc docker image on DockerHub @ patschi/parsedmarc can also be used, if interested.

Setup:

  1. Get basics together:
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
  1. Next we change the parsedmarc config (see docs. You can set Test to True for testing purposes.)
nano data/conf/parsedmarc/config.ini
  1. Now we create an environment file, containing your geoipupdate settings from your MaxMind account to allow the container to pull the databases. For update cycles of the databases, please see here. (Fill in your data!)
cat > geoipupdate.env <<EOF
GEOIPUPDATE_ACCOUNT_ID=HERE_GOES_YOUR_ACCOUNT_ID
GEOIPUPDATE_LICENSE_KEY=HERE_GOES_YOUR_LICENSE_KEY
GEOIPUPDATE_FREQUENCY=24
EOF
  1. Finally, we start up the stack and wait:
docker-compose up -d

What's happening then?

  1. First, containers of the stack are created and started. This might take a while, as several containers have dependencies on others being in a healthy state (meaning that its service must be fully started).
  2. During the startup of the parsedmarc-init container, all required steps and preparations are being taken care of - like generating a self-signed certificate for the included nginx webserver.
  3. Once the Kibana container - where you can view the dashboards - is started up, the corresponding parsedmarc dashboards are automatically imported into Kibana by the parsedmarc-init container.
  4. After some while, when everything is up and running, you can then access Kibana and its dashboards under the shipped reverse proxy at https://HOST_IP:9999. (Make sure to use HTTPS!)

Credits

Built with awesome parsedmarc, Elasticsearch and Kibana, nginx, Docker and MaxMind GeoIP.