2017-09-13 12:03:04 +00:00
|
|
|
# ![Simple Nixos MailServer][logo]
|
2016-07-21 16:55:01 +00:00
|
|
|
|
2018-11-10 12:37:38 +00:00
|
|
|
[](https://gitlab.com/simple-nixos-mailserver/nixos-mailserver/commits/master)
|
2016-07-21 16:11:43 +00:00
|
|
|
|
2017-09-13 12:03:04 +00:00
|
|
|
|
2020-05-08 18:18:55 +00:00
|
|
|
## Release branches
|
2016-07-21 16:55:59 +00:00
|
|
|
|
2020-05-08 18:18:55 +00:00
|
|
|
For each NixOS release, we publish a branch. You then have to use the
|
|
|
|
|
SNM branch corresponding to your NixOS version.
|
|
|
|
|
|
2024-06-03 09:57:22 +00:00
|
|
|
* For NixOS 24.05
|
|
|
|
|
- Use the [SNM branch `nixos-24.05`](https://gitlab.com/simple-nixos-mailserver/nixos-mailserver/-/tree/nixos-24.05)
|
|
|
|
|
- [Documentation](https://nixos-mailserver.readthedocs.io/en/nixos-24.05/)
|
|
|
|
|
- [Release notes](https://nixos-mailserver.readthedocs.io/en/nixos-24.05/release-notes.html#nixos-24-05)
|
2023-12-19 22:07:52 +00:00
|
|
|
* For NixOS 23.11
|
|
|
|
|
- Use the [SNM branch `nixos-23.11`](https://gitlab.com/simple-nixos-mailserver/nixos-mailserver/-/tree/nixos-23.11)
|
|
|
|
|
- [Documentation](https://nixos-mailserver.readthedocs.io/en/nixos-23.11/)
|
|
|
|
|
- [Release notes](https://nixos-mailserver.readthedocs.io/en/nixos-23.11/release-notes.html#nixos-23-11)
|
2020-05-22 12:52:45 +00:00
|
|
|
* For NixOS unstable
|
|
|
|
|
- Use the [SNM branch `master`](https://gitlab.com/simple-nixos-mailserver/nixos-mailserver/-/tree/master)
|
2020-11-30 07:55:26 +00:00
|
|
|
- [Documentation](https://nixos-mailserver.readthedocs.io/en/latest/)
|
2017-09-20 14:27:52 +00:00
|
|
|
|
2017-12-14 16:12:30 +00:00
|
|
|
[Subscribe to SNM Announcement List](https://www.freelists.org/list/snm)
|
|
|
|
|
This is a very low volume list where new releases of SNM are announced, so you
|
2023-05-30 21:27:38 +00:00
|
|
|
can stay up to date with bug fixes and updates.
|
2017-12-14 16:12:30 +00:00
|
|
|
|
2017-12-22 17:51:57 +00:00
|
|
|
|
2017-09-13 11:16:17 +00:00
|
|
|
## Features
|
2017-11-11 15:15:30 +00:00
|
|
|
### v2.0
|
2017-11-21 07:52:54 +00:00
|
|
|
* [x] Continous Integration Testing
|
2017-11-11 15:15:30 +00:00
|
|
|
* [x] Multiple Domains
|
2017-09-13 11:16:17 +00:00
|
|
|
* Postfix MTA
|
|
|
|
|
- [x] smtp on port 25
|
2020-07-06 08:38:12 +00:00
|
|
|
- [x] submission tls on port 465
|
|
|
|
|
- [x] submission starttls on 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
|
2020-07-06 08:38:12 +00:00
|
|
|
- [x] imap with tls on port 993
|
|
|
|
|
- [x] pop3 with tls on port 995
|
|
|
|
|
- [x] imap with starttls on port 143
|
|
|
|
|
- [x] pop3 with starttls on port 110
|
2017-08-13 10:58:00 +00:00
|
|
|
* Certificates
|
|
|
|
|
- [x] manual certificates
|
|
|
|
|
- [x] on the fly creation
|
2017-11-11 15:15:30 +00:00
|
|
|
- [x] Let's Encrypt
|
2017-08-13 10:58:00 +00:00
|
|
|
* Spam Filtering
|
2017-09-13 11:16:17 +00:00
|
|
|
- [x] via rspamd
|
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
|
2017-11-20 06:16:08 +00:00
|
|
|
* Sieves
|
|
|
|
|
- [x] A simple standard script that moves spam
|
|
|
|
|
- [x] Allow user defined sieve scripts
|
2018-01-07 12:15:36 +00:00
|
|
|
- [x] ManageSieve support
|
2017-12-20 07:40:58 +00:00
|
|
|
* User Aliases
|
|
|
|
|
- [x] Regular aliases
|
|
|
|
|
- [x] Catch all aliases
|
2017-09-13 11:16:17 +00:00
|
|
|
|
2017-11-11 15:15:30 +00:00
|
|
|
### In the future
|
2017-11-20 06:16:08 +00:00
|
|
|
|
2017-11-11 15:15:30 +00:00
|
|
|
* DKIM Signing
|
|
|
|
|
- [ ] Allow a per domain selector
|
2017-09-13 08:17:04 +00:00
|
|
|
|
2021-03-10 17:46:03 +00:00
|
|
|
### Get in touch
|
2017-09-13 08:17:04 +00:00
|
|
|
|
2021-03-10 17:46:03 +00:00
|
|
|
- Subscribe to the [mailing list](https://www.freelists.org/archive/snm/)
|
2021-06-06 08:21:14 +00:00
|
|
|
- Join the Libera Chat IRC channel `#nixos-mailserver`
|
2017-11-11 15:15:30 +00:00
|
|
|
|
2023-01-01 17:38:07 +00:00
|
|
|
## How to Set Up a 10/10 Mail Server Guide
|
2017-10-17 09:52:47 +00:00
|
|
|
|
2023-01-01 17:38:07 +00:00
|
|
|
Check out the [Setup Guide](https://nixos-mailserver.readthedocs.io/en/latest/setup-guide.html) in the project's documentation.
|
2017-08-12 09:52:01 +00:00
|
|
|
|
2023-01-01 17:38:07 +00:00
|
|
|
For a complete list of options, [see in readthedocs](https://nixos-mailserver.readthedocs.io/en/latest/options.html).
|
2017-11-10 15:57:11 +00:00
|
|
|
|
2018-02-28 13:07:50 +00:00
|
|
|
## Development
|
2017-11-10 16:16:21 +00:00
|
|
|
|
2023-05-23 21:06:06 +00:00
|
|
|
See the [How to Develop SNM](https://nixos-mailserver.readthedocs.io/en/latest/howto-develop.html) documentation page.
|
2020-05-22 12:52:45 +00:00
|
|
|
|
2017-09-03 13:43:37 +00:00
|
|
|
## Contributors
|
2020-05-26 19:00:37 +00:00
|
|
|
See the [contributor tab](https://gitlab.com/simple-nixos-mailserver/nixos-mailserver/-/graphs/master)
|
2017-11-21 11:07:07 +00:00
|
|
|
|
2017-11-21 08:45:59 +00:00
|
|
|
### Alternative Implementations
|
|
|
|
|
* [NixCloud Webservices](https://github.com/nixcloud/nixcloud-webservices)
|
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)
|
|
|
|
|
|
2017-11-21 08:45:59 +00:00
|
|
|
|
2021-07-23 19:24:22 +00:00
|
|
|
[logo]: docs/logo.png
|
