updated documentation

This commit is contained in:
Chris 2019-10-06 19:07:22 +02:00
parent f93063b4da
commit b217bc26f7
2 changed files with 11 additions and 1 deletions

View file

@ -30,6 +30,14 @@
- 100% file based, no database needed
- Can be used as Email Honeypot
# Configuration
Just edit the `config.ini` You can use the following settings
- `DOMAINS` -> Comma separated list of domains this mailserver will be receiving emails on. It's just so the web interface can generate random addresses
- `MAILPORT`-> The port the Python powered SMTP server will listen on. Default 25
- `ADMIN` -> An email address (doesn't have to exist, just has to be valid) that will list all emails of all addresses the server has received. Kind of a catch-all
- `DATEFORMAT` -> How should timestamps be shown on the web interface ([moment.js syntax](https://momentjs.com/docs/#/displaying/))
# Roadmap
- [x] Mailserver
- [x] Storing received mails in JSON
@ -45,6 +53,7 @@
- [x] Admin overview for all available email addresses
- [ ] Secure HTML so no malicious things can be loaded
- [ ] Display embedded images inline using Content-ID
- [ ] Option to show raw Email
- [ ] Delete messages
- [ ] Make better theme
@ -72,7 +81,7 @@ docker run -p 80:80 -p 25:25 -v /path/on/host/where/to/save/data:/var/www/opentr
Complete example with running as daemon, persistence, a domain for auto-generation of emails and auto restart
```bash
docker run -d --restart=always --name opentrashmail -e "DOMAINS=mydomain.eu" -p 80:80 -p 25:25 -v /path/on/host/where/to/save/data:/var/www/opentrashmail/data hascheksolutions/opentrashmail
docker run -d --restart=always --name opentrashmail -e "DOMAINS=mydomain.eu" -e "DATEFORMAT='D.M.YYYY HH:mm'" -p 80:80 -p 25:25 -v /path/on/host/where/to/save/data:/var/www/opentrashmail/data hascheksolutions/opentrashmail
```
# How it works

View file

@ -11,6 +11,7 @@ DOMAINS=yourdomain,sub.yourdomain
[MAILSERVER]
; Port that the Mailserver will run on (default 25 but that needs root)
MAILPORT=25
[DATETIME]
; The moment.js format you'd like your date to be formatted in
DATEFORMAT="D.M.YYYY HH:mm"