misc_nixos-mailserver/README.md

118 lines
2.4 KiB
Markdown
Raw Normal View History

2017-09-13 12:03:04 +00:00
# ![Simple Nixos MailServer][logo]
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
2017-09-13 12:03:04 +00:00
2017-09-13 11:16:17 +00:00
## Stable Releases
2017-09-13 11:16:17 +00:00
None so far.
2017-09-20 14:27:52 +00:00
[Latest Release Candidate](https://github.com/r-raymond/nixos-mailserver/releases/latest)
2017-09-13 11:16:17 +00:00
## Features
### v1.1
* Postfix MTA
- [x] smtp on port 25
- [x] submission port 587
2017-08-13 10:58:00 +00:00
- [x] lmtp with dovecot
* Dovecot
2017-09-13 11:16:17 +00:00
- [x] maildir folders
- [x] imap starttls on port 143
- [x] pop3 starttls on port 110
2017-08-13 10:58:00 +00:00
* Certificates
- [x] manual certificates
- [x] on the fly creation
* Spam Filtering
2017-09-13 11:16:17 +00:00
- [x] via rspamd
- [x] hard coded sieve script to move spam into Junk folder
2017-08-13 10:58:00 +00:00
* Virus Scanning
2017-09-13 11:16:17 +00:00
- [x] via clamav
2017-08-13 10:58:00 +00:00
* DKIM Signing
2017-09-13 11:16:17 +00:00
- [x] via opendkim
2017-08-13 10:58:00 +00:00
* User Management
2017-09-13 11:16:17 +00:00
- [x] declarative user management
- [x] declarative password management
### v1.2
* Certificates
- [ ] Let's Encrypt
* Sieves
- [ ] Allow user defined sieve scripts
* User Aliases
- [ ] More complete alias support
### v2.0
* [ ] Multiple Domains
2017-09-13 08:17:04 +00:00
### Changelog
#### v1.0 -> v1.1
* Changed structure to Nix Modules
2017-09-13 11:16:17 +00:00
* Adds Sieve support
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
```
2017-09-13 11:16:17 +00:00
To test imap manually use
```
openssl s_client -host mail.example.com -port 143 -starttls imap
```
2017-09-13 08:17:04 +00:00
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
2017-09-03 13:43:37 +00:00
## Contributors
* Special thanks to @Infinisil for the module rewrite
* @danbst
2017-09-13 08:17:04 +00:00
* @phdoerfler
2017-09-13 12:03:04 +00:00
### Credits
* send mail graphic by [tnp_dreamingmao](https://thenounproject.com/dreamingmao)
from [TheNounProject](https://thenounproject.com/) is licensed under
[CC BY 3.0](http://creativecommons.org/~/3.0/)
* Logo made with [Logomakr.com](https://logomakr.com)
[logo]: logo/logo.png