Forked repo to test stuff on
Find a file
Martin Weinelt 1873ed0908
README: Update existing and future features
As the ecosystems around us evolve so should the NixOS mailserver
project.

DKIM signing could be improved by allowing users to treat DKIM keys like
a secret that they would commonly manage through agenix/sops/etc.

Forwarding mail these days requires SRS and possibly ARC. The latter has
already become a required feature for bulk message to iCloud[1] and
Google Mail[3]. I propose that we stay ahead of the curve by adding
support for these features.

LDAP user management was added, but one pain point is that we currently
prevent it from coexisting with declarative users.

And finally Oauth (via RFC7628[3]) is the new kid on the block that everyone
wants to try out, but most notably client support[4] for hosting this
yourself is not quite there yet.

[1] https://support.apple.com/en-us/102322
[2] https://support.google.com/a/answer/81126?hl=en#zippy=%2Crequirements-for-all-senders%2Crequirements-for-sending-or-more-messages-per-day
[3] https://www.rfc-editor.org/rfc/rfc7628.html
[4] https://bugzilla.mozilla.org/show_bug.cgi?id=1602166
2025-04-13 22:50:19 +02:00
.hydra Increase the evaluation periodicity from 30s to 5m 2025-02-09 18:14:30 +01:00
docs fts xapian: adapt to newer versions 2025-01-18 12:00:00 +00:00
mail-server mail-server: add dmarcReporting.excludeDomains 2025-04-13 07:08:44 +00:00
nixops add flake support 2020-12-15 16:14:44 +01:00
scripts tests: make the emails sent by mail-check.py look less like spam 2024-11-23 23:51:49 +01:00
tests tests: fix renamed options warnings 2025-01-24 17:40:48 +01:00
.editorconfig Remove makefile section from editorconfig 2017-11-11 09:47:25 +00:00
.gitignore add gitignore file for result links 2017-12-21 11:55:22 +01:00
.gitlab-ci.yml ci: pin nixpkgs to 22.05 2022-11-27 20:43:25 +01:00
.readthedocs.yaml docs: drop options.md from the repository 2022-12-22 20:45:03 +01:00
default.nix mail-server: add dmarcReporting.excludeDomains 2025-04-13 07:08:44 +00:00
flake.lock Release 24.11 2024-12-22 16:20:47 +00:00
flake.nix Release 24.11 2024-12-22 16:20:47 +00:00
LICENSE Initial commit 2016-07-21 18:09:04 +02:00
README.md README: Update existing and future features 2025-04-13 22:50:19 +02:00
shell.nix docs: use MarkDown for option docs 2022-12-22 20:45:01 +01:00
update.sh automatically update readme hash 2019-12-18 09:33:52 +01:00

Simple Nixos MailServer

license pipeline status

Release branches

For each NixOS release, we publish a branch. You then have to use the SNM branch corresponding to your NixOS version.

Subscribe to SNM Announcement List This is a very low volume list where new releases of SNM are announced, so you can stay up to date with bug fixes and updates.

Features

v2.0

  • Continous Integration Testing
  • Multiple Domains
  • Postfix MTA
    • smtp on port 25
    • submission tls on port 465
    • submission starttls on port 587
    • lmtp with dovecot
  • Dovecot
    • maildir folders
    • imap with tls on port 993
    • pop3 with tls on port 995
    • imap with starttls on port 143
    • pop3 with starttls on port 110
  • Certificates
    • manual certificates
    • on the fly creation
    • Let's Encrypt
  • Spam Filtering
    • via rspamd
  • Virus Scanning
    • via clamav
  • DKIM Signing
    • via opendkim
  • User Management
    • declarative user management
    • declarative password management
    • LDAP users
  • Sieves
    • A simple standard script that moves spam
    • Allow user defined sieve scripts
    • ManageSieve support
  • User Aliases
    • Regular aliases
    • Catch all aliases

In the future

  • DKIM Signing
    • Allow per domain selectors
    • Allow passing DKIM signing keys
  • Improve the Forwarding Experience
  • User management
    • Allow local and LDAP user to coexist
  • OpenID Connect
    • Depends on relevant clients adding support, e.g. Thunderbird

Get in touch

  • Subscribe to the mailing list
  • Join the Libera Chat IRC channel #nixos-mailserver

How to Set Up a 10/10 Mail Server Guide

Check out the Setup Guide in the project's documentation.

For a complete list of options, see in readthedocs.

Development

See the How to Develop SNM documentation page.

Contributors

See the contributor tab

Alternative Implementations

Credits