Go to file
Robin Raymond 5d1f5cb349 update readme for v2.3.0 2019-12-16 21:08:33 +01:00
logo add logo 2017-09-13 14:03:04 +02:00
mail-server Trigger restart of postfix if passwords of mail accounts change 2019-10-18 21:21:01 +02:00
nixops fix nixops file 2019-05-03 13:11:47 +02:00
tests Update clamav test fixtures 2019-12-15 11:53:27 +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 Retry tests twice on gitlab 2019-12-15 14:29:16 +01:00
LICENSE Initial commit 2016-07-21 18:09:04 +02:00
README.md update readme for v2.3.0 2019-12-16 21:08:33 +01:00
default.nix Remove use of the deprecated string type 2019-09-22 13:32:37 +00:00
shell.nix ci: store Clamav DB in LFS 2018-08-18 15:13:25 +09:30
update.sh Restore tests and script deleted in b8661825 2019-12-14 22:22:10 +01:00

README.md

Simple Nixos MailServer

license pipeline status

Stable Releases

Latest Release (Candidate)

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 {
      url = "https://gitlab.com/simple-nixos-mailserver/nixos-mailserver/-/archive/v2.3.0/nixos-mailserver-v2.3.0.tar.gz";
      sha256 = "03d49v8qnid9g9rha0wg2z6vic06mhp0b049s3whccn1axvs2zzx";
    })
  ];

  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.

Contributors

See the contributor tab

Alternative Implementations

Credits