nixos-mailserver/README.md

Release branches

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

• For NixOS 21.05
  • Use the SNM branch nixos-21.05
  • Documentation
  • Release notes
• For NixOS 20.09
  • Use the SNM branch nixos-20.09
  • Documentation
  • Release notes
• For NixOS unstable
  • Use the SNM branch master
  • Documentation
  • This branch is currently supporting the NixOS release 21.05 but we could remove this support on any NixOS unstable breaking change.

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. All announcements are signed by the gpg key with fingerprint

D9FE 4119 F082 6F15 93BD  BD36 6162 DBA5 635E A16A

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
• 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 a per domain selector

Get in touch

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

Quick Start

   { config, pkgs, ... }:
   let release = "nixos-21.05";
   in {
     imports = [
       (builtins.fetchTarball {
         url = "https://gitlab.com/simple-nixos-mailserver/nixos-mailserver/-/archive/${release}/nixos-mailserver-${release}.tar.gz";
         # This hash needs to be updated
         sha256 = "0000000000000000000000000000000000000000000000000000";
       })
     ];

     mailserver = {
       enable = true;
       fqdn = "mail.example.com";
       domains = [ "example.com" "example2.com" ];
       loginAccounts = {
           "user1@example.com" = {
               # nix run nixpkgs.apacheHttpd -c htpasswd -nbB "" "super secret password" | cut -d: -f2 > /hashed/password/file/location
               hashedPasswordFile = "/hashed/password/file/location";

               aliases = [
                   "info@example.com"
                   "postmaster@example.com"
                   "postmaster@example2.com"
               ];
           };
       };
     };
   }

For a complete list of options, see default.nix.

How to Set Up a 10/10 Mail Server Guide

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

How to Backup

Checkout the Complete Backup Guide. Backups are easy with SNM.

Development

See the How to Develop SNM wiki page.

Release notes

nixos-20.03

• Rspamd is upgraded to 2.0 which deprecates the SQLite Bayes backend. We then moved to the Redis backend (the default since Rspamd 2.0). If you don't want to relearn the Redis backend from the scratch, we could manually run

  rspamadm statconvert --spam-db /var/lib/rspamd/bayes.spam.sqlite --ham-db /var/lib/rspamd/bayes.ham.sqlite -h 127.0.0.1:6379 --symbol-ham BAYES_HAM --symbol-spam BAYES_SPAM
  

  See the Rspamd migration notes and this SNM Merge Request for details.

Contributors

See the contributor tab

Alternative Implementations

• NixCloud Webservices

Credits

• send mail graphic by tnp_dreamingmao from TheNounProject is licensed under CC BY 3.0
• Logo made with Logomakr.com