Commit 75742d26 authored by Axel Karjalainen's avatar Axel Karjalainen
Browse files

nixos/stalwart: add module-specific `stateVersion` and clean up

parent 1becf8c7

nixos/doc/manual/release-notes/rl-2605.section.md

+4 −0
Original line number Diff line number Diff line
@@ -162,6 +162,10 @@ of pulling the upstream container image from Docker Hub. If you want the old beh 


- `services.stalwart-mail` has been renamed to `services.stalwart` to align with upstream re-brand as an e-mail and collaboration server. Other notable breaking changes to module:



  - Addition of module-specific `stateVersion` option, which on existing installations of Stalwart must be set to the same as `system.stateVersion`.



    This enables manually and carefully migrating Stalwart to a new `stateVersion` or newly enabling the Stalwart module with a newer `stateVersion` than `system.stateVersion`.



  - `systemd.services.stalwart` owned by `stalwart:stalwart`. The `user` and `group` are configurable via `services.stalwart.user` and `services.stalwart.group`, respectively. By default, if `stateVersion` is older than `26.05`, will fallback to legacy value of `stalwart-mail` for both `user` and `group`.

  - Default value for `services.stalwart.dataDir` has changed to `/var/lib/stalwart`. If `stateVersion` is older than `26.05`, will fallback to legacy value of `/var/lib/stalwart-mail`.

nixos/modules/services/mail/stalwart.nix

+21 −12
Original line number Diff line number Diff line
@@ -8,9 +8,9 @@ let 
  cfg = config.services.stalwart;

  configFormat = pkgs.formats.toml { };

  configFile = configFormat.generate "stalwart.toml" cfg.settings;

  useLegacyStorage = lib.versionOlder config.system.stateVersion "24.11";

  useLegacyDefault = lib.versionOlder config.system.stateVersion "26.05";

  default = if useLegacyDefault then "stalwart-mail" else "stalwart";

  useLegacyStorage = lib.versionOlder cfg.stateVersion "24.11";

  useLegacyIdentifier = lib.versionOlder cfg.stateVersion "26.05";

  stalwartIdentifier = if useLegacyIdentifier then "stalwart-mail" else "stalwart";



  parsePorts =

    listeners:
@@ -31,6 +31,15 @@ in 
  options.services.stalwart = {

    enable = lib.mkEnableOption "the all-in-one collaboration and mail server, Stalwart";



    stateVersion = lib.mkOption {

      type = lib.types.str;

      description = ''

        The version of this module (=version of NixOS) when this module was first enabled on this particular machine, used to maintain compatibility with application data created on older versions of this module.



        See {option}`system.stateVersion` for details on the NixOS-global equivalent to this option.

      '';

    };



    package = lib.mkPackageOption pkgs "stalwart" { };



    openFirewall = lib.mkOption {
@@ -55,7 +64,7 @@ in 


    dataDir = lib.mkOption {

      type = lib.types.path;

      default = if useLegacyDefault then "/var/lib/stalwart-mail" else "/var/lib/stalwart";

      default = "/var/lib/${stalwartIdentifier}";

      description = ''

        Data directory for stalwart

      '';
@@ -63,7 +72,7 @@ in 


    user = lib.mkOption {

      type = lib.types.str;

      inherit default;

      default = stalwartIdentifier;

      description = ''

        User ownership of service

      '';
@@ -71,7 +80,7 @@ in 


    group = lib.mkOption {

      type = lib.types.str;

      inherit default;

      default = stalwartIdentifier;

      description = ''

        Group ownership of service

      '';
@@ -155,7 +164,7 @@ in 
          );

        in

        {

          path = "/var/cache/${default}";

          path = "/var/cache/${stalwartIdentifier}";

          resource = lib.mkIf hasHttpListener (lib.mkDefault "file://${cfg.package.webadmin}/webadmin.zip");

        };

    };
@@ -165,10 +174,10 @@ in 
    # service is restarted on a potentially large number of files.

    # That would cause unnecessary and unwanted delays.

    users = {

      groups = lib.mkIf (cfg.group == default) {

      groups = lib.mkIf (cfg.group == stalwartIdentifier) {

        ${cfg.group} = { };

      };

      users = lib.mkIf (cfg.user == default) {

      users = lib.mkIf (cfg.user == stalwartIdentifier) {

        ${cfg.user} = {

          isSystemUser = true;

          inherit (cfg) group;
@@ -197,7 +206,7 @@ in 
          KillSignal = "SIGINT";

          Restart = "on-failure";

          RestartSec = 5;

          SyslogIdentifier = default;

          SyslogIdentifier = stalwartIdentifier;



          ExecStartPre =

            if useLegacyStorage then
@@ -217,8 +226,8 @@ in 
          ReadWritePaths = [

            cfg.dataDir

          ];

          CacheDirectory = default;

          StateDirectory = default;

          CacheDirectory = stalwartIdentifier;

          StateDirectory = stalwartIdentifier;



          # Upstream uses "stalwart" as the username since 0.12.0

          User = cfg.user;

nixos/tests/stalwart/stalwart-config.nix

+4 −1
Original line number Diff line number Diff line 
{ pkgs, lib, ... }:

{ lib, ... }:



let

  certs = import ../common/acme/server/snakeoil-certs.nix;
@@ -9,6 +9,9 @@ in 


  services.stalwart = {

    enable = true;



    stateVersion = lib.trivial.release; # Only for the test; please don't do in production



    settings = {

      server.hostname = domain;