Skip to the content.

parsedmarc-go - High-performance DMARC report analyzer

Build Status Go Version License

parsedmarc-go is a high-performance Go application for parsing and analyzing DMARC reports with native ClickHouse storage and Grafana visualization. It provides enterprise-grade DMARC report processing with superior performance and simplified deployment.

Key Features

Architecture

graph TD
    A[Email Reports] -->|IMAP| B[parsedmarc-go]
    C[HTTP Reports] -->|POST /dmarc/report| B
    D[File Reports] -->|CLI| B
    B --> E[ClickHouse Database]
    B --> F[Prometheus Metrics]
    E --> G[Grafana Dashboard]
    F --> H[Monitoring Stack]

Quick Start

Binary Release

# Download latest release
curl -L -o parsedmarc-go https://github.com/ZenProjects/parsedmarc-go/releases/latest/download/parsedmarc-go-linux-amd64
chmod +x parsedmarc-go

# Run with config
./parsedmarc-go -daemon -config config.yaml

Docker

# Run with docker
docker run -d -p 8080:8080 \
  -v $(pwd)/config.yaml:/app/config.yaml \
  parsedmarc-go:latest

📚 Complete Documentation Guide

Quick Start (5 min)

Quick InstallationFirst Test

🚀 Getting Started

  1. 📦 Installation
    • Binary installation, Docker, and building from source
    • Prerequisites setup (Go, ClickHouse, MaxMind)
    • Quick setup in 5 minutes
  2. ⚙️ Configuration
    • Complete configuration file with examples
    • Environment variables and CLI parameters
    • IMAP, HTTP, ClickHouse, and monitoring configuration

🔧 Usage

  1. 💡 Usage Guide
    • File and directory processing
    • Daemon mode (IMAP + HTTP)
    • Output formats and advanced options
  2. 🌐 HTTP API
    • Report submission endpoints
    • Email provider integrations
    • Authentication and security

📊 Storage and Visualization

  1. 🗃️ ClickHouse
    • Optimized database schema
    • Analysis and reporting queries
    • Performance and optimizations
  2. 📊 Grafana
    • Dashboard installation and configuration
    • Pre-configured visualizations
    • Customization and alerting

📈 Production and Monitoring

  1. 📈 Monitoring
    • Detailed Prometheus metrics
    • Health checks and observability
    • Alerting and surveillance
  2. 📧 Mailing Lists
    • SMTP configuration for reports
    • Integration with notification systems

📖 Reference

  1. 🔒 DMARC Standards
    • Detailed RFC specifications
    • Supported report formats
    • Compatibility and extensions
  2. 🤝 Contributing
    • Code contribution guide
    • Development standards
    • Testing and continuous integration