commit 5bfe2b696431927780f3f633a74eb1f0254b55df · pyrox.dev/nixpkgs

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

···

       185
       185
        
       

     

       186
       186
        
       - [Mealie](https://nightly.mealie.io/), a self-hosted recipe manager and meal planner with a RestAPI backend and a reactive frontend application built in NuxtJS for a pleasant user experience for the whole family. Available as [services.mealie](#opt-services.mealie.enable)

     

       187
       187
        
       

     

       188
       188
       +
       - [Sunshine](https://app.lizardbyte.dev/Sunshine), a self-hosted game stream host for Moonlight. Available as [services.sunshine](#opt-services.sunshine.enable).

     

       189
       189
       +
       

     

       188
       190
        
       - [Uni-Sync](https://github.com/EightB1ts/uni-sync), a synchronization tool for Lian Li Uni Controllers. Available as [hardware.uni-sync](#opt-hardware.uni-sync.enable)

     

       189
       191
        
       

     

       190
       192
        
       - [prometheus-nats-exporter](https://github.com/nats-io/prometheus-nats-exporter), a Prometheus exporter for NATS. Available as [services.prometheus.exporters.nats](#opt-services.prometheus.exporters.nats.enable).

nixos/modules/module-list.nix

···

       1161
       1161
        
         ./services/networking/strongswan.nix

     

       1162
       1162
        
         ./services/networking/stubby.nix

     

       1163
       1163
        
         ./services/networking/stunnel.nix

     

       1164
       1164
       +
         ./services/networking/sunshine.nix

     

       1164
       1165
        
         ./services/networking/supplicant.nix

     

       1165
       1166
        
         ./services/networking/supybot.nix

     

       1166
       1167
        
         ./services/networking/syncplay.nix

+156

nixos/modules/services/networking/sunshine.nix

···

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

     

       2
       2
       +
       let

     

       3
       3
       +
         inherit (lib) mkEnableOption mkPackageOption mkOption mkIf mkDefault types optionals getExe;

     

       4
       4
       +
         inherit (utils) escapeSystemdExecArgs;

     

       5
       5
       +
         cfg = config.services.sunshine;

     

       6
       6
       +
       

     

       7
       7
       +
         # ports used are offset from a single base port, see https://docs.lizardbyte.dev/projects/sunshine/en/latest/about/advanced_usage.html#port

     

       8
       8
       +
         generatePorts = port: offsets: map (offset: port + offset) offsets;

     

       9
       9
       +
         defaultPort = 47989;

     

       10
       10
       +
       

     

       11
       11
       +
         appsFormat = pkgs.formats.json { };

     

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

     

       13
       13
       +
       

     

       14
       14
       +
         appsFile = appsFormat.generate "apps.json" cfg.applications;

     

       15
       15
       +
         configFile = settingsFormat.generate "sunshine.conf" cfg.settings;

     

       16
       16
       +
       in

     

       17
       17
       +
       {

     

       18
       18
       +
         options.services.sunshine = with types; {

     

       19
       19
       +
           enable = mkEnableOption "Sunshine, a self-hosted game stream host for Moonlight";

     

       20
       20
       +
           package = mkPackageOption pkgs "sunshine" { };

     

       21
       21
       +
           openFirewall = mkOption {

     

       22
       22
       +
             type = bool;

     

       23
       23
       +
             default = false;

     

       24
       24
       +
             description = ''

     

       25
       25
       +
               Whether to automatically open ports in the firewall.

     

       26
       26
       +
             '';

     

       27
       27
       +
           };

     

       28
       28
       +
           capSysAdmin = mkOption {

     

       29
       29
       +
             type = bool;

     

       30
       30
       +
             default = false;

     

       31
       31
       +
             description = ''

     

       32
       32
       +
               Whether to give the Sunshine binary CAP_SYS_ADMIN, required for DRM/KMS screen capture.

     

       33
       33
       +
             '';

     

       34
       34
       +
           };

     

       35
       35
       +
           settings = mkOption {

     

       36
       36
       +
             default = { };

     

       37
       37
       +
             description = ''

     

       38
       38
       +
               Settings to be rendered into the configuration file. If this is set, no configuration is possible from the web UI.

     

       39
       39
       +
       

     

       40
       40
       +
               See https://docs.lizardbyte.dev/projects/sunshine/en/latest/about/advanced_usage.html#configuration for syntax.

     

       41
       41
       +
             '';

     

       42
       42
       +
             example = ''

     

       43
       43
       +
               {

     

       44
       44
       +
                 sunshine_name = "nixos";

     

       45
       45
       +
               }

     

       46
       46
       +
             '';

     

       47
       47
       +
             type = submodule (settings: {

     

       48
       48
       +
               freeformType = settingsFormat.type;

     

       49
       49
       +
               options.port = mkOption {

     

       50
       50
       +
                 type = port;

     

       51
       51
       +
                 default = defaultPort;

     

       52
       52
       +
                 description = ''

     

       53
       53
       +
                   Base port -- others used are offset from this one, see https://docs.lizardbyte.dev/projects/sunshine/en/latest/about/advanced_usage.html#port for details.

     

       54
       54
       +
                 '';

     

       55
       55
       +
               };

     

       56
       56
       +
             });

     

       57
       57
       +
           };

     

       58
       58
       +
           applications = mkOption {

     

       59
       59
       +
             default = { };

     

       60
       60
       +
             description = ''

     

       61
       61
       +
               Configuration for applications to be exposed to Moonlight. If this is set, no configuration is possible from the web UI, and must be by the `settings` option.

     

       62
       62
       +
             '';

     

       63
       63
       +
             example = ''

     

       64
       64
       +
               {

     

       65
       65
       +
                 env = {

     

       66
       66
       +
                   PATH = "$(PATH):$(HOME)/.local/bin";

     

       67
       67
       +
                 };

     

       68
       68
       +
                 apps = [

     

       69
       69
       +
                   {

     

       70
       70
       +
                     name = "1440p Desktop";

     

       71
       71
       +
                     prep-cmd = [

     

       72
       72
       +
                       {

     

       73
       73
       +
                         do = "''${pkgs.kdePackages.libkscreen}/bin/kscreen-doctor output.DP-4.mode.2560x1440@144";

     

       74
       74
       +
                         undo = "''${pkgs.kdePackages.libkscreen}/bin/kscreen-doctor output.DP-4.mode.3440x1440@144";

     

       75
       75
       +
                       }

     

       76
       76
       +
                     ];

     

       77
       77
       +
                     exclude-global-prep-cmd = "false";

     

       78
       78
       +
                     auto-detach = "true";

     

       79
       79
       +
                   }

     

       80
       80
       +
                 ];

     

       81
       81
       +
               }

     

       82
       82
       +
             '';

     

       83
       83
       +
             type = submodule {

     

       84
       84
       +
               options = {

     

       85
       85
       +
                 env = mkOption {

     

       86
       86
       +
                   default = { };

     

       87
       87
       +
                   description = ''

     

       88
       88
       +
                     Environment variables to be set for the applications.

     

       89
       89
       +
                   '';

     

       90
       90
       +
                   type = attrsOf str;

     

       91
       91
       +
                 };

     

       92
       92
       +
                 apps = mkOption {

     

       93
       93
       +
                   default = [ ];

     

       94
       94
       +
                   description = ''

     

       95
       95
       +
                     Applications to be exposed to Moonlight.

     

       96
       96
       +
                   '';

     

       97
       97
       +
                   type = listOf attrs;

     

       98
       98
       +
                 };

     

       99
       99
       +
               };

     

       100
       100
       +
             };

     

       101
       101
       +
           };

     

       102
       102
       +
         };

     

       103
       103
       +
       

     

       104
       104
       +
         config = mkIf cfg.enable {

     

       105
       105
       +
           services.sunshine.settings.file_apps = mkIf (cfg.applications.apps != [ ]) "${appsFile}";

     

       106
       106
       +
       

     

       107
       107
       +
           environment.systemPackages = [

     

       108
       108
       +
             cfg.package

     

       109
       109
       +
           ];

     

       110
       110
       +
       

     

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

     

       112
       112
       +
             allowedTCPPorts = generatePorts cfg.settings.port [ (-5) 0 1 21 ];

     

       113
       113
       +
             allowedUDPPorts = generatePorts cfg.settings.port [ 9 10 11 13 21 ];

     

       114
       114
       +
           };

     

       115
       115
       +
       

     

       116
       116
       +
           boot.kernelModules = [ "uinput" ];

     

       117
       117
       +
       

     

       118
       118
       +
           services.udev.packages = [ cfg.package ];

     

       119
       119
       +
       

     

       120
       120
       +
           services.avahi = {

     

       121
       121
       +
             enable = mkDefault true;

     

       122
       122
       +
             publish = {

     

       123
       123
       +
               enable = mkDefault true;

     

       124
       124
       +
               userServices = mkDefault true;

     

       125
       125
       +
             };

     

       126
       126
       +
           };

     

       127
       127
       +
       

     

       128
       128
       +
           security.wrappers.sunshine = mkIf cfg.capSysAdmin {

     

       129
       129
       +
             owner = "root";

     

       130
       130
       +
             group = "root";

     

       131
       131
       +
             capabilities = "cap_sys_admin+p";

     

       132
       132
       +
             source = getExe cfg.package;

     

       133
       133
       +
           };

     

       134
       134
       +
       

     

       135
       135
       +
           systemd.user.services.sunshine = {

     

       136
       136
       +
             description = "Self-hosted game stream host for Moonlight";

     

       137
       137
       +
       

     

       138
       138
       +
             wantedBy = [ "graphical-session.target" ];

     

       139
       139
       +
             partOf = [ "graphical-session.target" ];

     

       140
       140
       +
             wants = [ "graphical-session.target" ];

     

       141
       141
       +
             after = [ "graphical-session.target" ];

     

       142
       142
       +
       

     

       143
       143
       +
             startLimitIntervalSec = 500;

     

       144
       144
       +
             startLimitBurst = 5;

     

       145
       145
       +
       

     

       146
       146
       +
             serviceConfig = {

     

       147
       147
       +
               # only add configFile if an application or a setting other than the default port is set to allow configuration from web UI

     

       148
       148
       +
               ExecStart = escapeSystemdExecArgs ([

     

       149
       149
       +
                 (if cfg.capSysAdmin then "${config.security.wrapperDir}/sunshine" else "${getExe cfg.package}")

     

       150
       150
       +
               ] ++ optionals (cfg.applications.apps != [ ] || (builtins.length (builtins.attrNames cfg.settings) > 1 || cfg.settings.port != defaultPort)) [ "${configFile}" ]);

     

       151
       151
       +
               Restart = "on-failure";

     

       152
       152
       +
               RestartSec = "5s";

     

       153
       153
       +
             };

     

       154
       154
       +
           };

     

       155
       155
       +
         };

     

       156
       156
       +
       }

nixos/tests/all-tests.nix

···

       858
       858
        
         stunnel = handleTest ./stunnel.nix {};

     

       859
       859
        
         sudo = handleTest ./sudo.nix {};

     

       860
       860
        
         sudo-rs = handleTest ./sudo-rs.nix {};

     

       861
       861
       +
         sunshine = handleTest ./sunshine.nix {};

     

       861
       862
        
         suwayomi-server = handleTest ./suwayomi-server.nix {};

     

       862
       863
        
         swap-file-btrfs = handleTest ./swap-file-btrfs.nix {};

     

       863
       864
        
         swap-partition = handleTest ./swap-partition.nix {};

+70

nixos/tests/sunshine.nix

···

       1
       1
       +
       import ./make-test-python.nix ({ pkgs, lib, ... }: {

     

       2
       2
       +
         name = "sunshine";

     

       3
       3
       +
         meta = {

     

       4
       4
       +
           # test is flaky on aarch64

     

       5
       5
       +
           broken = pkgs.stdenv.isAarch64;

     

       6
       6
       +
           maintainers = [ lib.maintainers.devusb ];

     

       7
       7
       +
         };

     

       8
       8
       +
       

     

       9
       9
       +
         nodes.sunshine = { config, pkgs, ... }: {

     

       10
       10
       +
           imports = [

     

       11
       11
       +
             ./common/x11.nix

     

       12
       12
       +
           ];

     

       13
       13
       +
       

     

       14
       14
       +
           services.sunshine = {

     

       15
       15
       +
             enable = true;

     

       16
       16
       +
             openFirewall = true;

     

       17
       17
       +
             settings = {

     

       18
       18
       +
               capture = "x11";

     

       19
       19
       +
               encoder = "software";

     

       20
       20
       +
               output_name = 0;

     

       21
       21
       +
             };

     

       22
       22
       +
           };

     

       23
       23
       +
       

     

       24
       24
       +
           environment.systemPackages = with pkgs; [

     

       25
       25
       +
             gxmessage

     

       26
       26
       +
           ];

     

       27
       27
       +
       

     

       28
       28
       +
         };

     

       29
       29
       +
       

     

       30
       30
       +
         nodes.moonlight = { config, pkgs, ... }: {

     

       31
       31
       +
           imports = [

     

       32
       32
       +
             ./common/x11.nix

     

       33
       33
       +
           ];

     

       34
       34
       +
       

     

       35
       35
       +
           environment.systemPackages = with pkgs; [

     

       36
       36
       +
             moonlight-qt

     

       37
       37
       +
           ];

     

       38
       38
       +
       

     

       39
       39
       +
         };

     

       40
       40
       +
       

     

       41
       41
       +
         enableOCR = true;

     

       42
       42
       +
       

     

       43
       43
       +
         testScript = ''

     

       44
       44
       +
           # start the tests, wait for sunshine to be up

     

       45
       45
       +
           start_all()

     

       46
       46
       +
           sunshine.wait_for_open_port(48010,"localhost")

     

       47
       47
       +
       

     

       48
       48
       +
           # set the admin username/password, restart sunshine

     

       49
       49
       +
           sunshine.execute("sunshine --creds sunshine sunshine")

     

       50
       50
       +
           sunshine.systemctl("restart sunshine","root")

     

       51
       51
       +
           sunshine.wait_for_open_port(48010,"localhost")

     

       52
       52
       +
       

     

       53
       53
       +
           # initiate pairing from moonlight

     

       54
       54
       +
           moonlight.execute("moonlight pair sunshine --pin 1234 >&2 & disown")

     

       55
       55
       +
           moonlight.wait_for_console_text("Executing request")

     

       56
       56
       +
       

     

       57
       57
       +
           # respond to pairing request from sunshine

     

       58
       58
       +
           sunshine.succeed("curl --insecure -u sunshine:sunshine -d '{\"pin\": \"1234\"}' https://localhost:47990/api/pin")

     

       59
       59
       +
       

     

       60
       60
       +
           # close moonlight once pairing complete

     

       61
       61
       +
           moonlight.send_key("kp_enter")

     

       62
       62
       +
       

     

       63
       63
       +
           # put words on the sunshine screen for moonlight to see

     

       64
       64
       +
           sunshine.execute("gxmessage 'hello world' -center -font 'sans 75' >&2 & disown")

     

       65
       65
       +
       

     

       66
       66
       +
           # connect to sunshine from moonlight and look for the words

     

       67
       67
       +
           moonlight.execute("moonlight --video-decoder software stream sunshine 'Desktop' >&2 & disown")

     

       68
       68
       +
           moonlight.wait_for_text("hello world")

     

       69
       69
       +
         '';

     

       70
       70
       +
       })

+5 -1

pkgs/servers/sunshine/default.nix

···

       5
       5
        
       , autoAddDriverRunpath

     

       6
       6
        
       , makeWrapper

     

       7
       7
        
       , buildNpmPackage

     

       8
       8
       +
       , nixosTests

     

       8
       9
        
       , cmake

     

       9
       10
        
       , avahi

     

       10
       11
        
       , libevdev

     
···

       185
       186
        
           install -Dm644 ../packaging/linux/${pname}.desktop $out/share/applications/${pname}.desktop

     

       186
       187
        
         '';

     

       187
       188
        
       

     

       188
       188
       -
         passthru.updateScript = ./updater.sh;

     

       189
       189
       +
         passthru = {

     

       190
       190
       +
           tests.sunshine = nixosTests.sunshine;

     

       191
       191
       +
           updateScript = ./updater.sh;

     

       192
       192
       +
         };

     

       189
       193
        
       

     

       190
       194
        
         meta = with lib; {

     

       191
       195
        
           description = "Sunshine is a Game stream host for Moonlight";