commit 3a3b9dbba3ea96104db5f369f9f699362d232ff9 · pyrox.dev/nixpkgs

+45 -77

nixos/modules/services/networking/minidlna.nix

···

       1
       -
       # Module for MiniDLNA, a simple DLNA server.

     

       2
        
       { config, lib, pkgs, ... }:

     

       3
       -
       with lib;

     

       4
        
       

     

       5
        
       let

     

       6
        
         cfg = config.services.minidlna;

     

       7
       -
         settingsFormat = pkgs.formats.keyValue { listsAsDuplicateKeys = true; };

     

       8
       -
         settingsFile = settingsFormat.generate "minidlna.conf" cfg.settings;

     

       9
       -
       in

     

       10
        
       

     

       11
       -
       {

     

       12
       -
         ###### interface

     

       13
       -
         options.services.minidlna.enable = mkOption {

     

       14
       -
           type = types.bool;

     

       15
       -
           default = false;

     

       16
       -
           description = ''

     

       17
       -
             Whether to enable MiniDLNA, a simple DLNA server.

     

       18
       -
             It serves media files such as video and music to DLNA client devices

     

       19
       -
             such as televisions and media players. If you use the firewall, consider

     

       20
       -
             adding the following: `services.minidlna.openFirewall = true;`

     

       21
       -
           '';

     

       22
       -
         };

     

       23
        
       

     

       24
       -
         options.services.minidlna.package = lib.mkPackageOption pkgs "minidlna" { };

     

       25
       -
       

     

       26
       -
         options.services.minidlna.openFirewall = mkOption {

     

       27
       -
           type = types.bool;

     

       28
       -
           default = false;

     

       29
       -
           description = ''

     

       30
       -
             Whether to open both HTTP (TCP) and SSDP (UDP) ports in the firewall.

     

       31
       -
           '';

     

       32
       -
         };

     

       33
       -
       

     

       34
       -
         options.services.minidlna.settings = mkOption {

     

       35
        
           default = {};

     

       36
       -
           description = ''

     

       37
       -
             The contents of MiniDLNA's configuration file.

     

       38
       -
             When the service is activated, a basic template is generated from the current options opened here.

     

       39
       -
           '';

     

       40
       -
           type = types.submodule {

     

       41
       -
             freeformType = settingsFormat.type;

     

       42
        
       

     

       43
       -
             options.media_dir = mkOption {

     

       44
       -
               type = types.listOf types.str;

     

       45
        
               default = [];

     

       46
        
               example = [ "/data/media" "V,/home/alice/video" ];

     

       47
        
               description = ''

     
···

       50
        
                 The directories must be accessible to the `minidlna` user account.

     

       51
        
               '';

     

       52
        
             };

     

       53
       -
             options.notify_interval = mkOption {

     

       54
       -
               type = types.int;

     

       55
        
               default = 90000;

     

       56
        
               description = ''

     

       57
        
                 The interval between announces (in seconds).

     

       58
        
                 Instead of waiting for announces, you should set `openFirewall` option to use SSDP discovery.

     

       59
       -
                 Lower values (e.g. 30 seconds) should be used if your network blocks the discovery unicast.

     

       60
       -
                 Some relevant information can be found here:

     

       61
       -
                 https://sourceforge.net/p/minidlna/discussion/879957/thread/1389d197/

     

       62
        
               '';

     

       63
        
             };

     

       64
       -
             options.port = mkOption {

     

       65
       -
               type = types.port;

     

       66
        
               default = 8200;

     

       67
        
               description = "Port number for HTTP traffic (descriptions, SOAP, media transfer).";

     

       68
        
             };

     

       69
       -
             options.db_dir = mkOption {

     

       70
       -
               type = types.path;

     

       71
        
               default = "/var/cache/minidlna";

     

       72
        
               example = "/tmp/minidlna";

     

       73
       -
               description = "Specify the directory where you want MiniDLNA to store its database and album art cache.";

     

       74
        
             };

     

       75
       -
             options.friendly_name = mkOption {

     

       76
       -
               type = types.str;

     

       77
        
               default = config.networking.hostName;

     

       78
       -
               defaultText = literalExpression "config.networking.hostName";

     

       79
        
               example = "rpi3";

     

       80
       -
               description = "Name that the DLNA server presents to clients.";

     

       81
        
             };

     

       82
       -
             options.root_container = mkOption {

     

       83
       -
               type = types.str;

     

       84
        
               default = "B";

     

       85
        
               example = ".";

     

       86
        
               description = "Use a different container as the root of the directory tree presented to clients.";

     

       87
        
             };

     

       88
       -
             options.log_level = mkOption {

     

       89
       -
               type = types.str;

     

       90
        
               default = "warn";

     

       91
        
               example = "general,artwork,database,inotify,scanner,metadata,http,ssdp,tivo=warn";

     

       92
        
               description = "Defines the type of messages that should be logged and down to which level of importance.";

     

       93
        
             };

     

       94
       -
             options.inotify = mkOption {

     

       95
       -
               type = types.enum [ "yes" "no" ];

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       96
        
               default = "no";

     

       97
        
               description = "Whether to enable inotify monitoring to automatically discover new files.";

     

       98
        
             };

     

       99
       -
             options.enable_tivo = mkOption {

     

       100
       -
               type = types.enum [ "yes" "no" ];

     

       101
        
               default = "no";

     

       102
        
               description = "Support for streaming .jpg and .mp3 files to a TiVo supporting HMO.";

     

       103
        
             };

     

       104
       -
             options.wide_links = mkOption {

     

       105
       -
               type = types.enum [ "yes" "no" ];

     

       106
        
               default = "no";

     

       107
        
               description = "Set this to yes to allow symlinks that point outside user-defined `media_dir`.";

     

       108
        
             };

     

       109
        
           };

     

       110
        
         };

     

       111
        
       

     

       112
       -
         imports = [

     

       113
       -
           (mkRemovedOptionModule [ "services" "minidlna" "config" ] "")

     

       114
       -
           (mkRemovedOptionModule [ "services" "minidlna" "extraConfig" ] "")

     

       115
       -
           (mkRenamedOptionModule [ "services" "minidlna" "loglevel"] [ "services" "minidlna" "settings" "log_level" ])

     

       116
       -
           (mkRenamedOptionModule [ "services" "minidlna" "rootContainer"] [ "services" "minidlna" "settings" "root_container" ])

     

       117
       -
           (mkRenamedOptionModule [ "services" "minidlna" "mediaDirs"] [ "services" "minidlna" "settings" "media_dir" ])

     

       118
       -
           (mkRenamedOptionModule [ "services" "minidlna" "friendlyName"] [ "services" "minidlna" "settings" "friendly_name" ])

     

       119
       -
           (mkRenamedOptionModule [ "services" "minidlna" "announceInterval"] [ "services" "minidlna" "settings" "notify_interval" ])

     

       120
       -
         ];

     

       121
        
       

     

       122
       -
         ###### implementation

     

       123
       -
         config = mkIf cfg.enable {

     

       124
       -
           networking.firewall.allowedTCPPorts = mkIf cfg.openFirewall [ cfg.settings.port ];

     

       125
       -
           networking.firewall.allowedUDPPorts = mkIf cfg.openFirewall [ 1900 ];

     

       126
       -
       

     

       127
        
           users.users.minidlna = {

     

       128
        
             description = "MiniDLNA daemon user";

     

       129
        
             group = "minidlna";

     

       130
        
             uid = config.ids.uids.minidlna;

     

       131
        
           };

     

       132
       -
       

     

       133
       -
           users.groups.minidlna.gid = config.ids.gids.minidlna;

     

       134
        
       

     

       135
        
           systemd.services.minidlna = {

     

       136
        
             description = "MiniDLNA Server";

     
···

       143
        
               CacheDirectory = "minidlna";

     

       144
        
               RuntimeDirectory = "minidlna";

     

       145
        
               PIDFile = "/run/minidlna/pid";

     

       146
       -
               ExecStart = "${lib.getExe cfg.package} -S -P /run/minidlna/pid -f ${settingsFile}";

     

       147
        
             };

     

       148
        
           };

     

       149
        
         };

