Change images and documentation

This commit is contained in:
Manuel 2021-10-17 21:01:51 +02:00
parent 3d5f2e90b6
commit b4a6519776
Signed by: Manuel
GPG key ID: 4085037435E1F07A
2 changed files with 7 additions and 14 deletions

View file

@ -1,11 +1,11 @@
# parsedmarc-dockerized # 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. Note: The standalone `parsedmarc` docker image on [DockerHub @ sunred/parsedmarc](https://hub.docker.com/r/sunred/parsedmarc) can also be used, if interested.
## Setup: ## Setup:
1. Get basics together: 1. Get basics together:
``` ```
git clone https://github.com/patschi/parsedmarc-dockerized.git /opt/parsedmarc-dockerized/ git clone https://git.snrd.de/sunred/parsedmarc-dockerized.git /opt/parsedmarc-dockerized/
cd /opt/parsedmarc-dockerized/ && cp data/conf/parsedmarc/config.sample.ini data/conf/parsedmarc/config.ini cd /opt/parsedmarc-dockerized/ && cp data/conf/parsedmarc/config.sample.ini data/conf/parsedmarc/config.ini
``` ```
@ -14,14 +14,7 @@ cd /opt/parsedmarc-dockerized/ && cp data/conf/parsedmarc/config.sample.ini data
nano data/conf/parsedmarc/config.ini 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. To use the geoip updater for automatic geo location resolution you have to [create an account](https://www.maxmind.com/en/geolite2/signup) on the MaxMind website and add your license key you can retrieve from your [account page](https://www.maxmind.com/en/account) to `data/conf/geoipupdate.env`. More information in the [documentation](https://crazymax.dev/geoip-updater/usage/prerequisites/).
```
cat > geoipupdate.env <<EOF
GEOIPUPDATE_ACCOUNT_ID=HERE_GOES_YOUR_ACCOUNT_ID
GEOIPUPDATE_LICENSE_KEY=HERE_GOES_YOUR_LICENSE_KEY
GEOIPUPDATE_FREQUENCY=24
EOF
```
4. Finally, we start up the stack and wait: 4. Finally, we start up the stack and wait:
``` ```
@ -33,8 +26,8 @@ docker-compose up -d
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). 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. 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. 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!) 4. After a while, when everything is up and running, you can then access Kibana and its dashboards at `localhost:5601` that you can reverse proxy on your host system.
## Credits ## Credits
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/). Built with awesome [parsedmarc](https://github.com/domainaware/checkdmarc), [Elasticsearch and Kibana](https://www.elastic.co/), [Docker](https://docker.com) and [MaxMind GeoIP](https://dev.maxmind.com/geoip/geoip2/geolite2/).

View file

@ -1,6 +1,6 @@
services: services:
parsedmarc-init: parsedmarc-init:
image: patschi/parsedmarc:init image: sunred/parsedmarc:init
container_name: parsedmarc-init container_name: parsedmarc-init
build: build:
context: ./data/Dockerfiles/parsedmarc-init context: ./data/Dockerfiles/parsedmarc-init
@ -18,7 +18,7 @@ services:
retries: 9999 retries: 9999
start_period: 10s start_period: 10s
parsedmarc: parsedmarc:
image: patschi/parsedmarc:latest image: sunred/parsedmarc:latest
container_name: parsedmarc container_name: parsedmarc
build: build:
context: ./data/Dockerfiles/parsedmarc context: ./data/Dockerfiles/parsedmarc