You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Niklas Hambüchen eba19686fb setup-guide: Improve commands/outputs 4 months ago
.hydra ci: add 20.03 jobset 9 months ago
docs setup-guide: Improve commands/outputs 4 months ago
logo add logo 3 years ago
mail-server test.dovecot: ensure port 143 is closed when enableImap is not set 4 months ago
nix remove support for 20.03 4 months ago
nixops fix nixops file 1 year ago
scripts Add multiple.nix test 5 months ago
tests test.dovecot: ensure port 143 is closed when enableImap is not set 4 months ago
.editorconfig Remove makefile section from editorconfig 3 years ago
.gitignore add gitignore file for result links 3 years ago
.gitlab-ci.yml ci: better error message 10 months ago
LICENSE Initial commit 4 years ago
README.md add release notes for tls wrapped-mode changes 4 months ago
default.nix add full support for tls wrapped mode 4 months ago
shell.nix docs: create a readthedocs manual 7 months ago
update.sh automatically update readme hash 1 year ago

README.md

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

  • Postfix MTA
  • Dovecot
  • Certificates
  • Spam Filtering
  • Virus Scanning
  • DKIM Signing
  • User Management
  • Sieves
  • User Aliases

In the future

  • DKIM Signing

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

master / unreleased

  • NixOS 20.03 is not supported anymore. Please use NixOS 20.09 or NixOS Unstable or downgrade to the latest SNM release.
  • IMAP and Submission with TLS wrapped-mode are now enabled by default on ports 993 and 465 respectively.

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