···

       0
        
       
     

       1
        
       { config, lib, pkgs, ... }:

     

       0
        
       
     

       2
        
       

     

       3
        
       let

     

       4
        
         cfg = config.services.minidlna;

     

       5
       +
         format = pkgs.formats.keyValue { listsAsDuplicateKeys = true; };

     

       6
       +
         cfgfile = format.generate "minidlna.conf" cfg.settings;

     

       0
        
       
     

       7
        
       

     

       8
       +
       in {

     

       9
       +
         options.services.minidlna.enable = lib.mkEnableOption "MiniDLNA, a simple DLNA server. Consider adding `openFirewall = true` into your config";

     

       10
       +
         options.services.minidlna.openFirewall = lib.mkEnableOption "opening HTTP (TCP) and SSDP (UDP) ports in the firewall";

     

       11
       +
         options.services.minidlna.package = lib.mkPackageOption pkgs "minidlna" {};

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       12
        
       

     

       13
       +
         options.services.minidlna.settings = lib.mkOption {

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       14
        
           default = {};

     

       15
       +
           description = "Configuration for `minidlna.conf(5)`.";

     

       16
       +
           type = lib.types.submodule {

     

       17
       +
             freeformType = format.type;

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       18
        
       

     

       19
       +
             options.media_dir = lib.mkOption {

     

       20
       +
               type = lib.types.listOf lib.types.str;

     

       21
        
               default = [];

     

       22
        
               example = [ "/data/media" "V,/home/alice/video" ];

     

       23
        
               description = ''

     
···

       26
        
                 The directories must be accessible to the `minidlna` user account.

     

       27
        
               '';

     

       28
        
             };

     

       29
       +
             options.notify_interval = lib.mkOption {

     

       30
       +
               type = lib.types.int;

     

       31
        
               default = 90000;

     

       32
        
               description = ''

     

       33
        
                 The interval between announces (in seconds).

     

       34
        
                 Instead of waiting for announces, you should set `openFirewall` option to use SSDP discovery.

     

       35
       +
                 Lower values (e.g. 30 seconds) should be used if your network is blocking the SSDP multicast.

     

       36
       +
                 Some relevant information can be found [here](https://sourceforge.net/p/minidlna/discussion/879957/thread/1389d197/).

     

       0
        
       
     

       37
        
               '';

     

       38
        
             };

     

       39
       +
             options.port = lib.mkOption {

     

       40
       +
               type = lib.types.port;

     

       41
        
               default = 8200;

     

       42
        
               description = "Port number for HTTP traffic (descriptions, SOAP, media transfer).";

     

       43
        
             };

     

       44
       +
             options.db_dir = lib.mkOption {

     

       45
       +
               type = lib.types.path;

     

       46
        
               default = "/var/cache/minidlna";

     

       47
        
               example = "/tmp/minidlna";

     

       48
       +
               description = "Specify the directory to store database and album art cache.";

     

       49
        
             };

     

       50
       +
             options.friendly_name = lib.mkOption {

     

       51
       +
               type = lib.types.str;

     

       52
        
               default = config.networking.hostName;

     

       53
       +
               defaultText = lib.literalExpression "config.networking.hostName";

     

       54
        
               example = "rpi3";

     

       55
       +
               description = "Name that the server presents to clients.";

     

       56
        
             };

     

       57
       +
             options.root_container = lib.mkOption {

     

       58
       +
               type = lib.types.str;

     

       59
        
               default = "B";

     

       60
        
               example = ".";

     

       61
        
               description = "Use a different container as the root of the directory tree presented to clients.";

     

       62
        
             };

     

       63
       +
             options.log_level = lib.mkOption {

     

       64
       +
               type = lib.types.str;

     

       65
        
               default = "warn";

     

       66
        
               example = "general,artwork,database,inotify,scanner,metadata,http,ssdp,tivo=warn";

     

       67
        
               description = "Defines the type of messages that should be logged and down to which level of importance.";

     

       68
        
             };

     

       69
       +
             options.enable_subtitles = lib.mkOption {

     

       70
       +
               type = lib.types.enum [ "yes" "no" ];

     

       71
       +
               default = "yes";

     

       72
       +
               description = "Enable subtitle support on unknown clients.";

     

       73
       +
             };

     

       74
       +
             options.inotify = lib.mkOption {

     

       75
       +
               type = lib.types.enum [ "yes" "no" ];

     

       76
        
               default = "no";

     

       77
        
               description = "Whether to enable inotify monitoring to automatically discover new files.";

     

       78
        
             };

     

       79
       +
             options.enable_tivo = lib.mkOption {

     

       80
       +
               type = lib.types.enum [ "yes" "no" ];

     

       81
        
               default = "no";

     

       82
        
               description = "Support for streaming .jpg and .mp3 files to a TiVo supporting HMO.";

     

       83
        
             };

     

       84
       +
             options.wide_links = lib.mkOption {

     

       85
       +
               type = lib.types.enum [ "yes" "no" ];

     

       86
        
               default = "no";

     

       87
        
               description = "Set this to yes to allow symlinks that point outside user-defined `media_dir`.";

     

       88
        
             };

     

       89
        
           };

     

       90
        
         };

     

       91
        
       

     

       92
       +
         config = lib.mkIf cfg.enable {

     

       93
       +
           networking.firewall.allowedTCPPorts = lib.mkIf cfg.openFirewall [ cfg.settings.port ];

     

       94
       +
           networking.firewall.allowedUDPPorts = lib.mkIf cfg.openFirewall [ 1900 ];

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       95
        
       

     

       96
       +
           users.groups.minidlna.gid = config.ids.gids.minidlna;

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       97
        
           users.users.minidlna = {

     

       98
        
             description = "MiniDLNA daemon user";

     

       99
        
             group = "minidlna";

     

       100
        
             uid = config.ids.uids.minidlna;

     

       101
        
           };

     

       0
        
       
     

       0
        
       
     

       102
        
       

     

       103
        
           systemd.services.minidlna = {

     

       104
        
             description = "MiniDLNA Server";

     
···

       111
        
               CacheDirectory = "minidlna";

     

       112
        
               RuntimeDirectory = "minidlna";

     

       113
        
               PIDFile = "/run/minidlna/pid";

     

       114
       +
               ExecStart = "${lib.getExe cfg.package} -S -P /run/minidlna/pid -f ${cfgfile}";

     

       115
        
             };

     

       116
        
           };

     

       117
        
         };