update readme

This commit is contained in:
Robin Raymond 2017-09-13 13:16:17 +02:00
parent 4b8669b2fe
commit 70f35ced38

View file

@ -1,44 +1,51 @@
# nixos-mailserver # nixos-mailserver
![license](https://img.shields.io/badge/license-GPL3-brightgreen.svg) ![license](https://img.shields.io/badge/license-GPL3-brightgreen.svg)
## Work in progress... ## Stable Releases
### What works and what is missing for first release v 1.0 None so far.
* Postfix
- [x] starts ## Features
- [x] receive email on port 25 ### v1.1
- [x] receive email on submission port 587 * Postfix MTA
- [x] smtp on port 25
- [x] submission port 587
- [x] lmtp with dovecot - [x] lmtp with dovecot
* Dovecot * Dovecot
- [x] lmtp with postfix - [x] maildir folders
- [x] creates maildir folders, saves mails - [x] imap starttls on port 143
- [x] imap retrieval - [x] pop3 starttls on port 110
- [x] pop3 retrieval
* Certificates * Certificates
- [x] manual certificates - [x] manual certificates
- [x] on the fly creation - [x] on the fly creation
- [ ] TODO: Let's Encrypt (postponed to future release)
* Spam Filtering * Spam Filtering
- [x] scans emails - [x] via rspamd
- [x] hard coded sieve script to move spam into Junk folder
* Virus Scanning * Virus Scanning
- [x] Checks incoming mail for viruses - [x] via clamav
* DKIM Signing * DKIM Signing
- [x] Works - [x] via opendkim
* User Management * User Management
- [x] Creates Users - [x] declarative user management
- [x] Set Passwords in config file - [x] declarative password management
* Update Documentation
- [ ] Remove all `TODO`s
- [ ] Write a Starter Guide ### v1.2
- [ ] Make a Small Homepage * Certificates
- [ ] Flesh Out Documentation - [ ] Let's Encrypt
* Test * Sieves
- [ ] Write Tests to ensure integrity - [ ] Allow user defined sieve scripts
* User Aliases
- [ ] More complete alias support
### v2.0
* [ ] Multiple Domains
### Changelog ### Changelog
#### v1.0 -> v1.1 #### v1.0 -> v1.1
* Changed structure to Nix Modules * Changed structure to Nix Modules
* Adds Sieve support
### How to Test ### How to Test
@ -56,7 +63,12 @@ You can then test the server via e.g. `telnet`. To log into it, use
nixops ssh -d mail mailserver nixops ssh -d mail mailserver
``` ```
To test imap manually openssl s_client -host mail.example.com -port 143 -starttls imap To test imap manually use
```
openssl s_client -host mail.example.com -port 143 -starttls imap
```
## A Complete Mail Server Without Moving Parts ## A Complete Mail Server Without Moving Parts
@ -87,11 +99,6 @@ To test imap manually openssl s_client -host mail.example.com -port 143 -starttl
* complicated storage schemes * complicated storage schemes
* webclients / http-servers * webclients / http-servers
## Ideas for future releases
* Fine grained control over ownership of aliases
* More than one domain
* Let's Encrypt
## Contributors ## Contributors
* Special thanks to @Infinisil for the module rewrite * Special thanks to @Infinisil for the module rewrite
* @danbst * @danbst