Sunshine: Difference between revisions

Revision as of 08:36, 30 July 2024

This page is intended to explain how to use Sunshine, an open-source implementation of NVIDIA’s GameStream protocol.

Install

To install Sunshine and enable it you can use the following snippet:

/etc/nixos/configuration.nix

  services.sunshine = {
    enable = true;
    autoStart = true;
    capSysAdmin = true;
    openFirewall = true;
  };

For manual Firewall configuration you can open network ports as shown here:

/etc/nixos/configuration.nix

networking.firewall = {
  enable = true;
  allowedTCPPorts = [ 47984 47989 47990 48010 ];
  allowedUDPPortRanges = [
    { from = 47998; to = 48000; }
    { from = 8000; to = 8010; }
  ];
};

Connecting to the host

Sunshine needs to be started with the

sunshine

command.

You may have to manually add the host running Sunshine to your Moonlight client. This, thankfully, is not hard to do.

Simply press the button that says Add Host Manually, from there you will need to input the following (replace <Host IP> with your Host’s IP address):

<Host IP>:47989

If this doesn’t work you should double check the port in the Sunshine’s WebGUI. You can access this from the Host PC in a web browser https://localhost:47990

Attribution

A substantial amount of the above came from this fairly wonderful guide posted to Reddit.

@@ Line 2: / Line 2: @@
 == Install ==
-To install Sunshine, you will need to open up firewall ports, install udev rules and provide a setuid wrapper,
-so that sunshine can capture the display:
+To install Sunshine and enable it you can use the following snippet:
 {{file|/etc/nixos/configuration.nix|nix|<nowiki>
-{ pkgs, ... }: {
+   services.sunshine = {
-  environment.systemPackages = [
-    pkgs.sunshine
-    pkgs.moonlight-qt #for testing purposes.
-  ];
-   services.udev.packages = [ pkgs.sunshine ]; # allow access to create virtual input interfaces.
-  networking.firewall = {
      enable = true;
-     allowedTCPPorts = [ 47984 47989 47990 48010 ];
+     autoStart = true;
-     allowedUDPPortRanges = [
+     capSysAdmin = true;
-      { from = 47998; to = 48000; }
+    openFirewall = true;
-      { from = 8000; to = 8010; }
-    ];
    };
-  # Prevents this error:
+</nowiki>}}
-  # Fatal: You must run [sudo setcap cap_sys_admin+p $(readlink -f sunshine)] for KMS display capture to work!
-  security.wrappers.sunshine = {
-    owner = "root";
+For manual Firewall configuration you can open network ports as shown here:
-    group = "root";
-     capabilities = "cap_sys_admin+p";
+{{file|/etc/nixos/configuration.nix|nix|<nowiki>
-    source = "${pkgs.sunshine}/bin/sunshine";
+networking.firewall = {
-  };
+  enable = true;
-  # Needed for network discovery
+  allowedTCPPorts = [ 47984 47989 47990 48010 ];
-  services.avahi.enable = true;
+  allowedUDPPortRanges = [
-  services.avahi.publish.enable = true;
+     { from = 47998; to = 48000; }
-   services.avahi.publish.userServices = true;
+    { from = 8000; to = 8010; }
-}
+   ];
+};
 </nowiki>}}