misc_nixos-mailserver/README.md

94 lines
2 KiB
Markdown
Raw Normal View History

2016-07-21 16:11:43 +00:00
# nixos-mailserver
2016-07-21 16:55:01 +00:00
![license](https://img.shields.io/badge/license-GPL3-brightgreen.svg)
2016-07-21 16:11:43 +00:00
## Work in progress...
2017-08-23 15:37:45 +00:00
### What works and what is missing for first release v 1.0
2017-08-13 10:58:00 +00:00
* Postfix
- [x] starts
- [x] receive email on port 25
2017-08-13 12:05:40 +00:00
- [x] receive email on submission port 587
2017-08-13 10:58:00 +00:00
- [x] lmtp with dovecot
* Dovecot
2017-08-13 13:51:41 +00:00
- [x] lmtp with postfix
2017-08-13 10:58:00 +00:00
- [x] creates maildir folders, saves mails
- [x] imap retrieval
2017-08-13 12:21:30 +00:00
- [x] pop3 retrieval
2017-08-13 10:58:00 +00:00
* Certificates
- [x] manual certificates
- [x] on the fly creation
2017-08-23 15:24:40 +00:00
- [ ] TODO: Let's Encrypt (postponed to future release)
2017-08-13 10:58:00 +00:00
* Spam Filtering
- [x] scans emails
* Virus Scanning
2017-08-13 19:51:07 +00:00
- [x] Checks incoming mail for viruses
2017-08-13 10:58:00 +00:00
* DKIM Signing
2017-08-23 15:24:40 +00:00
- [x] Works
2017-08-13 10:58:00 +00:00
* User Management
- [x] Creates Users
2017-08-13 13:51:41 +00:00
- [x] Set Passwords in config file
2017-08-23 15:37:45 +00:00
* Update Documentation
- [ ] Remove all `TODO`s
- [ ] Write a Starter Guide
- [ ] Make a Small Homepage
- [ ] Flesh Out Documentation
* Test
- [ ] Test
- [ ] Squash Bugs
- [ ] Test
- [ ] ...
2017-08-13 10:58:00 +00:00
2017-08-12 09:52:01 +00:00
### How to Test
You can test the setup via `nixops`. After installation, do
```
nixops create nixops/single-server.nix nixops/vbox.nix -d mail
nixops deploy -d mail
nixops info -d mail
```
You can then test the server via e.g. `telnet`. To log into it, use
```
nixops ssh -d mail mailserver
```
2016-07-21 16:11:43 +00:00
## A Complete Mail Server Without Moving Parts
### Used Technologies
2017-08-12 09:37:54 +00:00
* Nixos
* Nixpkgs
* Dovecot
* Postfix
* Rmilter
* Rspamd
* Clamav
* Opendkim
* Pam
2016-07-21 16:20:56 +00:00
### Features
* one domain
* unlimited mail accounts
2016-07-21 16:20:56 +00:00
* unlimited aliases for every mail account
* spam and virus checking
* dkim signing of outgoing emails
2016-07-21 16:42:14 +00:00
* imap (optionally pop3)
* startTLS
2016-07-21 16:20:56 +00:00
### Nonfeatures
* moving parts
* SQL databases
* configurations that need to be made after `nixos-rebuild switch`
* complicated storage schemes
* webclients / http-servers
2017-08-13 12:05:40 +00:00
## Ideas for future releases
* Fine grained control over ownership of aliases
* More than one domain
2017-08-23 15:24:40 +00:00
* Let's Encrypt
2017-09-03 13:43:37 +00:00
## Contributors
* Special thanks to @Infinisil for the module rewrite
* @danbst