{
config,
pkgs,
lib,
...
}:
with lib; let
dataDir = "/var/lib/mautrix-signal";
registrationFile = "${dataDir}/signal-registration.yaml";
cfg = config.services.mautrix-signal;
settingsFormat = pkgs.formats.yaml {};
settingsFileUnsubstituted = settingsFormat.generate "mautrix-telegram-signal-unsubstituted.yaml" cfg.settings;
settingsFile = "${dataDir}/config.yaml";
in {
options = {
services.mautrix-signal = {
enable = mkEnableOption "Mautrix-signal, a Matrix-signal hybrid puppeting/relaybot bridge";
settings = mkOption rec {
apply = recursiveUpdate default;
inherit (settingsFormat) type;
default = {
appservice = {
address = "http://localhost:29328";
hostname = "0.0.0.0";
port = 29328;
database = "sqlite:///${dataDir}/mautrix-signal.db";
as_token = "$AS_TOKEN";
hs_token = "$HS_TOKEN";
};
logging = {
version = 1;
formatters.precise.format = "[%(levelname)s@%(name)s] %(message)s";
handlers.console = {
class = "logging.StreamHandler";
formatter = "precise";
};
loggers = {
mau.level = "INFO";
telethon.level = "INFO";
# prevent tokens from leaking in the logs:
# https://github.com/tulir/mautrix-telegram/issues/351
aiohttp.level = "WARNING";
};
# log to console/systemd instead of file
root = {
level = "INFO";
handlers = ["console"];
};
};
};
};
environmentFile = mkOption {
type = types.nullOr types.path;
default = null;
description = ''
File containing environment variables to be passed to the mautrix-telegram service,
in which secret tokens can be specified securely by defining values for
MAUTRIX_TELEGRAM_APPSERVICE_AS_TOKEN,
MAUTRIX_TELEGRAM_APPSERVICE_HS_TOKEN,
MAUTRIX_TELEGRAM_TELEGRAM_API_ID,
MAUTRIX_TELEGRAM_TELEGRAM_API_HASH and optionally
MAUTRIX_TELEGRAM_TELEGRAM_BOT_TOKEN.
'';
};
};
};
config = mkIf cfg.enable {
systemd.services.mautrix-signal-genregistration = {
description = "Mautrix-signal Registration";
requiredBy = ["matrix-synapse.service"];
before = ["matrix-synapse.service"];
script = ''
# Not all secrets can be passed as environment variable (yet)
# https://github.com/tulir/mautrix-telegram/issues/584
[ -f ${settingsFile} ] && rm -f ${settingsFile}
old_umask=$(umask)
umask 0177
export AS_TOKEN="This value is generated when generating the registration"
export HS_TOKEN="This value is generated when generating the registration"
${pkgs.envsubst}/bin/envsubst \
-o ${settingsFile} \
-i ${settingsFileUnsubstituted}
umask $old_umask
[ -f ${registrationFile} ] && rm -f ${registrationFile}
${pkgs.mautrix-signal}/bin/mautrix-signal --generate-registration --config ${settingsFile} --registration ${registrationFile}
chmod 660 ${registrationFile}
# Extract the tokens from the registration
export AS_TOKEN=$(${pkgs.yq}/bin/yq -r '.as_token' ${registrationFile})
export HS_TOKEN=$(${pkgs.yq}/bin/yq -r '.hs_token' ${registrationFile})
umask 0177
${pkgs.envsubst}/bin/envsubst \
-o ${settingsFile} \
-i ${settingsFileUnsubstituted}
umask $old_umask
'';
serviceConfig = {
Type = "oneshot";
RemainAfterExit = true;
ProtectSystem = "strict";
ProtectHome = true;
ProtectKernelTunables = true;
ProtectKernelModules = true;
ProtectControlGroups = true;
WorkingDirectory = dataDir;
StateDirectory = baseNameOf dataDir;
UMask = 0117;
User = "mautrix-signal";
Group = "matrix-synapse";
EnvironmentFile = cfg.environmentFile;
};
restartTriggers = [settingsFileUnsubstituted cfg.environmentFile];
};
systemd.services.mautrix-signal = {
description = "Mautrix-signal";
wantedBy = ["multi-user.target"];
wants = ["matrix-synapse.service" "mautrix-signal-genregistration.service" "signald.service"];
after = ["matrix-synapse.service" "mautrix-signal-genregistration.service" "signald.service"];
serviceConfig = {
Type = "simple";
Restart = "always";
WorkingDirectory = dataDir;
User = "mautrix-signal";
Group = "matrix-synapse";
EnvironmentFile = cfg.environmentFile;
ExecStart = ''
${pkgs.mautrix-signal}/bin/mautrix-signal \
--config='${settingsFile}'
'';
};
restartTriggers = [cfg.environmentFile];
};
users.users.mautrix-signal = {
description = "Mautrix signal bridge";
home = "${dataDir}";
useDefaultShell = true;
group = "matrix-synapse";
isSystemUser = true;
};
services.matrix-synapse.settings.app_service_config_files = [
registrationFile
];
services.signald = {
user = "mautrix-signal";
group = "matrix-synapse";
enable = true;
};
};
}