Add comprehensive documentation for DMARQ, including user guides, deployment instructions, and feature descriptions
- Created main documentation index and user guide with sections on getting started, dashboard overview, managing domains, and reports. - Added detailed deployment guide for Docker and manual installation. - Included user-friendly explanations of DMARC, its benefits, and how to manage domains and reports. - Implemented visual assets for dashboard, domains, IMAP, and reports. - Established requirements for documentation build using MkDocs and Material theme. - Integrated navigation structure for easy access to all documentation sections.
This commit is contained in:
Christian Krakau-Louis
@@ -0,0 +1,6 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="#1A237E" stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
|
||||
<rect x="3" y="3" width="18" height="18" rx="2" ry="2"></rect>
|
||||
<line x1="3" y1="9" x2="21" y2="9"></line>
|
||||
<line x1="9" y1="21" x2="9" y2="9"></line>
|
||||
<circle cx="15" cy="15" r="3"></circle>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 357 B |
@@ -0,0 +1,7 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="#1A237E" stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
|
||||
<path d="M12 2a10 10 0 1 0 0 20 10 10 0 1 0 0-20z"></path>
|
||||
<path d="M2 12h20"></path>
|
||||
<path d="M12 2v20"></path>
|
||||
<path d="M20 16.5a8 8 0 0 0-16 0"></path>
|
||||
<path d="M4 7.5a8 8 0 0 1 16 0"></path>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 365 B |
@@ -0,0 +1,7 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="#1A237E" stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
|
||||
<rect x="2" y="4" width="20" height="16" rx="2" ry="2"></rect>
|
||||
<path d="M22 7l-8.97 5.7a1.94 1.94 0 0 1-2.06 0L2 7"></path>
|
||||
<line x1="2" y1="12" x2="9" y2="12"></line>
|
||||
<line x1="15" y1="12" x2="22" y2="12"></line>
|
||||
<path d="M10 12a2 2 0 0 0 4 0"></path>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 423 B |
@@ -0,0 +1,7 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="#1A237E" stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
|
||||
<path d="M14 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V8z"></path>
|
||||
<polyline points="14 2 14 8 20 8"></polyline>
|
||||
<line x1="16" y1="13" x2="8" y2="13"></line>
|
||||
<line x1="16" y1="17" x2="8" y2="17"></line>
|
||||
<polyline points="10 9 9 9 8 9"></polyline>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 427 B |
@@ -0,0 +1,68 @@
|
||||
# DMARQ Documentation
|
||||
|
||||
<div class="grid cards" markdown>
|
||||
|
||||
- { .lg .middle } **Dashboard**
|
||||
|
||||
Visualize your DMARC compliance with intuitive charts and metrics.
|
||||
|
||||
[:octicons-arrow-right-24: View Dashboard Docs](user_guide/dashboard.md)
|
||||
|
||||
- { .lg .middle } **Domain Management**
|
||||
|
||||
Add, configure, and monitor email domains with ease.
|
||||
|
||||
[:octicons-arrow-right-24: Domain Documentation](user_guide/domains.md)
|
||||
|
||||
- { .lg .middle } **DMARC Reports**
|
||||
|
||||
Receive, parse, and analyze DMARC aggregate reports.
|
||||
|
||||
[:octicons-arrow-right-24: Report Docs](user_guide/reports.md)
|
||||
|
||||
- { .lg .middle } **IMAP Integration**
|
||||
|
||||
Automatically fetch reports from your email inbox.
|
||||
|
||||
[:octicons-arrow-right-24: IMAP Setup](user_guide/imap.md)
|
||||
|
||||
</div>
|
||||
|
||||
## What is DMARQ?
|
||||
|
||||
DMARQ is a modern, user-friendly tool designed to make DMARC (Domain-based Message Authentication, Reporting, and Conformance) implementation accessible for everyone. With a focus on clarity, automation, and actionable insights, DMARQ enables organizations to safeguard their email domains, prevent phishing attacks, and ensure compliance with industry best practices.
|
||||
|
||||
## Quick Start Guide
|
||||
|
||||
Get started with DMARQ in minutes:
|
||||
|
||||
1. [Install DMARQ](deployment/docker.md) using Docker or manual installation
|
||||
2. [Add your domain](user_guide/domains.md#adding-a-domain) to the system
|
||||
3. [Configure IMAP](user_guide/imap.md) to automatically fetch reports (optional)
|
||||
4. [View your dashboard](user_guide/dashboard.md) to monitor compliance
|
||||
|
||||
## Features
|
||||
|
||||
- **Intuitive Dashboard**: Get a clear overview of your email authentication status
|
||||
- **Automatic Report Processing**: Parse and analyze DMARC reports with ease
|
||||
- **Multi-domain Support**: Monitor multiple domains from a single interface
|
||||
- **IMAP Integration**: Automatically fetch reports from your inbox
|
||||
- **Detailed Analytics**: Dive deep into authentication results and trends
|
||||
- **Policy Management**: Safely transition to stricter DMARC policies
|
||||
|
||||
## About DMARC
|
||||
|
||||
DMARC (Domain-based Message Authentication, Reporting, and Conformance) is an email authentication protocol that helps organizations protect their domain from unauthorized use, commonly known as email spoofing. It builds upon two existing mechanisms:
|
||||
|
||||
- **SPF (Sender Policy Framework)**: Specifies which mail servers are authorized to send email on behalf of your domain
|
||||
- **DKIM (DomainKeys Identified Mail)**: Adds a digital signature to emails, allowing receiving servers to verify the email wasn't altered in transit
|
||||
|
||||
By implementing DMARC, domain owners can tell receiving mail servers what to do with messages that don't pass SPF or DKIM authentication checks, while also receiving reports about these authentication failures.
|
||||
|
||||
## Get Support
|
||||
|
||||
Need help with DMARQ? We're here to assist:
|
||||
|
||||
- [Frequently Asked Questions](faq.md)
|
||||
- [GitHub Issues](https://github.com/yourusername/dmarq/issues)
|
||||
- Email support: support@example.com
|
||||
@@ -0,0 +1,6 @@
|
||||
mkdocs==1.4.3
|
||||
mkdocs-material==9.1.15
|
||||
mkdocstrings==0.21.2
|
||||
mkdocstrings-python==1.1.2
|
||||
pymdown-extensions==10.0.1
|
||||
mkdocs-git-revision-date-localized-plugin==1.2.0
|
||||
@@ -0,0 +1,106 @@
|
||||
# Dashboard
|
||||
|
||||
The DMARQ dashboard provides a comprehensive overview of your DMARC compliance status across all your domains. This centralized view allows you to quickly identify compliance issues and track improvements over time.
|
||||
|
||||
## Dashboard Overview
|
||||
|
||||
|
||||
|
||||
The main dashboard is divided into several key sections:
|
||||
|
||||
1. **Domain Summary**: Shows a list of all monitored domains with their compliance rates
|
||||
2. **Compliance Metrics**: Displays overall compliance statistics across all domains
|
||||
3. **Recent Reports**: Shows the most recently received DMARC reports
|
||||
4. **Email Volume Trends**: Charts email volume over time
|
||||
5. **Authentication Results**: Breakdown of SPF, DKIM, and DMARC pass rates
|
||||
|
||||
## Key Metrics Explained
|
||||
|
||||
### Compliance Rate
|
||||
|
||||
The compliance rate represents the percentage of email messages that pass DMARC authentication. This is a key metric for understanding your email authentication health.
|
||||
|
||||
- **90-100%**: Excellent - Your email authentication is working well
|
||||
- **70-89%**: Good - Some improvements may be needed
|
||||
- **Below 70%**: Needs attention - Significant authentication issues exist
|
||||
|
||||
### Email Volume
|
||||
|
||||
The email volume chart shows the number of emails sent using your domains over time. This helps you identify:
|
||||
|
||||
- Unusual spikes that might indicate spam or phishing attempts
|
||||
- Normal sending patterns for your domains
|
||||
- The impact of email marketing campaigns or other planned sending activities
|
||||
|
||||
### Authentication Breakdown
|
||||
|
||||
This section provides detailed insights into how emails are passing or failing authentication:
|
||||
|
||||
- **SPF Results**: Shows pass/fail rates for Sender Policy Framework checks
|
||||
- **DKIM Results**: Shows pass/fail rates for DomainKeys Identified Mail signatures
|
||||
- **DMARC Results**: Shows overall pass/fail rates based on your DMARC policy
|
||||
|
||||
## Filtering and Customization
|
||||
|
||||
The dashboard supports various filtering options to help you focus on specific data:
|
||||
|
||||
1. **Date Range**: Filter data by a specific time period
|
||||
2. **Domain Filter**: Focus on specific domains
|
||||
3. **Compliance Status**: Filter to show only passing or failing results
|
||||
|
||||
To customize your view:
|
||||
|
||||
1. Click the **Filter** button in the top-right corner
|
||||
2. Select your desired filters
|
||||
3. Click **Apply Filters** to update the dashboard view
|
||||
|
||||
## Dashboard Widgets
|
||||
|
||||
### Domain Summary Widget
|
||||
|
||||
The domain summary widget provides at-a-glance information about each domain:
|
||||
|
||||
| Column | Description |
|
||||
|--------|-------------|
|
||||
| Domain | The domain name |
|
||||
| Compliance | Current compliance rate percentage |
|
||||
| Trend | Weekly compliance trend (up/down arrow) |
|
||||
| Policy | Current DMARC policy (none/quarantine/reject) |
|
||||
| Reports | Number of reports received |
|
||||
|
||||
### Compliance Chart
|
||||
|
||||
The compliance chart visualizes your DMARC compliance over time:
|
||||
|
||||
- **Blue Line**: Shows your actual compliance rate
|
||||
- **Red Dashed Line**: Shows the recommended 98% threshold for enforcement
|
||||
- **Green Zone**: Indicates when compliance is high enough for stricter policies
|
||||
|
||||
## Actionable Insights
|
||||
|
||||
The dashboard is designed to provide actionable insights to improve your email authentication:
|
||||
|
||||
1. **Quick Actions**: Each domain has quick action buttons to:
|
||||
- View detailed reports
|
||||
- Check DNS configuration
|
||||
- Update DMARC policy
|
||||
|
||||
2. **Compliance Recommendations**: The system provides automated recommendations based on your compliance levels:
|
||||
- When to move from p=none to p=quarantine
|
||||
- When to move from p=quarantine to p=reject
|
||||
- Specific sending sources that need configuration
|
||||
|
||||
## Exporting Data
|
||||
|
||||
To export dashboard data for reports or further analysis:
|
||||
|
||||
1. Click the **Export** button in the top-right corner
|
||||
2. Choose your preferred format (CSV, PDF, or PNG)
|
||||
3. Select the data range and metrics to include
|
||||
4. Click **Generate Export** to download your data
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Managing Domains](domains.md) - Learn how to add and configure domains
|
||||
- [DMARC Reports](reports.md) - Detailed information about DMARC reports
|
||||
- [DMARC Policies](../reference/policies.md) - Understanding DMARC policies
|
||||
Reference in New Issue
Block a user