Compare commits

..

2 Commits

Author SHA1 Message Date
14be017c64
modules/betanin: support settings 2023-09-27 15:00:25 +10:00
2c1b5ceb00
modules/betanin: init 2023-09-27 15:00:18 +10:00
4 changed files with 182 additions and 198 deletions

View File

@ -1,36 +1,21 @@
{ config, lib, pkgs, ... }: { config, lib, pkgs, ... }:
let let
inherit (lib) mkIf mkOption optionalAttrs optionalString types; 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 = finalSettings =
let let
base = lib.filterAttrsRecursive (n: _: !(lib.hasSuffix "_file" n)) cfg.settings; base = lib.filterAttrsRecursive (n: _: lib.hasSuffix "_file" n) cfg.settings;
clean = { clean = {
frontend.password = frontend.password = cfg.settings.frontend.password or "@password@";
if cfg.settings.frontend.password_file != null clients.api_key = cfg.settings.clients.api_key or "@api_key@";
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 in
lib.foldl' lib.recursiveUpdate defaultSettings [ base clean ]; lib.recursiveUpdate base clean;
settingsFormat = pkgs.formats.toml { }; settingsFormat = pkgs.formats.toml { };
settingsFile = settingsFormat.generate "betanin.toml" finalSettings; settingsFile = settingsFormat.generate "betanin.toml" finalSettings;
@ -39,9 +24,7 @@ let
beetsFile = beetsFile =
if (cfg.beetsFile != null) if (cfg.beetsFile != null)
then cfg.beetsFile then cfg.beetsFile
else if (cfg.beetsConfig != { }) else beetsFormat.generate "betanin-beets.yaml" cfg.beetsConfig;
then beetsFormat.generate "betanin-beets.yaml" cfg.beetsConfig
else null;
in in
{ {
options = { options = {
@ -86,15 +69,15 @@ in
settings = mkOption { settings = mkOption {
type = types.submodule { type = types.submodule {
freeformType = settingsFormat.type; freeformType = settinsgFormat.type;
options.frontend.username = mkOption { frontend.username = mkOption {
type = types.str; type = types.str;
default = ""; default = "";
description = "Username used to log into the frontend. Must be set."; description = "Username used to log into the frontend. Must be set.";
}; };
options.frontend.password = mkOption { frontend.password = mkOption {
type = types.str; type = types.str;
default = ""; default = "";
description = '' description = ''
@ -103,7 +86,7 @@ in
''; '';
}; };
options.frontend.password_file = mkOption { frontend.password_file = mkOption {
type = with types; nullOr (either str path); type = with types; nullOr (either str path);
default = null; default = null;
description = '' description = ''
@ -116,7 +99,7 @@ in
''; '';
}; };
options.clients.api_key = mkOption { clients.api_key = mkOption {
type = types.nullOr types.str; type = types.nullOr types.str;
default = ""; default = "";
description = '' description = ''
@ -124,7 +107,7 @@ in
''; '';
}; };
options.clients.api_key_file = mkOption { clients.api_key_file = mkOption {
type = with types; nullOr (either str path); type = with types; nullOr (either str path);
default = null; default = null;
description = '' description = ''
@ -136,9 +119,20 @@ in
the API key is still stored in plain text in the service data the API key is still stored in plain text in the service data
directory. directory.
''; '';
notifications.strings.title = mkOption {
type = types.str;
default = "[betanin] torrent `$name` $status";
description = "Notification title.";
};
notifications.strings.body = mkOption {
type = types.str;
default = "@ $time. view/use the console at http://127.0.0.1:${cfg.port}/$console_path";
description = "Notification body.";
};
}; };
}; };
default = defaultSettings;
example = lib.literalExpression '' example = lib.literalExpression ''
{ {
frontend = { frontend = {
@ -172,55 +166,53 @@ in
config = mkIf cfg.enable { config = mkIf cfg.enable {
assertions = [ assertions = [
{ {
assertion = cfg.settings.frontend.username != ""; assertion = cfg.settings.frontend.username != "";
message = "services.betanin.settings.frontend.username is required"; message = "services.betanin.settings.frontend.username is required";
} }
{ {
assertion = (cfg.settings.frontend.password == "") != (cfg.settings.frontend.password_file == null); assertion = (cfg.settings.frontend.password == "") != (cfg.settings.frontend.password_file);
message = "services.betanin.settings.frontend.password or services.betanin.settings.frontend.password_file is required"; 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); assertion = (cfg.settings.clients.api_key == "") != (cfg.settings.clients.api_key_file);
message = "services.betanin.settings.clients.api_key or services.betanin.settings.clients.api_key_file is required"; message = "services.betanin.settings.clients.api_key or services.betanin.settings.clients.api_key_file is required";
} }
{
assertion = (cfg.beetsConfig == { }) != (cfg.beetsFile == null);
message = "either services.betanin.beetsConfig or services.betanin.beetsFile is required";
}
]; ];
networking.firewall = mkIf cfg.openFirewall { networking.firwall = mkIf cfg.openFirewall {
allowedTCPPorts = [ cfg.port ]; allowedTCPPorts = [ cfg.port ];
}; };
systemd.services.betanin = systemd.services.betanin = {
let
replaceSecret = secretFile: placeholder: targetFile:
optionalString (secretFile != null) ''
${pkgs.replace-secret}/bin/replace-secret ${placeholder} ${secretFile} ${targetFile}
'';
replaceConfigSecret = secretFile: placeholder:
replaceSecret secretFile placeholder "${cfg.dataDir}/.config/betanin/config.toml";
in
{
description = "Betanin service"; description = "Betanin service";
wantedBy = [ "multi-user.target" ]; wantedBy = [ "multi-user.target" ];
after = [ "networking.target" ]; after = [ "networking.target" ];
environment = { environment = {
HOME = cfg.dataDir; HOME = cfg.dataDir;
}; };
path = [ pkgs.replace-secret ];
script = '' script = ''
mkdir -p ${cfg.dataDir}/.config/betanin \ #!/bin/sh
${cfg.dataDir}/.config/beets \ mkdir -p ${cfg.dataDir}/.config/betanin
${cfg.dataDir}/.local/share/betanin mkdir -p ${cfg.dataDir}/.config/beets
mkdir -p ${cfg.dataDir}/.local/share/betanin
cat ${settingsFile} > ${cfg.dataDir}/.config/betanin/config.toml 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
''} '' ++ lib.optionalString (cfg.settings.frontend.password_file != null) ''
${replaceConfigSecret cfg.settings.frontend.password_file "@password@"} sed -i "s/@password@/$(cat ${cfg.settings.frontend.password_file})/" \
${replaceConfigSecret cfg.settings.frontend.api_key_file "@api_key@"} ${cfg.dataDir}/.config/betanin/config.toml
'' ++ lib.optionalString (cfg.settings.frontend.api_key_file != null) ''
${cfg.package}/bin/betanin --port ${toString cfg.port} sed -i "s/@api_key@/$(cat ${cfg.settings.frontend.api_key_file})/" \
${cfg.dataDir}/.config/betanin/config.toml
'' ++ ''
chmod -w ${cfg.dataDir}/.config/betanin/config.toml
${cfg.package}/bin/betanin --port ${cfg.port}
''; '';
serviceConfig = lib.mkMerge [ serviceConfig = lib.mkMerge [

View File

@ -1,11 +1,8 @@
# This file has been generated by node2nix 1.11.1. Do not edit! # This file has been generated by node2nix 1.11.1. Do not edit!
{ pkgs ? import <nixpkgs> { {pkgs ? import <nixpkgs> {
inherit system; inherit system;
} }, system ? builtins.currentSystem, nodejs ? pkgs."nodejs_18"}:
, system ? builtins.currentSystem
, nodejs ? pkgs."nodejs_18"
}:
let let
nodeEnv = import ./node-env.nix { nodeEnv = import ./node-env.nix {

View File

@ -1,6 +1,6 @@
# This file originates from node2nix # This file originates from node2nix
{ lib, stdenv, nodejs, python2, pkgs, libtool, runCommand, writeTextFile, writeShellScript }: {lib, stdenv, nodejs, python2, pkgs, libtool, runCommand, writeTextFile, writeShellScript}:
let let
# Workaround to cope with utillinux in Nixpkgs 20.09 and util-linux in Nixpkgs master # Workaround to cope with utillinux in Nixpkgs 20.09 and util-linux in Nixpkgs master
@ -9,7 +9,7 @@ let
python = if nodejs ? python then nodejs.python else python2; python = if nodejs ? python then nodejs.python else python2;
# Create a tar wrapper that filters all the 'Ignoring unknown extended header keyword' noise # Create a tar wrapper that filters all the 'Ignoring unknown extended header keyword' noise
tarWrapper = runCommand "tarWrapper" { } '' tarWrapper = runCommand "tarWrapper" {} ''
mkdir -p $out/bin mkdir -p $out/bin
cat > $out/bin/tar <<EOF cat > $out/bin/tar <<EOF
@ -90,28 +90,26 @@ let
# Bundle the dependencies of the package # Bundle the dependencies of the package
# #
# Only include dependencies if they don't exist. They may also be bundled in the package. # Only include dependencies if they don't exist. They may also be bundled in the package.
includeDependencies = { dependencies }: includeDependencies = {dependencies}:
lib.optionalString (dependencies != [ ]) ( lib.optionalString (dependencies != []) (
'' ''
mkdir -p node_modules mkdir -p node_modules
cd node_modules cd node_modules
'' ''
+ (lib.concatMapStrings + (lib.concatMapStrings (dependency:
(dependency:
'' ''
if [ ! -e "${dependency.packageName}" ]; then if [ ! -e "${dependency.packageName}" ]; then
${composePackage dependency} ${composePackage dependency}
fi fi
'' ''
) ) dependencies)
dependencies)
+ '' + ''
cd .. cd ..
'' ''
); );
# Recursively composes the dependencies of a package # Recursively composes the dependencies of a package
composePackage = { name, packageName, src, dependencies ? [ ], ... }@args: composePackage = { name, packageName, src, dependencies ? [], ... }@args:
builtins.addErrorContext "while evaluating node package '${packageName}'" '' builtins.addErrorContext "while evaluating node package '${packageName}'" ''
installPackage "${packageName}" "${src}" installPackage "${packageName}" "${src}"
${includeDependencies { inherit dependencies; }} ${includeDependencies { inherit dependencies; }}
@ -119,7 +117,7 @@ let
${lib.optionalString (builtins.substring 0 1 packageName == "@") "cd .."} ${lib.optionalString (builtins.substring 0 1 packageName == "@") "cd .."}
''; '';
pinpointDependencies = { dependencies, production }: pinpointDependencies = {dependencies, production}:
let let
pinpointDependenciesFromPackageJSON = writeTextFile { pinpointDependenciesFromPackageJSON = writeTextFile {
name = "pinpointDependencies.js"; name = "pinpointDependencies.js";
@ -196,7 +194,7 @@ let
# dependencies in the package.json file to the versions that are actually # dependencies in the package.json file to the versions that are actually
# being used. # being used.
pinpointDependenciesOfPackage = { packageName, dependencies ? [ ], production ? true, ... }@args: pinpointDependenciesOfPackage = { packageName, dependencies ? [], production ? true, ... }@args:
'' ''
if [ -d "${packageName}" ] if [ -d "${packageName}" ]
then then
@ -209,7 +207,7 @@ let
# Extract the Node.js source code which is used to compile packages with # Extract the Node.js source code which is used to compile packages with
# native bindings # native bindings
nodeSources = runCommand "node-sources" { } '' nodeSources = runCommand "node-sources" {} ''
tar --no-same-owner --no-same-permissions -xf ${nodejs.src} tar --no-same-owner --no-same-permissions -xf ${nodejs.src}
mv node-* $out mv node-* $out
''; '';
@ -416,7 +414,7 @@ let
''; '';
}; };
prepareAndInvokeNPM = { packageName, bypassCache, reconstructLock, npmFlags, production }: prepareAndInvokeNPM = {packageName, bypassCache, reconstructLock, npmFlags, production}:
let let
forceOfflineFlag = if bypassCache then "--offline" else "--registry http://www.example.com"; forceOfflineFlag = if bypassCache then "--offline" else "--registry http://www.example.com";
in in
@ -481,8 +479,8 @@ let
{ name { name
, packageName , packageName
, version ? null , version ? null
, dependencies ? [ ] , dependencies ? []
, buildInputs ? [ ] , buildInputs ? []
, production ? true , production ? true
, npmFlags ? "" , npmFlags ? ""
, dontNpmInstall ? false , dontNpmInstall ? false
@ -492,9 +490,8 @@ let
, dontStrip ? true , dontStrip ? true
, unpackPhase ? "true" , unpackPhase ? "true"
, buildPhase ? "true" , buildPhase ? "true"
, meta ? { } , meta ? {}
, ... , ... }@args:
}@args:
let let
extraArgs = removeAttrs args [ "name" "dependencies" "buildInputs" "dontStrip" "dontNpmInstall" "preRebuild" "unpackPhase" "buildPhase" "meta" ]; extraArgs = removeAttrs args [ "name" "dependencies" "buildInputs" "dontStrip" "dontNpmInstall" "preRebuild" "unpackPhase" "buildPhase" "meta" ];
@ -575,8 +572,8 @@ let
, packageName , packageName
, version ? null , version ? null
, src , src
, dependencies ? [ ] , dependencies ? []
, buildInputs ? [ ] , buildInputs ? []
, production ? true , production ? true
, npmFlags ? "" , npmFlags ? ""
, dontNpmInstall ? false , dontNpmInstall ? false
@ -585,8 +582,7 @@ let
, dontStrip ? true , dontStrip ? true
, unpackPhase ? "true" , unpackPhase ? "true"
, buildPhase ? "true" , buildPhase ? "true"
, ... , ... }@args:
}@args:
let let
extraArgs = removeAttrs args [ "name" "dependencies" "buildInputs" ]; extraArgs = removeAttrs args [ "name" "dependencies" "buildInputs" ];
@ -647,8 +643,8 @@ let
, packageName , packageName
, version ? null , version ? null
, src , src
, dependencies ? [ ] , dependencies ? []
, buildInputs ? [ ] , buildInputs ? []
, production ? true , production ? true
, npmFlags ? "" , npmFlags ? ""
, dontNpmInstall ? false , dontNpmInstall ? false
@ -657,8 +653,7 @@ let
, dontStrip ? true , dontStrip ? true
, unpackPhase ? "true" , unpackPhase ? "true"
, buildPhase ? "true" , buildPhase ? "true"
, ... , ... }@args:
}@args:
let let
nodeDependencies = buildNodeDependencies args; nodeDependencies = buildNodeDependencies args;
@ -680,7 +675,7 @@ let
# Provide the dependencies in a development shell through the NODE_PATH environment variable # Provide the dependencies in a development shell through the NODE_PATH environment variable
inherit nodeDependencies; inherit nodeDependencies;
shellHook = lib.optionalString (dependencies != [ ]) '' shellHook = lib.optionalString (dependencies != []) ''
export NODE_PATH=${nodeDependencies}/lib/node_modules export NODE_PATH=${nodeDependencies}/lib/node_modules
export PATH="${nodeDependencies}/bin:$PATH" export PATH="${nodeDependencies}/bin:$PATH"
''; '';

View File

@ -1,6 +1,6 @@
# This file has been generated by node2nix 1.11.1. Do not edit! # This file has been generated by node2nix 1.11.1. Do not edit!
{ nodeEnv, fetchurl, fetchgit, nix-gitignore, stdenv, lib, globalBuildInputs ? [ ] }: {nodeEnv, fetchurl, fetchgit, nix-gitignore, stdenv, lib, globalBuildInputs ? []}:
let let
sources = { sources = {
@ -9196,7 +9196,8 @@ let
}) })
]; ];
buildInputs = globalBuildInputs; buildInputs = globalBuildInputs;
meta = { }; meta = {
};
production = false; production = false;
bypassCache = true; bypassCache = true;
reconstructLock = false; reconstructLock = false;
@ -9215,8 +9216,7 @@ in
"*" "*"
"!package.json" "!package.json"
"!package-lock.json" "!package-lock.json"
] ] args.src;
args.src;
dontBuild = true; dontBuild = true;
installPhase = "mkdir -p $out; cp -r ./* $out;"; installPhase = "mkdir -p $out; cp -r ./* $out;";
}; };