-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Zoey <[email protected]>
- Loading branch information
Showing
1 changed file
with
13 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,40 +1,30 @@ | ||
# parsedmarc-dockerized | ||
|
||
Note: The standalone `parsedmarc` docker image on [DockerHub @ patschi/parsedmarc](https://hub.docker.com/r/patschi/parsedmarc) can also be used, if interested. | ||
|
||
## Setup: | ||
1. Get basics together: | ||
1. Download the compose.yaml and edit it: | ||
``` | ||
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 | ||
wget https://raw.githubusercontent.com/ZoeyVid/parsedmarc-dockerized/develop/compose.yml | ||
nano compose.yaml | ||
``` | ||
|
||
2. Next we change the `parsedmarc` config (see [docs](https://domainaware.github.io/parsedmarc/#configuration-file). You can set `Test` to `True` for testing purposes.) | ||
2. now adjust the value `GEOIPUPDATE_ACCOUNT_ID` and `GEOIPUPDATE_LICENSE_KEY` from your [MaxMind account](https://maxmind.com) | ||
``` | ||
nano data/conf/parsedmarc/config.ini | ||
``` | ||
|
||
3. Now we create an environment file, containing your geoipupdate settings from your [MaxMind account](https://www.maxmind.com/en/account/) to allow the container to pull the databases. For update cycles of the databases, please see [here](https://support.maxmind.com/geoip-faq/geoip2-and-geoip-legacy-database-updates/how-often-are-the-geoip2-and-geoip-legacy-databases-updated/). (Fill in your data!) | ||
3. Now depoly the stack | ||
``` | ||
cat > geoipupdate.env <<EOF | ||
GEOIPUPDATE_ACCOUNT_ID=HERE_GOES_YOUR_ACCOUNT_ID | ||
GEOIPUPDATE_LICENSE_KEY=HERE_GOES_YOUR_LICENSE_KEY | ||
GEOIPUPDATE_FREQUENCY=24 | ||
EOF | ||
docker compose up -d | ||
``` | ||
|
||
4. Finally, we start up the stack and wait: | ||
4. now you can edit the config.ini | ||
``` | ||
docker-compose up -d | ||
nano /opt/parsedmarc/conf/config.ini | ||
``` | ||
|
||
### 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 | ||
5. now restart your container: | ||
``` | ||
docker restart parsedmarc | ||
``` | ||
|
||
Built with awesome [parsedmarc](https://github.com/domainaware/checkdmarc), [Elasticsearch and Kibana](https://www.elastic.co/), [nginx](https://nginx.org), [Docker](https://docker.com) and [MaxMind GeoIP](https://dev.maxmind.com/geoip/geoip2/geolite2/). | ||
6. configure your reverse proxy to `http://127.0.0.1:5601` |