External/docker-dmarc-report
1
0
Fork 0
mirror of https://github.com/gutmensch/docker-dmarc-report.git synced 2025-12-29 16:15:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

move to other root dir

Browse Source
This commit is contained in:
Robert Schumann
2018-03-31 22:42:24 +02:00
parent 129ee4bd9a
commit 913420af75
5 changed files with 38 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@@ -1,8 +1,14 @@
# docker-dmarc-report [![Docker Pulls](https://img.shields.io/docker/pulls/gutmensch/dmarc-report.svg)](https://registry.hub.docker.com/u/gutmensch/dmarc-report/)
This image is intended to combine a dmarc report parser (see https://github.com/techsneeze/dmarcts-report-parser by TechSneeze.com and John Bieling) with a report viewer (see https://github.com/techsneeze/dmarcts-report-viewer/ by the same people) into a runnable docker image / microservice. It fetches dmarc report mails regularly from an IMAP server, stores them into a MySQL DB, deletes them from IMAP and show them via Webserver/PHP module.
This image is intended to combine a dmarc report parser (see https://github.com/techsneeze/dmarcts-report-parser by TechSneeze.com and John Bieling) with a report viewer (see https://github.com/techsneeze/dmarcts-report-viewer/ by the same people) into a runnable docker image / microservice.
## Usage
It fetches dmarc report mails regularly from an IMAP server, stores them into a MySQL DB and visualizes them via Webserver/PHP module.
## Howto
1. Create a _dmarc.example.com TXT DNS record for your domain, containg a mail address (IMAP postbox)
2. Create a MySQL Database and a user for this service
3. Run this docker image with below mentioned env vars
4. Access port 80 on the container (or 443) or put it behind a reverse proxy to view reports
```
docker pull gutmensch/dmarc-report
docker run -ti gutmensch/dmarc-report
@@ -12,3 +18,24 @@ docker run -ti gutmensch/dmarc-report
dmarcts report viewer: 2018-03-31
dmarcts report parser: 2018-03-31
## Sample docker compose / Environment variables
```
dmarc-report:
image: "gutmensch/dmarc-report:latest"
hostname: dmarc-report
container_name: dmarc-report
environment:
- "TEMPLATE_NGINX_HTML=1"
- "TEMPLATE_PERL_CONF=1"
- "REPORT_DB_HOST=mysql"
- "REPORT_DB_NAME=dmarc_report"
- "REPORT_DB_USER=dmarc_report"
- "REPORT_DB_PASS=foobar"
- "PARSER_IMAP_SERVER_WITH_PORT=mail:143"
- "PARSER_IMAP_USER=foobar@example.com
- "PARSER_IMAP_PASS=foobar"
- "PARSER_IMAP_READ_FOLDER=Inbox"
- "PARSER_IMAP_MOVE_FOLDER=processed"
- "PARSER_PROCESS_INTERVAL=@hourly"
```