mirror of
https://github.com/NixOS/nixpkgs.git
synced 2024-11-29 17:10:48 +00:00
3a2790c342
Prior to this fix, changes to certain settings would not be applied automatically and users would have to know to manually restart the affected service. A prime example of this is `services.mailman.hyperkitty.baseUrl`, or various things that affect `mailman3/settings.py`
395 lines
13 KiB
Nix
395 lines
13 KiB
Nix
{ config, pkgs, lib, ... }: # mailman.nix
|
|
|
|
with lib;
|
|
|
|
let
|
|
|
|
cfg = config.services.mailman;
|
|
|
|
# This deliberately doesn't use recursiveUpdate so users can
|
|
# override the defaults.
|
|
settings = {
|
|
DEFAULT_FROM_EMAIL = cfg.siteOwner;
|
|
SERVER_EMAIL = cfg.siteOwner;
|
|
ALLOWED_HOSTS = [ "localhost" "127.0.0.1" ] ++ cfg.webHosts;
|
|
COMPRESS_OFFLINE = true;
|
|
STATIC_ROOT = "/var/lib/mailman-web/static";
|
|
MEDIA_ROOT = "/var/lib/mailman-web/media";
|
|
} // cfg.webSettings;
|
|
|
|
settingsJSON = pkgs.writeText "settings.json" (builtins.toJSON settings);
|
|
|
|
mailmanCfg = ''
|
|
[mailman]
|
|
site_owner: ${cfg.siteOwner}
|
|
layout: fhs
|
|
|
|
[paths.fhs]
|
|
bin_dir: ${pkgs.python3Packages.mailman}/bin
|
|
var_dir: /var/lib/mailman
|
|
queue_dir: $var_dir/queue
|
|
template_dir: $var_dir/templates
|
|
log_dir: $var_dir/log
|
|
lock_dir: $var_dir/lock
|
|
etc_dir: /etc
|
|
ext_dir: $etc_dir/mailman.d
|
|
pid_file: /run/mailman/master.pid
|
|
'' + optionalString cfg.hyperkitty.enable ''
|
|
|
|
[archiver.hyperkitty]
|
|
class: mailman_hyperkitty.Archiver
|
|
enable: yes
|
|
configuration: /var/lib/mailman/mailman-hyperkitty.cfg
|
|
'';
|
|
|
|
mailmanHyperkittyCfg = pkgs.writeText "mailman-hyperkitty.cfg" ''
|
|
[general]
|
|
# This is your HyperKitty installation, preferably on the localhost. This
|
|
# address will be used by Mailman to forward incoming emails to HyperKitty
|
|
# for archiving. It does not need to be publicly available, in fact it's
|
|
# better if it is not.
|
|
base_url: ${cfg.hyperkitty.baseUrl}
|
|
|
|
# Shared API key, must be the identical to the value in HyperKitty's
|
|
# settings.
|
|
api_key: @API_KEY@
|
|
'';
|
|
|
|
in {
|
|
|
|
###### interface
|
|
|
|
imports = [
|
|
(mkRenamedOptionModule [ "services" "mailman" "hyperkittyBaseUrl" ]
|
|
[ "services" "mailman" "hyperkitty" "baseUrl" ])
|
|
|
|
(mkRemovedOptionModule [ "services" "mailman" "hyperkittyApiKey" ] ''
|
|
The Hyperkitty API key is now generated on first run, and not
|
|
stored in the world-readable Nix store. To continue using
|
|
Hyperkitty, you must set services.mailman.hyperkitty.enable = true.
|
|
'')
|
|
];
|
|
|
|
options = {
|
|
|
|
services.mailman = {
|
|
|
|
enable = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = "Enable Mailman on this host. Requires an active Postfix installation.";
|
|
};
|
|
|
|
package = mkOption {
|
|
type = types.package;
|
|
default = pkgs.mailman;
|
|
defaultText = "pkgs.mailman";
|
|
example = "pkgs.mailman.override { archivers = []; }";
|
|
description = "Mailman package to use";
|
|
};
|
|
|
|
siteOwner = mkOption {
|
|
type = types.str;
|
|
example = "postmaster@example.org";
|
|
description = ''
|
|
Certain messages that must be delivered to a human, but which can't
|
|
be delivered to a list owner (e.g. a bounce from a list owner), will
|
|
be sent to this address. It should point to a human.
|
|
'';
|
|
};
|
|
|
|
webRoot = mkOption {
|
|
type = types.path;
|
|
default = "${pkgs.mailman-web}/${pkgs.python3.sitePackages}";
|
|
defaultText = "\${pkgs.mailman-web}/\${pkgs.python3.sitePackages}";
|
|
description = ''
|
|
The web root for the Hyperkity + Postorius apps provided by Mailman.
|
|
This variable can be set, of course, but it mainly exists so that site
|
|
admins can refer to it in their own hand-written web server
|
|
configuration files.
|
|
'';
|
|
};
|
|
|
|
webHosts = mkOption {
|
|
type = types.listOf types.str;
|
|
default = [];
|
|
description = ''
|
|
The list of hostnames and/or IP addresses from which the Mailman Web
|
|
UI will accept requests. By default, "localhost" and "127.0.0.1" are
|
|
enabled. All additional names under which your web server accepts
|
|
requests for the UI must be listed here or incoming requests will be
|
|
rejected.
|
|
'';
|
|
};
|
|
|
|
webUser = mkOption {
|
|
type = types.str;
|
|
default = config.services.httpd.user;
|
|
description = ''
|
|
User to run mailman-web as
|
|
'';
|
|
};
|
|
|
|
webSettings = mkOption {
|
|
type = types.attrs;
|
|
default = {};
|
|
description = ''
|
|
Overrides for the default mailman-web Django settings.
|
|
'';
|
|
};
|
|
|
|
hyperkitty = {
|
|
enable = mkEnableOption "the Hyperkitty archiver for Mailman";
|
|
|
|
baseUrl = mkOption {
|
|
type = types.str;
|
|
default = "http://localhost/hyperkitty/";
|
|
description = ''
|
|
Where can Mailman connect to Hyperkitty's internal API, preferably on
|
|
localhost?
|
|
'';
|
|
};
|
|
};
|
|
|
|
};
|
|
};
|
|
|
|
###### implementation
|
|
|
|
config = mkIf cfg.enable {
|
|
|
|
assertions = let
|
|
inherit (config.services) postfix;
|
|
|
|
requirePostfixHash = optionPath: dataFile:
|
|
with lib;
|
|
let
|
|
expected = "hash:/var/lib/mailman/data/${dataFile}";
|
|
value = attrByPath optionPath [] postfix;
|
|
in
|
|
{ assertion = postfix.enable -> isList value && elem expected value;
|
|
message = ''
|
|
services.postfix.${concatStringsSep "." optionPath} must contain
|
|
"${expected}".
|
|
See <https://mailman.readthedocs.io/en/latest/src/mailman/docs/mta.html>.
|
|
'';
|
|
};
|
|
in [
|
|
{ assertion = postfix.enable;
|
|
message = "Mailman requires Postfix";
|
|
}
|
|
(requirePostfixHash [ "relayDomains" ] "postfix_domains")
|
|
(requirePostfixHash [ "config" "transport_maps" ] "postfix_lmtp")
|
|
(requirePostfixHash [ "config" "local_recipient_maps" ] "postfix_lmtp")
|
|
];
|
|
|
|
users.users.mailman = { description = "GNU Mailman"; isSystemUser = true; };
|
|
|
|
environment.etc."mailman.cfg".text = mailmanCfg;
|
|
|
|
environment.etc."mailman3/settings.py".text = ''
|
|
import os
|
|
|
|
# Required by mailman_web.settings, but will be overridden when
|
|
# settings_local.json is loaded.
|
|
os.environ["SECRET_KEY"] = ""
|
|
|
|
from mailman_web.settings import *
|
|
|
|
import json
|
|
|
|
with open('${settingsJSON}') as f:
|
|
globals().update(json.load(f))
|
|
|
|
with open('/var/lib/mailman-web/settings_local.json') as f:
|
|
globals().update(json.load(f))
|
|
'';
|
|
|
|
environment.systemPackages = [ cfg.package ] ++ (with pkgs; [ mailman-web ]);
|
|
|
|
services.postfix = {
|
|
recipientDelimiter = "+"; # bake recipient addresses in mail envelopes via VERP
|
|
config = {
|
|
owner_request_special = "no"; # Mailman handles -owner addresses on its own
|
|
};
|
|
};
|
|
|
|
systemd.services.mailman = {
|
|
description = "GNU Mailman Master Process";
|
|
after = [ "network.target" ];
|
|
restartTriggers = [ config.environment.etc."mailman.cfg".source ];
|
|
wantedBy = [ "multi-user.target" ];
|
|
serviceConfig = {
|
|
ExecStart = "${cfg.package}/bin/mailman start";
|
|
ExecStop = "${cfg.package}/bin/mailman stop";
|
|
User = "mailman";
|
|
Type = "forking";
|
|
RuntimeDirectory = "mailman";
|
|
PIDFile = "/run/mailman/master.pid";
|
|
};
|
|
};
|
|
|
|
systemd.services.mailman-settings = {
|
|
description = "Generate settings files (including secrets) for Mailman";
|
|
before = [ "mailman.service" "mailman-web.service" "hyperkitty.service" "httpd.service" "uwsgi.service" ];
|
|
requiredBy = [ "mailman.service" "mailman-web.service" "hyperkitty.service" "httpd.service" "uwsgi.service" ];
|
|
path = with pkgs; [ jq ];
|
|
script = ''
|
|
mailmanDir=/var/lib/mailman
|
|
mailmanWebDir=/var/lib/mailman-web
|
|
|
|
mailmanCfg=$mailmanDir/mailman-hyperkitty.cfg
|
|
mailmanWebCfg=$mailmanWebDir/settings_local.json
|
|
|
|
install -m 0700 -o mailman -g nogroup -d $mailmanDir
|
|
install -m 0700 -o ${cfg.webUser} -g nogroup -d $mailmanWebDir
|
|
|
|
if [ ! -e $mailmanWebCfg ]; then
|
|
hyperkittyApiKey=$(tr -dc A-Za-z0-9 < /dev/urandom | head -c 64)
|
|
secretKey=$(tr -dc A-Za-z0-9 < /dev/urandom | head -c 64)
|
|
|
|
mailmanWebCfgTmp=$(mktemp)
|
|
jq -n '.MAILMAN_ARCHIVER_KEY=$archiver_key | .SECRET_KEY=$secret_key' \
|
|
--arg archiver_key "$hyperkittyApiKey" \
|
|
--arg secret_key "$secretKey" \
|
|
>"$mailmanWebCfgTmp"
|
|
chown ${cfg.webUser} "$mailmanWebCfgTmp"
|
|
mv -n "$mailmanWebCfgTmp" $mailmanWebCfg
|
|
fi
|
|
|
|
hyperkittyApiKey="$(jq -r .MAILMAN_ARCHIVER_KEY $mailmanWebCfg)"
|
|
mailmanCfgTmp=$(mktemp)
|
|
sed "s/@API_KEY@/$hyperkittyApiKey/g" ${mailmanHyperkittyCfg} >"$mailmanCfgTmp"
|
|
chown mailman "$mailmanCfgTmp"
|
|
mv "$mailmanCfgTmp" $mailmanCfg
|
|
'';
|
|
serviceConfig = {
|
|
Type = "oneshot";
|
|
# RemainAfterExit makes restartIfChanged work for this service, so
|
|
# downstream services will get updated automatically when things like
|
|
# services.mailman.hyperkitty.baseUrl change. Otherwise users have to
|
|
# restart things manually, which is confusing.
|
|
RemainAfterExit = "yes";
|
|
};
|
|
};
|
|
|
|
systemd.services.mailman-web = {
|
|
description = "Init Postorius DB";
|
|
before = [ "httpd.service" "uwsgi.service" ];
|
|
requiredBy = [ "httpd.service" "uwsgi.service" ];
|
|
restartTriggers = [ config.environment.etc."mailman3/settings.py".source ];
|
|
script = ''
|
|
${pkgs.mailman-web}/bin/mailman-web migrate
|
|
rm -rf static
|
|
${pkgs.mailman-web}/bin/mailman-web collectstatic
|
|
${pkgs.mailman-web}/bin/mailman-web compress
|
|
'';
|
|
serviceConfig = {
|
|
User = cfg.webUser;
|
|
Type = "oneshot";
|
|
# Similar to mailman-settings.service, this makes restartTriggers work
|
|
# properly for this service.
|
|
RemainAfterExit = "yes";
|
|
WorkingDirectory = "/var/lib/mailman-web";
|
|
};
|
|
};
|
|
|
|
systemd.services.mailman-daily = {
|
|
description = "Trigger daily Mailman events";
|
|
startAt = "daily";
|
|
restartTriggers = [ config.environment.etc."mailman.cfg".source ];
|
|
serviceConfig = {
|
|
ExecStart = "${cfg.package}/bin/mailman digests --send";
|
|
User = "mailman";
|
|
};
|
|
};
|
|
|
|
systemd.services.hyperkitty = {
|
|
inherit (cfg.hyperkitty) enable;
|
|
description = "GNU Hyperkitty QCluster Process";
|
|
after = [ "network.target" ];
|
|
restartTriggers = [ config.environment.etc."mailman3/settings.py".source ];
|
|
wantedBy = [ "mailman.service" "multi-user.target" ];
|
|
serviceConfig = {
|
|
ExecStart = "${pkgs.mailman-web}/bin/mailman-web qcluster";
|
|
User = cfg.webUser;
|
|
WorkingDirectory = "/var/lib/mailman-web";
|
|
};
|
|
};
|
|
|
|
systemd.services.hyperkitty-minutely = {
|
|
inherit (cfg.hyperkitty) enable;
|
|
description = "Trigger minutely Hyperkitty events";
|
|
startAt = "minutely";
|
|
restartTriggers = [ config.environment.etc."mailman3/settings.py".source ];
|
|
serviceConfig = {
|
|
ExecStart = "${pkgs.mailman-web}/bin/mailman-web runjobs minutely";
|
|
User = cfg.webUser;
|
|
WorkingDirectory = "/var/lib/mailman-web";
|
|
};
|
|
};
|
|
|
|
systemd.services.hyperkitty-quarter-hourly = {
|
|
inherit (cfg.hyperkitty) enable;
|
|
description = "Trigger quarter-hourly Hyperkitty events";
|
|
startAt = "*:00/15";
|
|
restartTriggers = [ config.environment.etc."mailman3/settings.py".source ];
|
|
serviceConfig = {
|
|
ExecStart = "${pkgs.mailman-web}/bin/mailman-web runjobs quarter_hourly";
|
|
User = cfg.webUser;
|
|
WorkingDirectory = "/var/lib/mailman-web";
|
|
};
|
|
};
|
|
|
|
systemd.services.hyperkitty-hourly = {
|
|
inherit (cfg.hyperkitty) enable;
|
|
description = "Trigger hourly Hyperkitty events";
|
|
startAt = "hourly";
|
|
restartTriggers = [ config.environment.etc."mailman3/settings.py".source ];
|
|
serviceConfig = {
|
|
ExecStart = "${pkgs.mailman-web}/bin/mailman-web runjobs hourly";
|
|
User = cfg.webUser;
|
|
WorkingDirectory = "/var/lib/mailman-web";
|
|
};
|
|
};
|
|
|
|
systemd.services.hyperkitty-daily = {
|
|
inherit (cfg.hyperkitty) enable;
|
|
description = "Trigger daily Hyperkitty events";
|
|
startAt = "daily";
|
|
restartTriggers = [ config.environment.etc."mailman3/settings.py".source ];
|
|
serviceConfig = {
|
|
ExecStart = "${pkgs.mailman-web}/bin/mailman-web runjobs daily";
|
|
User = cfg.webUser;
|
|
WorkingDirectory = "/var/lib/mailman-web";
|
|
};
|
|
};
|
|
|
|
systemd.services.hyperkitty-weekly = {
|
|
inherit (cfg.hyperkitty) enable;
|
|
description = "Trigger weekly Hyperkitty events";
|
|
startAt = "weekly";
|
|
restartTriggers = [ config.environment.etc."mailman3/settings.py".source ];
|
|
serviceConfig = {
|
|
ExecStart = "${pkgs.mailman-web}/bin/mailman-web runjobs weekly";
|
|
User = cfg.webUser;
|
|
WorkingDirectory = "/var/lib/mailman-web";
|
|
};
|
|
};
|
|
|
|
systemd.services.hyperkitty-yearly = {
|
|
inherit (cfg.hyperkitty) enable;
|
|
description = "Trigger yearly Hyperkitty events";
|
|
startAt = "yearly";
|
|
restartTriggers = [ config.environment.etc."mailman3/settings.py".source ];
|
|
serviceConfig = {
|
|
ExecStart = "${pkgs.mailman-web}/bin/mailman-web runjobs yearly";
|
|
User = cfg.webUser;
|
|
WorkingDirectory = "/var/lib/mailman-web";
|
|
};
|
|
};
|
|
|
|
};
|
|
|
|
}
|