@@ -9,7 +9,7 @@ A lightweight selfhosted standalone DMARC report viewer that automatically fetch
9
9
Ideal for smaller selfhosted mailservers.
10
10
The application is a single fully statically linked executable written in Rust.
11
11
It combines a DMARC report parser with an IMAP client and an HTTP server.
12
- The HTTP server serves a web UI for easy access and filtering of the reports.
12
+ The embedded HTTP server offers a web UI for easy access and filtering of the reports.
13
13
14
14
You can run the precompiled executable directly on any Linux, Windows or MacOS system.
15
15
Alternatively, you can use the tiny 10 MB Docker image to deploy the application.
@@ -20,14 +20,16 @@ You can find more screenshots [here](screenshots/screenshots.md).
20
20
21
21
## Features
22
22
- [x] Lightweight Docker image for easy deployment
23
+ - [x] Prebuilt binaries and Docker images
24
+ - [x] Runs out of the box on a Raspberry Pi
23
25
- [x] Secure IMAP client (TLS & STARTTLS)
24
26
- [x] Automatic fetching of reports from IMAP inbox
25
27
- [x] Robust parsing of XML DMARC reports
26
- - [x] Embedded HTTP server for web UI
28
+ - [x] Embedded HTTP server for Web UI
27
29
- [x] Automatic HTTPS via ACME/Let's Encrypt
28
30
- [x] Basic Auth password protection for HTTP server
29
31
- [x] Easy configuration via command line arguments or ENV variables
30
- - [x] Configurable maximum size of mails (to skip oversized documents )
32
+ - [x] Configurable maximum size of mails (to skip oversized mails )
31
33
- [x] Summary with charts for domains, organizations and passed/failed checks
32
34
- [x] Viewing filtered lists of reports
33
35
- [x] Viewing of individual DMARC reports
@@ -40,13 +42,13 @@ You can find more screenshots [here](screenshots/screenshots.md).
40
42
Read the [ CHANGELOG.md] ( CHANGELOG.md ) file for a list of all released versions and their corresponding changes.
41
43
42
44
## Run with Docker
43
- The latest version is automatically published as Docker image in the GitHub container registry.
44
- You can download the image using the command ` sudo docker pull ghcr.io/cry-inc/dmarc-report-viewer ` .
45
+ The latest versions are automatically published as Docker images in the GitHub container registry.
46
+ You can download the latest release using the command ` sudo docker pull ghcr.io/cry-inc/dmarc-report-viewer ` .
45
47
46
48
### Available Docker Tags
47
49
The following tags are available (aside from the versioned tag for all individual releases):
48
50
* ` latest ` (Latest stable release)
49
- * ` develop ` (Last build from master branch)
51
+ * ` develop ` (Last development build from master branch)
50
52
51
53
### Configuration
52
54
List all available configuration parameters with the corresponding environment variables by running this command:
@@ -76,7 +78,7 @@ For STARTTLS set the ENV variables `IMAP_STARTTLS=TRUE` and `IMAP_PORT=143`.
76
78
By default, the application will start an unencrypted and unsecure HTTP server.
77
79
It is * strongly* recommended use the automatic HTTPS feature that will automatically fetch and renew a certificate from Let's Encrypt.
78
80
This feature uses the TLS-ALPN-01 challenge, which uses the HTTPS port 443 also for the challenge. No port 80 required!
79
- Alternatively, you can use an separate HTTPS reverse proxy like [ Caddy] ( https://caddyserver.com/ ) to secure it .
81
+ Alternatively, you can use an separate HTTPS reverse proxy like [ Caddy] ( https://caddyserver.com/ ) to secure the application .
80
82
81
83
To use the automatic HTTPS feature you need to make sure that the public port exposed to the internet is 443.
82
84
You should also persist the certificate caching directory on your host file system:
@@ -104,7 +106,7 @@ You should also persist the certificate caching directory on your host file syst
104
106
5 . Use the help argument to list all possible configuration parameters: ` dmarc-report-viewer --help `
105
107
106
108
### Docker Builds (Linux only)
107
- The Dockerfile works for X86-64 and AArch64 (Raspberry Pi & Apple Silicon) architectures.
109
+ The Dockerfile works for ` amd64 ` and ` arm64 ` architectures.
108
110
1 . Install Docker
109
111
2 . Check out this repository (or download and extract the ZIP file)
110
112
3 . Run the command ` sudo docker build . --pull --tag dmarc-report-viewer ` in the folder with this README file
0 commit comments