Dockerized self-initializing parsedmarc docker stack for lazy people
.github/workflows | ||
data | ||
.gitignore | ||
docker-compose.yml | ||
LICENSE | ||
README.md |
parsedmarc-dockerized
Note: The standalone parsedmarc
docker image on DockerHub @ patschi/parsedmarc can also be used, if interested.
Setup:
- 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
- Next we change the
parsedmarc
config (see docs. You can setTest
toTrue
for testing purposes.)
nano data/conf/parsedmarc/config.ini
- 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
- Finally, we start up the stack and wait:
docker-compose up -d
What's happening then?
- First, the all containers of the stack are created and started. Please notice that this might take a while, as several containers have dependencies on others being in a healthy state (meaning that the service must be fully operating).
- 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 includednginx
webserver. - 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. - 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.