Skip to content

Commit

Permalink
Improved README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cry-inc committed Jan 21, 2025
1 parent 775c930 commit c20d0ba
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ You can find more screenshots [here](screenshots/screenshots.md).
- [x] Automatic fetching of reports from IMAP inbox
- [x] Robust parsing of XML DMARC reports
- [x] Embedded HTTP server for Web UI
- [x] Responsive Web UI that works also on small screens
- [x] Automatic HTTPS via ACME/Let's Encrypt
- [x] Basic Auth password protection for HTTP server
- [x] Easy configuration via command line arguments or ENV variables
Expand All @@ -51,23 +52,23 @@ The following tags are available (aside from the versioned tag for all individua
* `develop` (Last development build from master branch)

### Configuration
List all available configuration parameters with the corresponding environment variables by running this command:
List all available configuration parameters with the corresponding environment variables and default values by running this command:
`sudo docker run --rm ghcr.io/cry-inc/dmarc-report-viewer ./dmarc-report-viewer --help`.

You can configure the application with command line arguments or environment variables.
For the Docker use case, environment variables are recommended.
Do not forget to forward the port for the HTTP server!
By default the HTTP server will use port 8080.

Here is an example:

sudo docker run --rm \
-e IMAP_HOST=imap.mymailserver.com \
-e IMAP_USER=dmarc@mymailserver.com \
-e IMAP_PASSWORD=mysecurepassword \
-e HTTP_SERVER_PORT=8123 \
-e HTTP_SERVER_USER=webui-user \
-e HTTP_SERVER_PASSWORD=webui-password \
-p 8123:8123 \
-p 8080:8080 \
ghcr.io/cry-inc/dmarc-report-viewer

### IMAP with STARTTLS
Expand Down

0 comments on commit c20d0ba

Please sign in to comment.