Sunshine

From NixOS Wiki
Revision as of 09:05, 10 June 2024 by Cdro (talk | contribs) (Correct information about GameStream protocol (Moonlight is an open-source implementation))

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

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:

 
/etc/nixos/configuration.nix
{ pkgs, ... }: {
  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 ];
    allowedUDPPortRanges = [
      { from = 47998; to = 48000; }
      { from = 8000; to = 8010; }
    ];
  };
  # Prevents this error:
  # Fatal: You must run [sudo setcap cap_sys_admin+p $(readlink -f sunshine)] for KMS display capture to work!
  security.wrappers.sunshine = {
    owner = "root";
    group = "root";
    capabilities = "cap_sys_admin+p";
    source = "${pkgs.sunshine}/bin/sunshine";
  };
  # Needed for network discovery
  services.avahi.enable = true;
  services.avahi.publish.enable = true;
  services.avahi.publish.userServices = true;
}

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.