commit a4175381e77291c8896ff390c7c5f275142ec066 · pyrox.dev/nixpkgs

nixos/doc/manual/release-notes/rl-2505.section.md

···

       47
       47
        
       

     

       48
       48
        
       - [Zenoh](https://zenoh.io/), a pub/sub/query protocol with low overhead. The Zenoh router daemon is available as [services.zenohd](options.html#opt-services.zenohd.enable)

     

       49
       49
        
       

     

       50
       50
       +
       - [ytdl-sub](https://github.com/jmbannon/ytdl-sub), a tool that downloads media via yt-dlp and prepares it for your favorite media player, including Kodi, Jellyfin, Plex, Emby, and modern music players. Available as [services.ytdl-sub](options.html#opt-services.ytdl-sub.instances).

     

       51
       51
       +
       

     

       50
       52
        
       - [MaryTTS](https://github.com/marytts/marytts), an open-source, multilingual text-to-speech synthesis system written in pure Java. Available as [services.marytts](options.html#opt-services.marytts).

     

       51
       53
        
       

     

       52
       54
        
       - [networking.modemmanager](options.html#opt-networking.modemmanager) has been split out of [networking.networkmanager](options.html#opt-networking.networkmanager). NetworkManager still enables ModemManager by default, but options exist now to run NetworkManager without ModemManager.

nixos/modules/module-list.nix

···

       893
       893
        
         ./services/misc/workout-tracker.nix

     

       894
       894
        
         ./services/misc/whisparr.nix

     

       895
       895
        
         ./services/misc/xmrig.nix

     

       896
       896
       +
         ./services/misc/ytdl-sub.nix

     

       896
       897
        
         ./services/misc/zoneminder.nix

     

       897
       898
        
         ./services/misc/zookeeper.nix

     

       898
       899
        
         ./services/monitoring/alerta.nix

+155

nixos/modules/services/misc/ytdl-sub.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         config,

     

       3
       3
       +
         lib,

     

       4
       4
       +
         pkgs,

     

       5
       5
       +
         utils,

     

       6
       6
       +
         ...

     

       7
       7
       +
       }:

     

       8
       8
       +
       

     

       9
       9
       +
       let

     

       10
       10
       +
         cfg = config.services.ytdl-sub;

     

       11
       11
       +
       

     

       12
       12
       +
         settingsFormat = pkgs.formats.yaml { };

     

       13
       13
       +
       in

     

       14
       14
       +
       {

     

       15
       15
       +
         meta.maintainers = with lib.maintainers; [ defelo ];

     

       16
       16
       +
       

     

       17
       17
       +
         options.services.ytdl-sub = {

     

       18
       18
       +
           package = lib.mkPackageOption pkgs "ytdl-sub" { };

     

       19
       19
       +
       

     

       20
       20
       +
           user = lib.mkOption {

     

       21
       21
       +
             type = lib.types.str;

     

       22
       22
       +
             default = "ytdl-sub";

     

       23
       23
       +
             description = "User account under which ytdl-sub runs.";

     

       24
       24
       +
           };

     

       25
       25
       +
       

     

       26
       26
       +
           group = lib.mkOption {

     

       27
       27
       +
             type = lib.types.str;

     

       28
       28
       +
             default = "ytdl-sub";

     

       29
       29
       +
             description = "Group under which ytdl-sub runs.";

     

       30
       30
       +
           };

     

       31
       31
       +
       

     

       32
       32
       +
           instances = lib.mkOption {

     

       33
       33
       +
             default = { };

     

       34
       34
       +
             description = "Configuration for ytdl-sub instances.";

     

       35
       35
       +
             type = lib.types.attrsOf (

     

       36
       36
       +
               lib.types.submodule (

     

       37
       37
       +
                 { name, ... }:

     

       38
       38
       +
                 {

     

       39
       39
       +
                   options = {

     

       40
       40
       +
                     enable = lib.mkEnableOption "ytdl-sub instance";

     

       41
       41
       +
       

     

       42
       42
       +
                     schedule = lib.mkOption {

     

       43
       43
       +
                       type = lib.types.nullOr lib.types.str;

     

       44
       44
       +
                       description = "How often to run ytdl-sub. See {manpage}`systemd.time(7)` for the format.";

     

       45
       45
       +
                       default = null;

     

       46
       46
       +
                       example = "0/6:0";

     

       47
       47
       +
                     };

     

       48
       48
       +
       

     

       49
       49
       +
                     config = lib.mkOption {

     

       50
       50
       +
                       type = settingsFormat.type;

     

       51
       51
       +
                       description = "Configuration for ytdl-sub. See <https://ytdl-sub.readthedocs.io/en/latest/config_reference/config_yaml.html> for more information.";

     

       52
       52
       +
                       default = { };

     

       53
       53
       +
                       example = {

     

       54
       54
       +
                         presets."YouTube Playlist" = {

     

       55
       55
       +
                           download = "{subscription_value}";

     

       56
       56
       +
                           output_options = {

     

       57
       57
       +
                             output_directory = "YouTube";

     

       58
       58
       +
                             file_name = "{channel}/{playlist_title}/{playlist_index_padded}_{title}.{ext}";

     

       59
       59
       +
                             maintain_download_archive = true;

     

       60
       60
       +
                           };

     

       61
       61
       +
                         };

     

       62
       62
       +
                       };

     

       63
       63
       +
                     };

     

       64
       64
       +
       

     

       65
       65
       +
                     subscriptions = lib.mkOption {

     

       66
       66
       +
                       type = settingsFormat.type;

     

       67
       67
       +
                       description = "Subscriptions for ytdl-sub. See <https://ytdl-sub.readthedocs.io/en/latest/config_reference/subscription_yaml.html> for more information.";

     

       68
       68
       +
                       default = { };

     

       69
       69
       +
                       example = {

     

       70
       70
       +
                         "YouTube Playlist" = {

     

       71
       71
       +
                           "Some Playlist" = "https://www.youtube.com/playlist?list=...";

     

       72
       72
       +
                         };

     

       73
       73
       +
                       };

     

       74
       74
       +
                     };

     

       75
       75
       +
                   };

     

       76
       76
       +
       

     

       77
       77
       +
                   config = {

     

       78
       78
       +
                     config.configuration.working_directory = "/run/ytdl-sub/${utils.escapeSystemdPath name}";

     

       79
       79
       +
                   };

     

       80
       80
       +
                 }

     

       81
       81
       +
               )

     

       82
       82
       +
             );

     

       83
       83
       +
           };

     

       84
       84
       +
         };

     

       85
       85
       +
       

     

       86
       86
       +
         config = lib.mkIf (cfg.instances != { }) {

     

       87
       87
       +
           systemd.services =

     

       88
       88
       +
             let

     

       89
       89
       +
               mkService =

     

       90
       90
       +
                 name: instance:

     

       91
       91
       +
                 let

     

       92
       92
       +
                   configFile = settingsFormat.generate "config.yaml" instance.config;

     

       93
       93
       +
                   subscriptionsFile = settingsFormat.generate "subscriptions.yaml" instance.subscriptions;

     

       94
       94
       +
                 in

     

       95
       95
       +
                 lib.nameValuePair "ytdl-sub-${utils.escapeSystemdPath name}" {

     

       96
       96
       +
                   inherit (instance) enable;

     

       97
       97
       +
       

     

       98
       98
       +
                   wants = [ "network-online.target" ];

     

       99
       99
       +
                   after = [ "network-online.target" ];

     

       100
       100
       +
       

     

       101
       101
       +
                   startAt = lib.optional (instance.schedule != null) instance.schedule;

     

       102
       102
       +
       

     

       103
       103
       +
                   serviceConfig = {

     

       104
       104
       +
                     User = cfg.user;

     

       105
       105
       +
                     Group = cfg.group;

     

       106
       106
       +
       

     

       107
       107
       +
                     RuntimeDirectory = "ytdl-sub/${utils.escapeSystemdPath name}";

     

       108
       108
       +
                     StateDirectory = "ytdl-sub/${utils.escapeSystemdPath name}";

     

       109
       109
       +
                     WorkingDirectory = "/var/lib/ytdl-sub/${utils.escapeSystemdPath name}";

     

       110
       110
       +
       

     

       111
       111
       +
                     ExecStart = "${lib.getExe cfg.package} --config ${configFile} sub ${subscriptionsFile}";

     

       112
       112
       +
       

     

       113
       113
       +
                     # Hardening

     

       114
       114
       +
                     CapabilityBoundingSet = [ "" ];

     

       115
       115
       +
                     DeviceAllow = [ "" ];

     

       116
       116
       +
                     LockPersonality = true;

     

       117
       117
       +
                     PrivateDevices = true;

     

       118
       118
       +
                     PrivateTmp = true;

     

       119
       119
       +
                     PrivateUsers = true;

     

       120
       120
       +
                     ProcSubset = "pid";

     

       121
       121
       +
                     ProtectClock = true;

     

       122
       122
       +
                     ProtectControlGroups = true;

     

       123
       123
       +
                     ProtectHome = true;

     

       124
       124
       +
                     ProtectHostname = true;

     

       125
       125
       +
                     ProtectKernelLogs = true;

     

       126
       126
       +
                     ProtectKernelModules = true;

     

       127
       127
       +
                     ProtectKernelTunables = true;

     

       128
       128
       +
                     ProtectProc = "invisible";

     

       129
       129
       +
                     ProtectSystem = "strict";

     

       130
       130
       +
                     RestrictAddressFamilies = [

     

       131
       131
       +
                       "AF_INET"

     

       132
       132
       +
                       "AF_INET6"

     

       133
       133
       +
                       "AF_UNIX"

     

       134
       134
       +
                     ];

     

       135
       135
       +
                     RestrictNamespaces = true;

     

       136
       136
       +
                     RestrictRealtime = true;

     

       137
       137
       +
                     RestrictSUIDSGID = true;

     

       138
       138
       +
                     SystemCallArchitectures = "native";

     

       139
       139
       +
                   };

     

       140
       140
       +
                 };

     

       141
       141
       +
             in

     

       142
       142
       +
             lib.mapAttrs' mkService cfg.instances;

     

       143
       143
       +
       

     

       144
       144
       +
           users.users = lib.mkIf (cfg.user == "ytdl-sub") {

     

       145
       145
       +
             ytdl-sub = {

     

       146
       146
       +
               isSystemUser = true;

     

       147
       147
       +
               group = cfg.group;

     

       148
       148
       +
             };

     

       149
       149
       +
           };

     

       150
       150
       +
       

     

       151
       151
       +
           users.groups = lib.mkIf (cfg.group == "ytdl-sub") {

     

       152
       152
       +
             ytdl-sub = { };

     

       153
       153
       +
           };

     

       154
       154
       +
         };

     

       155
       155
       +
       }