mirror of
https://github.com/foo-dogsquared/nixos-config.git
synced 2025-02-07 12:19:07 +00:00
nixos/services/yt-dlp: update handling of download paths
This also includes different paths for different metadata files.
This commit is contained in:
parent
03f51384cf
commit
26c5383fc9
@ -3,10 +3,32 @@
|
|||||||
let
|
let
|
||||||
cfg = config.services.yt-dlp;
|
cfg = config.services.yt-dlp;
|
||||||
|
|
||||||
serviceLevelArgs = lib.escapeShellArgs cfg.extraArgs;
|
|
||||||
|
|
||||||
jobUnitName = name: "yt-dlp-archive-service-${name}";
|
jobUnitName = name: "yt-dlp-archive-service-${name}";
|
||||||
|
|
||||||
|
metadataType = { lib, ... }: {
|
||||||
|
options = {
|
||||||
|
path = lib.mkOption {
|
||||||
|
type = with lib.types; nullOr path;
|
||||||
|
description = ''
|
||||||
|
Associated path of the metadata to be downloaded. This will be passed to
|
||||||
|
the appropriate `--paths` option of yt-dlp.
|
||||||
|
'';
|
||||||
|
default = null;
|
||||||
|
example = "/var/yt-dlp/thumbnails";
|
||||||
|
};
|
||||||
|
|
||||||
|
output = lib.mkOption {
|
||||||
|
type = with lib.types; nullOr str;
|
||||||
|
description = ''
|
||||||
|
Associated output name for the metadata. This is passed to the
|
||||||
|
appropriate `--output` option of yt-dlp.
|
||||||
|
'';
|
||||||
|
default = null;
|
||||||
|
example = "%(title)s.%(ext)s";
|
||||||
|
};
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
jobType = { name, config, ... }: {
|
jobType = { name, config, ... }: {
|
||||||
options = {
|
options = {
|
||||||
urls = lib.mkOption {
|
urls = lib.mkOption {
|
||||||
@ -35,14 +57,30 @@ let
|
|||||||
example = "*-*-3/4";
|
example = "*-*-3/4";
|
||||||
};
|
};
|
||||||
|
|
||||||
extraArgs = options.services.yt-dlp.extraArgs // {
|
extraArgs = options.services.yt-dlp.extraArgs;
|
||||||
default = cfg.extraArgs;
|
|
||||||
|
downloadPath = options.services.yt-dlp.downloadPath // {
|
||||||
|
default = cfg.downloadPath;
|
||||||
|
description = "Job-specific download path of the service.";
|
||||||
};
|
};
|
||||||
|
|
||||||
archivePath = options.services.yt-dlp.archivePath // {
|
metadata = options.services.yt-dlp.metadata // {
|
||||||
default = cfg.archivePath;
|
default = cfg.metadata;
|
||||||
|
description = ''
|
||||||
|
Per-job set of metadata with their associated options.
|
||||||
|
'';
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
|
config.extraArgs =
|
||||||
|
let
|
||||||
|
mkPathArg = n: v:
|
||||||
|
lib.optionals (v.output != null) [ "--output" "${n}:${v.output}" ]
|
||||||
|
++ lib.optionals (v.path != null) [ "--paths" "${n}:${v.path}" ];
|
||||||
|
in
|
||||||
|
cfg.extraArgs
|
||||||
|
++ (lib.lists.flatten (lib.mapAttrsToList mkPathArg config.metadata))
|
||||||
|
++ [ "--paths" config.downloadPath ];
|
||||||
};
|
};
|
||||||
in
|
in
|
||||||
{
|
{
|
||||||
@ -59,26 +97,39 @@ in
|
|||||||
"pkgs.yt-dlp.override { phantomjsSupport = true; }";
|
"pkgs.yt-dlp.override { phantomjsSupport = true; }";
|
||||||
};
|
};
|
||||||
|
|
||||||
archivePath = lib.mkOption {
|
downloadPath = lib.mkOption {
|
||||||
type = lib.types.path;
|
type = lib.types.path;
|
||||||
description = ''
|
description = "Download path of the service to be given per job (unless overridden).";
|
||||||
The location of the archive to be downloaded. Must be an absolute path.
|
|
||||||
'';
|
|
||||||
default = "/var/yt-dlp";
|
default = "/var/yt-dlp";
|
||||||
example = "/var/archives/yt-dlp-service";
|
example = "/srv/Videos";
|
||||||
|
};
|
||||||
|
|
||||||
|
metadata = lib.mkOption {
|
||||||
|
type = with lib.types; attrsOf (submodule metadataType);
|
||||||
|
description = ''
|
||||||
|
Global set of metadata with their appropriate options to be set.
|
||||||
|
'';
|
||||||
|
default = { };
|
||||||
|
example = {
|
||||||
|
thumbnail = {
|
||||||
|
path = "/var/yt-dlp/thumbnails";
|
||||||
|
output = "%(uploader,artist,creator,Unknown)s/%(title)s.%(ext)s";
|
||||||
|
};
|
||||||
|
infojson.path = "/var/yt-dlp/infojson";
|
||||||
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
extraArgs = lib.mkOption {
|
extraArgs = lib.mkOption {
|
||||||
type = with lib.types; listOf str;
|
type = with lib.types; listOf str;
|
||||||
description =
|
description =
|
||||||
"Global list of arguments to be passed to each yt-dlp job.";
|
"Global list of arguments to be passed to each yt-dlp job.";
|
||||||
default = [ "--download-archive videos" ];
|
default = [ ];
|
||||||
example = lib.literalExpression ''
|
example = lib.literalExpression ''
|
||||||
[
|
[
|
||||||
"--verbose"
|
"--verbose"
|
||||||
"--download-archive" "''${cfg.archivePath}/download-list"
|
|
||||||
"--concurrent-fragments" "2"
|
"--concurrent-fragments" "2"
|
||||||
"--retries" "20"
|
"--retries" "20"
|
||||||
|
"--download-archive" "videos"
|
||||||
]
|
]
|
||||||
'';
|
'';
|
||||||
};
|
};
|
||||||
@ -111,14 +162,9 @@ in
|
|||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
# There's no need to go to the working directory since yt-dlp has the
|
|
||||||
# `--paths` flag.
|
|
||||||
config = lib.mkIf cfg.enable {
|
config = lib.mkIf cfg.enable {
|
||||||
systemd.services = lib.mapAttrs'
|
systemd.services = lib.mapAttrs'
|
||||||
(name: job:
|
(name: job:
|
||||||
let
|
|
||||||
jobLevelArgs = lib.escapeShellArgs job.extraArgs;
|
|
||||||
in
|
|
||||||
lib.nameValuePair (jobUnitName name) {
|
lib.nameValuePair (jobUnitName name) {
|
||||||
inherit (job) startAt;
|
inherit (job) startAt;
|
||||||
wantedBy = [ "multi-user.target" ];
|
wantedBy = [ "multi-user.target" ];
|
||||||
@ -127,30 +173,45 @@ in
|
|||||||
description = "yt-dlp archive job for group '${name}'";
|
description = "yt-dlp archive job for group '${name}'";
|
||||||
documentation = [ "man:yt-dlp(1)" ];
|
documentation = [ "man:yt-dlp(1)" ];
|
||||||
enable = true;
|
enable = true;
|
||||||
path = [ cfg.package pkgs.coreutils ];
|
|
||||||
preStart = ''
|
|
||||||
mkdir -p ${lib.escapeShellArg job.archivePath}
|
|
||||||
'';
|
|
||||||
script = ''
|
script = ''
|
||||||
yt-dlp ${serviceLevelArgs} ${jobLevelArgs} \
|
${lib.getExe' cfg.package "yt-dlp"} \
|
||||||
${lib.escapeShellArgs job.urls} \
|
${lib.escapeShellArgs job.extraArgs} \
|
||||||
--paths ${lib.escapeShellArg job.archivePath}
|
${lib.escapeShellArgs job.urls}
|
||||||
'';
|
'';
|
||||||
serviceConfig = {
|
serviceConfig = {
|
||||||
|
ReadWritePaths =
|
||||||
|
[ job.downloadPath ]
|
||||||
|
++ lib.mapAttrsToList (n: v: lib.optionals (v.path != null) v.path) job.metadata;
|
||||||
|
|
||||||
LockPersonality = true;
|
LockPersonality = true;
|
||||||
NoNewPrivileges = true;
|
NoNewPrivileges = true;
|
||||||
|
PrivateDevices = true;
|
||||||
PrivateTmp = true;
|
PrivateTmp = true;
|
||||||
PrivateUsers = true;
|
PrivateUsers = true;
|
||||||
PrivateDevices = true;
|
PrivateMounts = true;
|
||||||
ProtectControlGroups = true;
|
|
||||||
ProtectClock = true;
|
ProtectClock = true;
|
||||||
|
ProtectControlGroups = true;
|
||||||
|
ProtectHome = true;
|
||||||
ProtectKernelLogs = true;
|
ProtectKernelLogs = true;
|
||||||
ProtectKernelModules = true;
|
ProtectKernelModules = true;
|
||||||
ProtectKernelTunables = true;
|
ProtectKernelTunables = true;
|
||||||
|
ProtectSystem = "full";
|
||||||
|
RemoveIPC = true;
|
||||||
StandardOutput = "journal";
|
StandardOutput = "journal";
|
||||||
StandardError = "journal";
|
StandardError = "journal";
|
||||||
SystemCallFilter = "@system-service";
|
SystemCallFilter = "@system-service";
|
||||||
SystemCallErrorNumber = "EPERM";
|
SystemCallErrorNumber = "EPERM";
|
||||||
|
|
||||||
|
CapabilityBoundingSet = lib.mkDefault [ ];
|
||||||
|
AmbientCapabilities = lib.mkDefault [ ];
|
||||||
|
RestrictAddressFamilies = [
|
||||||
|
"AF_LOCAL"
|
||||||
|
"AF_INET"
|
||||||
|
"AF_INET6"
|
||||||
|
];
|
||||||
|
RestrictNamespaces = true;
|
||||||
|
RestrictSUIDGUID = true;
|
||||||
|
MemoryDenyWriteExecute = true;
|
||||||
};
|
};
|
||||||
})
|
})
|
||||||
cfg.jobs;
|
cfg.jobs;
|
||||||
|
Loading…
Reference in New Issue
Block a user