modules/betanin: simplify configuration
Use secret settings configuration that a handful of other NixOS modules do. Remove assertions. Remove beets config file setting.
This commit is contained in:
parent
55936a1641
commit
5f261acb3b
@ -1,47 +1,16 @@
|
|||||||
{ config, lib, pkgs, ... }:
|
{ config, lib, pkgs, ... }:
|
||||||
|
|
||||||
let
|
let
|
||||||
inherit (lib) mkIf mkOption optionalAttrs optionalString types;
|
inherit (builtins) hashString;
|
||||||
|
inherit (lib) mkIf mkOption optionalAttrs types;
|
||||||
|
|
||||||
cfg = config.services.betanin;
|
cfg = config.services.betanin;
|
||||||
|
|
||||||
defaultUser = "betanin";
|
defaultUser = "betanin";
|
||||||
defaultGroup = "betanin";
|
defaultGroup = "betanin";
|
||||||
defaultSettings = {
|
|
||||||
notifications = {
|
|
||||||
services = { };
|
|
||||||
strings = {
|
|
||||||
title = "[betanin] torrent `$name` $status";
|
|
||||||
body = "@ $time. view/use the console at http://127.0.0.1:${toString cfg.port}/$console_path";
|
|
||||||
};
|
|
||||||
};
|
|
||||||
};
|
|
||||||
|
|
||||||
finalSettings =
|
|
||||||
let
|
|
||||||
base = lib.filterAttrsRecursive (n: _: !(lib.hasSuffix "_file" n)) cfg.settings;
|
|
||||||
clean = {
|
|
||||||
frontend.password =
|
|
||||||
if cfg.settings.frontend.password_file != null
|
|
||||||
then "@password@"
|
|
||||||
else cfg.settings.frontend.password;
|
|
||||||
clients.api_key =
|
|
||||||
if cfg.settings.clients.api_key_file != null
|
|
||||||
then "@api_key@"
|
|
||||||
else cfg.settings.clients.api_key;
|
|
||||||
};
|
|
||||||
in
|
|
||||||
lib.foldl' lib.recursiveUpdate defaultSettings [ base clean ];
|
|
||||||
|
|
||||||
settingsFormat = pkgs.formats.toml { };
|
settingsFormat = pkgs.formats.toml { };
|
||||||
settingsFile = settingsFormat.generate "betanin.toml" finalSettings;
|
|
||||||
|
|
||||||
beetsFormat = pkgs.formats.yaml { };
|
beetsFormat = pkgs.formats.yaml { };
|
||||||
beetsFile =
|
|
||||||
if (cfg.beetsFile != null)
|
|
||||||
then cfg.beetsFile
|
|
||||||
else if (cfg.beetsConfig != { })
|
|
||||||
then beetsFormat.generate "betanin-beets.yaml" cfg.beetsConfig
|
|
||||||
else null;
|
|
||||||
in
|
in
|
||||||
{
|
{
|
||||||
options = {
|
options = {
|
||||||
@ -85,106 +54,50 @@ in
|
|||||||
};
|
};
|
||||||
|
|
||||||
settings = mkOption {
|
settings = mkOption {
|
||||||
type = types.submodule {
|
type = settingsFormat.type;
|
||||||
freeformType = settingsFormat.type;
|
default = { };
|
||||||
|
|
||||||
options.frontend.username = mkOption {
|
|
||||||
type = types.str;
|
|
||||||
default = "";
|
|
||||||
description = "Username used to log into the frontend. Must be set.";
|
|
||||||
};
|
|
||||||
|
|
||||||
options.frontend.password = mkOption {
|
|
||||||
type = types.str;
|
|
||||||
default = "";
|
|
||||||
description = ''
|
|
||||||
Password used to log into the frontend. Either password or
|
|
||||||
password_file must be set.
|
|
||||||
'';
|
|
||||||
};
|
|
||||||
|
|
||||||
options.frontend.password_file = mkOption {
|
|
||||||
type = with types; nullOr (either str path);
|
|
||||||
default = null;
|
|
||||||
description = ''
|
|
||||||
File containing the password used to log into the frontend. The
|
|
||||||
file must be readable by the betanin user/group.
|
|
||||||
|
|
||||||
Using a password file keeps the password out of the Nix store, but
|
|
||||||
the password is still stored in plain text in the service data
|
|
||||||
directory.
|
|
||||||
'';
|
|
||||||
};
|
|
||||||
|
|
||||||
options.clients.api_key = mkOption {
|
|
||||||
type = types.nullOr types.str;
|
|
||||||
default = "";
|
|
||||||
description = ''
|
|
||||||
API key used to access Betanin (e.g., from other services).
|
|
||||||
'';
|
|
||||||
};
|
|
||||||
|
|
||||||
options.clients.api_key_file = mkOption {
|
|
||||||
type = with types; nullOr (either str path);
|
|
||||||
default = null;
|
|
||||||
description = ''
|
|
||||||
File containing the API key used to access Betanin (e.g., from
|
|
||||||
other services). The file must be readable by the betanin
|
|
||||||
user/group.
|
|
||||||
|
|
||||||
Using a API key file keeps the API key out of the Nix store, but
|
|
||||||
the API key is still stored in plain text in the service data
|
|
||||||
directory.
|
|
||||||
'';
|
|
||||||
};
|
|
||||||
};
|
|
||||||
default = defaultSettings;
|
|
||||||
example = lib.literalExpression ''
|
example = lib.literalExpression ''
|
||||||
{
|
{
|
||||||
frontend = {
|
frontend = {
|
||||||
username = "foo";
|
username = "foo";
|
||||||
password_file = "/run/secrets/betaninPasswordFile";
|
password { _secret = "/run/secrets/betaninPasswordFile"; };
|
||||||
};
|
};
|
||||||
clients = {
|
clients = {
|
||||||
api_key_file = "/run/secrets/betaninApiKeyFile";
|
api_key = { _secret = "/run/secrets/betaninApiKeyFile"; };
|
||||||
};
|
};
|
||||||
server = {
|
server = {
|
||||||
num_parallel_jobs = 1;
|
num_parallel_jobs = 1;
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
'';
|
'';
|
||||||
description = "Configuration for betanin.";
|
description = lib.mdDoc ''
|
||||||
|
Configuration for betanin.
|
||||||
|
|
||||||
|
Options containing secret data should be set to an attribute set
|
||||||
|
containing the attribute `_secret` - a string pointing to a file
|
||||||
|
containing the value the option should be set to.
|
||||||
|
'';
|
||||||
};
|
};
|
||||||
|
|
||||||
beetsConfig = mkOption {
|
beets.settings = mkOption {
|
||||||
description = "beets configuration.";
|
|
||||||
type = beetsFormat.type;
|
type = beetsFormat.type;
|
||||||
default = { };
|
default = { };
|
||||||
};
|
description = lib.mdDoc "Configuration for beets used by betanin.";
|
||||||
|
|
||||||
beetsFile = mkOption {
|
|
||||||
description = "beets configuration file.";
|
|
||||||
type = with types; nullOr (either str path);
|
|
||||||
default = null;
|
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
config = mkIf cfg.enable {
|
config = mkIf cfg.enable {
|
||||||
assertions = [
|
services.betanin.settings = {
|
||||||
{
|
notifications = {
|
||||||
assertion = cfg.settings.frontend.username != "";
|
# Required to exist.
|
||||||
message = "services.betanin.settings.frontend.username is required";
|
services = { };
|
||||||
}
|
strings = {
|
||||||
{
|
title = lib.mkDefault "[betanin] torrent `$name` $status";
|
||||||
assertion = (cfg.settings.frontend.password == "") != (cfg.settings.frontend.password_file == null);
|
body = lib.mkDefault "@ $time. view/use the console at http://127.0.0.1:${toString cfg.port}/$console_path";
|
||||||
message = "services.betanin.settings.frontend.password or services.betanin.settings.frontend.password_file is required";
|
};
|
||||||
}
|
};
|
||||||
{
|
};
|
||||||
assertion = (cfg.settings.clients.api_key == "") != (cfg.settings.clients.api_key_file == null);
|
|
||||||
message = "services.betanin.settings.clients.api_key or services.betanin.settings.clients.api_key_file is required";
|
|
||||||
}
|
|
||||||
];
|
|
||||||
|
|
||||||
networking.firewall = mkIf cfg.openFirewall {
|
networking.firewall = mkIf cfg.openFirewall {
|
||||||
allowedTCPPorts = [ cfg.port ];
|
allowedTCPPorts = [ cfg.port ];
|
||||||
@ -192,12 +105,20 @@ in
|
|||||||
|
|
||||||
systemd.services.betanin =
|
systemd.services.betanin =
|
||||||
let
|
let
|
||||||
replaceSecret = secretFile: placeholder: targetFile:
|
isSecret = v: lib.isAttrs v && v ? _secret && lib.isString v._secret;
|
||||||
optionalString (secretFile != null) ''
|
sanitisedConfig = lib.mapAttrsRecursiveCond
|
||||||
${pkgs.replace-secret}/bin/replace-secret ${placeholder} ${secretFile} ${targetFile}
|
(as: !isSecret as)
|
||||||
'';
|
(_: v: if isSecret v then hashString "sha256" v._secret else v)
|
||||||
replaceConfigSecret = secretFile: placeholder:
|
cfg.settings;
|
||||||
replaceSecret secretFile placeholder "${cfg.dataDir}/.config/betanin/config.toml";
|
settingsFile = settingsFormat.generate "betanin.toml" sanitisedConfig;
|
||||||
|
|
||||||
|
secretPaths = lib.catAttrs "_secret" (lib.collect isSecret cfg.settings);
|
||||||
|
mkSecretReplacement = file: ''
|
||||||
|
replace-secret ${hashString "sha256" file} ${file} "${cfg.dataDir}/.config/betanin/config.toml"
|
||||||
|
'';
|
||||||
|
secretReplacements = lib.concatMapStrings mkSecretReplacement secretPaths;
|
||||||
|
|
||||||
|
beetsFile = beetsFormat.generate "betanin-beets.yaml" cfg.beets.settings;
|
||||||
in
|
in
|
||||||
{
|
{
|
||||||
description = "Betanin service";
|
description = "Betanin service";
|
||||||
@ -210,15 +131,12 @@ in
|
|||||||
|
|
||||||
script = ''
|
script = ''
|
||||||
mkdir -p ${cfg.dataDir}/.config/betanin \
|
mkdir -p ${cfg.dataDir}/.config/betanin \
|
||||||
${cfg.dataDir}/.config/beets \
|
${cfg.dataDir}/.local/share/betanin \
|
||||||
${cfg.dataDir}/.local/share/betanin
|
${cfg.dataDir}/.config/beets
|
||||||
cat ${settingsFile} > ${cfg.dataDir}/.config/betanin/config.toml
|
|
||||||
|
|
||||||
${optionalString (beetsFile != null) ''
|
ln -sf ${beetsFile} ${cfg.dataDir}/.config/betanin/config.toml
|
||||||
ln -sf ${beetsFile} ${cfg.dataDir}/.config/betanin/config.toml
|
cat ${settingsFile} > ${cfg.dataDir}/.config/betanin/config.toml
|
||||||
''}
|
${secretReplacements}
|
||||||
${replaceConfigSecret cfg.settings.frontend.password_file "@password@"}
|
|
||||||
${replaceConfigSecret cfg.settings.clients.api_key_file "@api_key@"}
|
|
||||||
|
|
||||||
${cfg.package}/bin/betanin --port ${toString cfg.port}
|
${cfg.package}/bin/betanin --port ${toString cfg.port}
|
||||||
'';
|
'';
|
||||||
|
Loading…
Reference in New Issue
Block a user