A complete and Simple Nixos Mailserver
Go to file
2020-07-06 22:33:19 +02:00
.hydra ci: add 20.03 jobset 2020-05-24 20:41:03 +02:00
docs docs: how to contribute to documentation 2020-07-06 22:33:19 +02:00
logo add logo 2017-09-13 14:03:04 +02:00
mail-server Fix passwfile update 2020-06-19 16:02:21 +02:00
nix Remove 19.09 support 2020-05-11 21:46:01 +00:00
nixops fix nixops file 2019-05-03 13:11:47 +02:00
tests Remove 19.09 support 2020-05-11 21:46:01 +00: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: better error message 2020-04-23 00:23:17 +02:00
default.nix Fix spelling of lmtp in option 2020-05-25 18:19:32 -04:00
LICENSE Initial commit 2016-07-21 18:09:04 +02:00
README.md Fixed url to contributor tab 2020-05-26 21:00:37 +02:00
shell.nix docs: create a readthedocs manual 2020-07-06 19:48:51 +00: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. 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 port 587
    • lmtp with dovecot
  • Dovecot
    • maildir folders
    • imap starttls on port 143
    • pop3 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

Changelog and How to Stay Up-to-Date

See the mailing list archive

Quick Start

{ config, pkgs, ... }:
{
  imports = [
    (builtins.fetchTarball {
      # Pick a commit from the branch you are interested in
      url = "https://gitlab.com/simple-nixos-mailserver/nixos-mailserver/-/archive/A-COMMIT-ID/nixos-mailserver-A-COMMIT-ID.tar.gz";
      # And set its hash
      sha256 = "0000000000000000000000000000000000000000000000000000";
    })
  ];

  mailserver = {
    enable = true;
    fqdn = "mail.example.com";
    domains = [ "example.com" "example2.com" ];
    loginAccounts = {
        "user1@example.com" = {
            hashedPassword = "$6$/z4n8AQl6K$kiOkBTWlZfBd7PvF5GsJ8PmPgdZsFGN1jPGZufxxr60PoR0oUsrvzm2oQiflyz5ir9fFJ.d/zKm/NgLXNUsNX/";

            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 wiki.

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

Credits