diff --git a/README.md b/README.md index 9671af0..120e3c2 100644 --- a/README.md +++ b/README.md @@ -1 +1,114 @@ -# dmarq \ No newline at end of file +# DMARQ + +**DMARQ** is a modern, privacy-conscious DMARC monitoring and analysis platform built for professionals who want deep visibility into their email authentication posture β€” without giving up control or relying on third-party SaaS providers. + +🌐 [Live Demo (soon)](https://app.dmarq.org) +πŸ”’ Self-hosted. Secure. Beautifully visual. +πŸ› οΈ Docker-deployable. Cloudflare-integrated. +πŸ“¬ Aggregate & forensic report support. + +--- + +## πŸ’‘ What is DMARQ? + +DMARQ ingests and visualizes DMARC (Domain-based Message Authentication, Reporting & Conformance) reports β€” both aggregate and forensic β€” to help domain owners understand who is sending emails on their behalf and whether those messages are properly authenticated using SPF and DKIM. + +No more guessing. See which services are passing DMARC, which are failing, and how to fix them β€” all in one clear dashboard. + +--- + +## ✨ Key Features + +### πŸ“Š Dashboard & Reports +- **DMARC Compliance Rate**: Track pass/fail rates over time +- **Enforcement Rate**: Visualize policy strength and adoption +- **Volume & Trends**: Identify traffic spikes and anomalies +- **Top Sending Sources**: Detect unknown or unauthorized senders +- **Forensic Reports**: Analyze failure samples (RFC 6591 support) + +### πŸ›‘ DNS Record Health +- Inspect **SPF**, **DKIM**, **DMARC**, **MX**, and **BIMI** records +- Show which records are missing, broken, or invalid +- Get **fix suggestions** tailored to your provider (e.g., Google, Microsoft) +- πŸ”’ No automatic changes β€” all DNS updates require explicit confirmation + +### 🌐 Cloudflare Integration +- Automatically discover domains in your Cloudflare account +- Fetch and analyze relevant DNS records +- Suggest missing or malformed entries +- Track configuration changes over time (coming soon) + +### βš™οΈ Web-Based Setup Wizard +- Guided onboarding experience (no CLI setup required) +- Store all configuration in a secure internal database +- Seed config with environment variables for headless deployment + +### 🚨 Alerts & Notifications +- Integration with [Apprise](https://github.com/caronc/apprise) +- Email, Slack, webhook, and more +- Alert on new failures, compliance drops, or unknown senders + +### πŸ” User Management +- Built-in authentication via **FastAPI Users** +- JWT-secured API endpoints +- Admin dashboard access control + +--- + +## πŸš€ Getting Started + +You can deploy DMARQ in minutes using Docker Compose: + +```bash +git clone https://github.com/YOUR_USERNAME/dmarq.git +cd dmarq +cp .env.example .env +docker compose up --build +``` + +Then visit [http://localhost:8000](http://localhost:8000) to launch the config wizard and connect your inbox & Cloudflare account. + +--- + +## πŸ“¦ Requirements + +- IMAP inbox for DMARC reports (e.g. `dmarc@yourdomain.com`) +- Cloudflare API token (read access to zones and DNS) +- Docker + Docker Compose +- DMARC reporting enabled for your domain (via `rua=` and `ruf=`) + +--- + +## πŸ§ͺ Status + +- βœ… DMARC aggregate & forensic report ingestion +- βœ… Dashboard & alerting +- βœ… Web-based config wizard +- βœ… Docker-based deployment +- πŸ”œ Rule-based alerts +- πŸ”œ Multi-tenant support +- πŸ”œ Self-updating DNS snapshot history + +--- + +## πŸ“˜ License + +MIT License β€” you are free to use, modify, and host DMARQ for any purpose. + +--- + +## 🀝 Contributing + +Pull requests are welcome! Please open an issue to discuss major features or design ideas before submitting code. Full contributing guide coming soon. + +--- + +## πŸ›‘ Why DMARQ? + +Unlike most commercial DMARC tools, DMARQ gives you: +- πŸ” Full visibility without third-party access to your reports +- 🧠 Intelligence-driven suggestions, not just raw data +- 🎨 A beautiful, intuitive dashboard with real-time insights +- πŸ’» Self-hosted flexibility with modern developer practices + +Let’s build better email security β€” together.