Add Mox Project

- Expose Mox as a service

Author: themadbit

projects/Mox/default.nix

@@ -0,0 +1,39 @@
+{
+  lib,
+  pkgs,
+  sources,
+}@args:
+{
+  metadata = {
+    summary = ''
+    Mox is a modern, secure, and open-source email server that implements all modern email protocols.
+    It makes it easy for people and organizations to run their own email server in minutes using mox quickstart.
+    '';
+    subgrants = [
+      "Mox"
+    ];
+  };
+
+  # Mox Service
+  nixos.modules.services = {
+    mox = {
+      name = "mox";
+      module = ./module.nix;
+      examples.mox = {
+        module = ./example.nix;
+        description = "";
+        tests.basic = import ./test.nix args;
+      };
+      links = {
+        install = {
+          text = "Mox Install Documentation";
+          url = "https://www.xmox.nl/install/";
+        };
+        repository = {
+          text = "Mox Github Repository";
+          url = "https://github.com/mjl-/mox";
+        };
+      };
+    };
+  };
+}

projects/Mox/example.nix

@@ -0,0 +1,6 @@
+{ ... }:
+{
+  services.mox.enable = true;
+  services.mox.hostname = "mail";
+  services.mox.user = "[email protected]";
+}

projects/Mox/module.nix

@@ -0,0 +1,75 @@
+{
+  config,
+  lib,
+  pkgs,
+  ...
+}:
+
+{
+  options = {
+    services.mox = {
+      enable = lib.mkEnableOption "Enable Mox Mail Server";
+      configFile = lib.mkOption {
+        type = lib.types.str;
+        default = "/var/lib/mox/config/mox.conf";
+        description = "Path to the Mox configuration file";
+      };
+      hostname = lib.mkOption {
+        type = lib.types.str;
+        default = "mail";
+        description = "Hostname for the Mox Mail Server";
+      };
+      user = lib.mkOption {
+        type = lib.types.str;
+        description = "*Required* Email user as (user@domain) to be created.";
+      };
+    };
+  };
+
+  config = lib.mkIf config.services.mox.enable {
+    # Ensure neccesary packages are installed
+    environment.systemPackages = with pkgs; [
+      mox
+    ];
+
+    # Create a dedicated user/group for Mox
+    users.users.mox = {
+      isSystemUser = true;
+      name = "mox";
+      group = "mox";
+      home = "/var/lib/mox";
+      createHome = true;
+      description = "Mox Mail Server User";
+    };
+    users.groups.mox = {
+      name = "mox";
+    };
+
+    systemd.services.mox-setup = {
+      description = "Setup Mox Mail Server";
+      wantedBy = [ "multi-user.target" ];
+      before = [ "mox.service" ];
+      serviceConfig = {
+        Type = "oneshot";
+        RemainAfterExit = true;
+      };
+      script = ''
+        mkdir -p /var/lib/mox
+        cd /var/lib/mox
+        ${pkgs.mox}/bin/mox quickstart -hostname ${config.services.mox.hostname} ${config.services.mox.user}
+        chown -R mox:mox /var/lib/mox
+      '';
+    };
+
+    systemd.services.mox = {
+      wantedBy = [ "multi-user.target" ];
+      after = [ "network.target" "mox-setup.service" ];
+      requires = [ "mox-setup.service" ]; # This ensures mox-setup must succeed
+      serviceConfig = {
+        WorkingDirectory = "/var/lib/mox";
+        ExecStart = "${pkgs.mox}/bin/mox -config /var/lib/mox/config/mox.conf serve";
+        Restart = "always";
+      };
+    };
+  };
+}

projects/Mox/test.nix

@@ -0,0 +1,60 @@
+{
+  sources,
+  pkgs,
+  ...
+}:
+{
+  name = "mox";
+
+  nodes = {
+    machine =
+      { ... }:
+      {
+        imports = [
+          sources.modules.ngipkgs
+          # Sources module path depends on your folder structure
+          ./module.nix
+        ];
+
+        # Configure the mox service
+        services.mox = {
+          enable = true;
+          hostname = "mail.example.com";
+          user = "[email protected]";
+        };
+
+        # Allow necessary ports through the firewall
+        networking.firewall.allowedTCPPorts = [ 25 143 587 993 ];
+      };
+  };
+
+  testScript =
+    { nodes, ... }:
+    ''
+      start_all()
+
+      # Wait for machine to be available
+      machine.wait_for_unit("multi-user.target")
+
+      # Verify the mox-setup service has run successfully
+      # machine.wait_for_unit("mox-setup.service")
+      
+      # Verify the mox service is running
+      machine.wait_for_unit("mox.service")
+      
+      # Verify config file exists
+      machine.succeed("test -f /var/lib/mox/config/mox.conf")
+      
+      # Verify mox user was created
+      machine.succeed("getent passwd mox")
+      
+      # Check if ports are listening (assuming default SMTP port)
+      machine.wait_until_succeeds("ss -tln | grep ':25 '")
+      
+      # Test running the mox command
+      machine.succeed("mox version")
+      
+      # Check logs for any errors
+      machine.succeed("journalctl -u mox.service --no-pager | grep -v 'error|failed'")
+    '';
+}