diff --git a/README.md b/README.md index efea994..cece623 100644 --- a/README.md +++ b/README.md @@ -4,34 +4,38 @@ ๐ŸŒ [Live Demo (soon)](https://app.dmarq.org) ๐Ÿ”’ Self-hosted. Secure. Beautifully visual. -๐Ÿ› ๏ธ Docker-deployable. Cloudflare-integrated. -๐Ÿ“ฌ Aggregate & forensic report support. +๐Ÿ› ๏ธ Docker-deployable. DNS posture checks (Cloudflare inspection planned). +๐Ÿ“ฌ Aggregate report support (failure/forensic reports planned). --- ## ๐Ÿ’ก 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. +DMARQ ingests and visualizes DMARC (Domain-based Message Authentication, Reporting & Conformance) reports โ€” primarily aggregate (RUA) reports today โ€” 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. --- -## ๐Ÿš€ Current Status - Milestone 1 Completed +## ๐Ÿš€ Current Status (Milestones 1โ€“7 Complete) -We have achieved **Milestone 1: Basic DMARC Monitoring**. This milestone includes: +DMARQ currently supports end-to-end aggregate DMARC monitoring with mailbox ingestion, persistence, reporting, DNS checks, and notifications. -- โœ… DMARC XML report parsing (supports XML, ZIP, and GZIP formats) -- โœ… In-memory storage of report data for up to 5 domains -- โœ… Simple dashboard UI showing DMARC compliance statistics -- โœ… Support for uploading and processing DMARC aggregate reports -- โœ… Domain overview with compliance rates and email statistics +Included: -You can now: -1. Upload DMARC aggregate reports via the web interface -2. View summary statistics across all monitored domains -3. Drill down into domain-specific details and reports -4. Track compliance rates and authentication failures +- โœ… DMARC aggregate XML report parsing (XML, ZIP, GZIP) +- โœ… Upload ingestion + mailbox ingestion (IMAP + Gmail OAuth) +- โœ… Database persistence (SQLite/PostgreSQL) + migrations +- โœ… Dashboard trends, domain timelines, and sender/source analytics +- โœ… Import history + backfills for mail sources +- โœ… Alerts & notifications via Apprise (test send, alert rules, daily/weekly summaries) +- โœ… DNS checks (DMARC/SPF/DKIM) with DKIM selector discovery from report data + +Up next: + +- ๐Ÿ”œ DNS health guidance + optional Cloudflare read-only inspection (Milestone 8) +- ๐Ÿ”œ Setup and operations polish (Milestone 9) +- ๐ŸงŠ Failure/forensic report support (RUF) (Milestone 10) --- @@ -39,24 +43,23 @@ You can now: ### ๐Ÿ“Š 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) +- **Actionable Recommendations**: Prioritize what to fix next +- **Export**: CSV export for selected domains and date ranges ### ๐Ÿ›ก DNS Record Health -- Inspect **SPF**, **DKIM**, **DMARC**, **MX**, and **BIMI** records +- Inspect **SPF**, **DKIM**, and **DMARC** records +- Discover likely **DKIM selectors** from report data - 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 +- ๐Ÿ”’ No automatic changes โ€” all DNS updates require explicit confirmation (when remediation workflows are added) -### ๐ŸŒ 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) +### ๐ŸŒ Cloudflare Integration (Planned) +- Optional read-only domain discovery and DNS inspection +- Suggestions for missing or malformed entries +- Track configuration changes over time -### โš™๏ธ Web-Based Setup Wizard +### โš™๏ธ Web-Based Setup Wizard (Planned / In Progress) - Guided onboarding experience (no CLI setup required) - Store all configuration in a secure internal database - Seed config with environment variables for headless deployment @@ -64,14 +67,13 @@ You can now: ### ๐Ÿšจ Alerts & Notifications - Integration with [Apprise](https://github.com/caronc/apprise) - Email, Slack, webhook, and more -- Alert on new failures, compliance drops, or unknown senders +- Alert on new senders, compliance drops, elevated failures, or missing reports - Daily and weekly DMARC summaries - Alert history for active and resolved alerts -### ๐Ÿ” User Management -- Built-in authentication via **FastAPI Users** -- JWT-secured API endpoints -- Admin dashboard access control +### ๐Ÿ” Authentication +- Logto-based authentication integration +- Explicit auth-disabled mode for local development --- @@ -138,16 +140,15 @@ settings. --- -## ๐Ÿงช Development Roadmap +## ๐Ÿงญ Development Roadmap -- โœ… **Milestone 1**: Basic DMARC Monitoring (up to 5 domains) -- โœ… **Milestone 2**: IMAP Integration -- โœ… **Milestone 3**: Database Persistence -- ๐Ÿ”œ **Milestone 4**: Enhanced Dashboard & Visualization -- ๐Ÿ”œ **Milestone 5**: User Authentication & Multi-User Support +- โœ… **Milestones 1โ€“7**: Parsing, ingestion (upload/IMAP/Gmail), persistence, reporting, notifications, production hardening +- ๐Ÿ”œ **Milestone 8**: DNS health guidance + Cloudflare read-only inspection +- ๐Ÿ”œ **Milestone 9**: Setup and operations polish +- ๐ŸงŠ **Milestone 10**: Failure/forensic report support (RUF) +- ๐Ÿง  **Milestones 11โ€“16**: DMARC format compatibility, Microsoft 365 ingestion, broader email posture, APIs/webhooks, workspaces/MSP, AI/MCP (see docs) -See the full [Roadmap](docs/development/roadmap.md) and [TODO](TODO.md) for details -on what is planned vs. what is currently implemented. +See the full [Roadmap](docs/development/roadmap.md) and [Milestones](docs/milestones.md). --- @@ -172,7 +173,7 @@ automated versioning and changelog generation. 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 +- ๐ŸŽจ A beautiful, intuitive dashboard with actionable insights - ๐Ÿ’ป Self-hosted flexibility with modern developer practices Let's build better email security โ€” together.