commit 3e3b7747325968983ca5b1148cdafcbaf95d108d · pyrox.dev/nixpkgs

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

···

       107
       107
        
       

     

       108
       108
        
       - [zwave-js-ui](https://zwave-js.github.io/zwave-js-ui/), a full featured Z-Wave Control Panel and MQTT Gateway. Available as [services.zwave-js-ui](#opt-services.zwave-js-ui.enable).

     

       109
       109
        
       

     

       110
       110
       +
       - [Pinchflat](https://github.com/kieraneglin/pinchflat), a selfhosted YouTube media manager used to track channels and download videos on release. Available as [services.pinchflat](#opt-services.pinchflat.enable).

     

       111
       111
       +
       

     

       110
       112
        
       - [Amazon CloudWatch Agent](https://github.com/aws/amazon-cloudwatch-agent), the official telemetry collector for AWS CloudWatch and AWS X-Ray. Available as [services.amazon-cloudwatch-agent](options.html#opt-services.amazon-cloudwatch-agent.enable).

     

       111
       113
        
       

     

       112
       114
        
       - [Bat](https://github.com/sharkdp/bat), a {manpage}`cat(1)` clone with wings. Available as [programs.bat](options.html#opt-programs.bat).

nixos/modules/module-list.nix

···

       855
       855
        
         ./services/misc/parsoid.nix

     

       856
       856
        
         ./services/misc/persistent-evdev.nix

     

       857
       857
        
         ./services/misc/pghero.nix

     

       858
       858
       +
         ./services/misc/pinchflat.nix

     

       858
       859
        
         ./services/misc/pinnwand.nix

     

       859
       860
        
         ./services/misc/plex.nix

     

       860
       861
        
         ./services/misc/plikd.nix

+158

nixos/modules/services/misc/pinchflat.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         config,

     

       3
       3
       +
         pkgs,

     

       4
       4
       +
         lib,

     

       5
       5
       +
         ...

     

       6
       6
       +
       }:

     

       7
       7
       +
       

     

       8
       8
       +
       let

     

       9
       9
       +
         cfg = config.services.pinchflat;

     

       10
       10
       +
         inherit (lib)

     

       11
       11
       +
           mkEnableOption

     

       12
       12
       +
           mkPackageOption

     

       13
       13
       +
           mkOption

     

       14
       14
       +
           types

     

       15
       15
       +
           mkIf

     

       16
       16
       +
           getExe

     

       17
       17
       +
           literalExpression

     

       18
       18
       +
           optional

     

       19
       19
       +
           attrValues

     

       20
       20
       +
           mapAttrs

     

       21
       21
       +
           ;

     

       22
       22
       +
       

     

       23
       23
       +
         stateDir = "/var/lib/pinchflat";

     

       24
       24
       +
       in

     

       25
       25
       +
       {

     

       26
       26
       +
         options = {

     

       27
       27
       +
           services.pinchflat = {

     

       28
       28
       +
             enable = mkEnableOption "pinchflat";

     

       29
       29
       +
       

     

       30
       30
       +
             mediaDir = mkOption {

     

       31
       31
       +
               type = types.path;

     

       32
       32
       +
               default = "${stateDir}/media";

     

       33
       33
       +
               description = "The directory into which Pinchflat downloads videos.";

     

       34
       34
       +
             };

     

       35
       35
       +
       

     

       36
       36
       +
             port = mkOption {

     

       37
       37
       +
               type = types.port;

     

       38
       38
       +
               default = 8945;

     

       39
       39
       +
               description = "Port on which the Pinchflat web interface is available.";

     

       40
       40
       +
             };

     

       41
       41
       +
       

     

       42
       42
       +
             openFirewall = mkOption {

     

       43
       43
       +
               type = types.bool;

     

       44
       44
       +
               default = false;

     

       45
       45
       +
               description = "Open ports in the firewall for the Pinchflat web interface";

     

       46
       46
       +
             };

     

       47
       47
       +
       

     

       48
       48
       +
             selfhosted = mkOption {

     

       49
       49
       +
               type = types.bool;

     

       50
       50
       +
               default = false;

     

       51
       51
       +
               description = "Use a weak secret. If true, you are not required to provide a {env}`SECRET_KEY_BASE` through the `secretsFile` option. Do not use this option in production!";

     

       52
       52
       +
             };

     

       53
       53
       +
       

     

       54
       54
       +
             logLevel = mkOption {

     

       55
       55
       +
               type = types.enum [

     

       56
       56
       +
                 "debug"

     

       57
       57
       +
                 "info"

     

       58
       58
       +
                 "warning"

     

       59
       59
       +
                 "error"

     

       60
       60
       +
               ];

     

       61
       61
       +
               default = "info";

     

       62
       62
       +
               description = "Log level for Pinchflat.";

     

       63
       63
       +
             };

     

       64
       64
       +
       

     

       65
       65
       +
             extraConfig = mkOption {

     

       66
       66
       +
               type =

     

       67
       67
       +
                 with types;

     

       68
       68
       +
                 attrsOf (

     

       69
       69
       +
                   nullOr (oneOf [

     

       70
       70
       +
                     bool

     

       71
       71
       +
                     int

     

       72
       72
       +
                     str

     

       73
       73
       +
                   ])

     

       74
       74
       +
                 );

     

       75
       75
       +
               default = { };

     

       76
       76
       +
               example = literalExpression ''

     

       77
       77
       +
                 {

     

       78
       78
       +
                   YT_DLP_WORKER_CONCURRENCY = 1;

     

       79
       79
       +
                 }

     

       80
       80
       +
               '';

     

       81
       81
       +
               description = ''

     

       82
       82
       +
                 The configuration of Pinchflat is handled through environment variables.

     

       83
       83
       +
                 The available configuration options can be found in [the Pinchflat README](https://github.com/kieraneglin/pinchflat/README.md#environment-variables).

     

       84
       84
       +
               '';

     

       85
       85
       +
             };

     

       86
       86
       +
       

     

       87
       87
       +
             secretsFile = mkOption {

     

       88
       88
       +
               type = with types; nullOr path;

     

       89
       89
       +
               default = null;

     

       90
       90
       +
               example = "/run/secrets/pinchflat";

     

       91
       91
       +
               description = ''

     

       92
       92
       +
                 Secrets like {env}`SECRET_KEY_BASE` and {env}`BASIC_AUTH_PASSWORD`

     

       93
       93
       +
                 should be passed to the service without adding them to the world-readable Nix store.

     

       94
       94
       +
       

     

       95
       95
       +
                 Note that either this file needs to be available on the host on which `pinchflat` is running,

     

       96
       96
       +
                 or the option `selfhosted` must be `true`.

     

       97
       97
       +
                 Further, {env}`SECRET_KEY_BASE` has a minimum length requirement of 64 bytes.

     

       98
       98
       +
                 One way to generate such a secret is to use `openssl rand -hex 64`.

     

       99
       99
       +
       

     

       100
       100
       +
                 As an example, the contents of the file might look like this:

     

       101
       101
       +
                 ```

     

       102
       102
       +
                 SECRET_KEY_BASE=...copy-paste a secret token here...

     

       103
       103
       +
                 BASIC_AUTH_USERNAME=...basic auth username...

     

       104
       104
       +
                 BASIC_AUTH_PASSWORD=...basic auth password...

     

       105
       105
       +
                 ```

     

       106
       106
       +
               '';

     

       107
       107
       +
             };

     

       108
       108
       +
       

     

       109
       109
       +
             package = mkPackageOption pkgs "pinchflat" { };

     

       110
       110
       +
           };

     

       111
       111
       +
         };

     

       112
       112
       +
       

     

       113
       113
       +
         config = mkIf cfg.enable {

     

       114
       114
       +
           assertions = [

     

       115
       115
       +
             {

     

       116
       116
       +
               assertion = cfg.selfhosted || !builtins.isNull cfg.secretsFile;

     

       117
       117
       +
               message = "Either `selfhosted` must be true, or a `secretsFile` must be configured.";

     

       118
       118
       +
             }

     

       119
       119
       +
           ];

     

       120
       120
       +
       

     

       121
       121
       +
           systemd.services.pinchflat = {

     

       122
       122
       +
             description = "pinchflat";

     

       123
       123
       +
             after = [ "network.target" ];

     

       124
       124
       +
             wantedBy = [ "multi-user.target" ];

     

       125
       125
       +
       

     

       126
       126
       +
             serviceConfig = {

     

       127
       127
       +
               Type = "simple";

     

       128
       128
       +
               DynamicUser = true;

     

       129
       129
       +
               StateDirectory = baseNameOf stateDir;

     

       130
       130
       +
               Environment =

     

       131
       131
       +
                 [

     

       132
       132
       +
                   "PORT=${builtins.toString cfg.port}"

     

       133
       133
       +
                   "TZ=${config.time.timeZone}"

     

       134
       134
       +
                   "MEDIA_PATH=${cfg.mediaDir}"

     

       135
       135
       +
                   "CONFIG_PATH=${stateDir}"

     

       136
       136
       +
                   "DATABASE_PATH=${stateDir}/db/pinchflat.db"

     

       137
       137
       +
                   "LOG_PATH=${stateDir}/logs/pinchflat.log"

     

       138
       138
       +
                   "METADATA_PATH=${stateDir}/metadata"

     

       139
       139
       +
                   "EXTRAS_PATH=${stateDir}/extras"

     

       140
       140
       +
                   "TMPFILE_PATH=${stateDir}/tmp"

     

       141
       141
       +
                   "TZ_DATA_PATH=${stateDir}/extras/elixir_tz_data"

     

       142
       142
       +
                   "LOG_LEVEL=${cfg.logLevel}"

     

       143
       143
       +
                   "PHX_SERVER=true"

     

       144
       144
       +
                 ]

     

       145
       145
       +
                 ++ optional cfg.selfhosted [ "RUN_CONTEXT=selfhosted" ]

     

       146
       146
       +
                 ++ attrValues (mapAttrs (name: value: name + "=" + builtins.toString value) cfg.extraConfig);

     

       147
       147
       +
               EnvironmentFile = optional (cfg.secretsFile != null) cfg.secretsFile;

     

       148
       148
       +
               ExecStartPre = "${lib.getExe' cfg.package "migrate"}";

     

       149
       149
       +
               ExecStart = "${getExe cfg.package} start";

     

       150
       150
       +
               Restart = "on-failure";

     

       151
       151
       +
             };

     

       152
       152
       +
           };

     

       153
       153
       +
       

     

       154
       154
       +
           networking.firewall = mkIf cfg.openFirewall {

     

       155
       155
       +
             allowedTCPPorts = [ cfg.port ];

     

       156
       156
       +
           };

     

       157
       157
       +
         };

     

       158
       158
       +
       }