NixOS Wiki

Sunshine: Difference between revisions

← Older edit
VisualWikitext
Klinger (talk | contribs)
trusted
904 edits
Tags: Mobile edit Mobile web edit
Sandro (talk | contribs)
59 edits
Drop Attribution, the reddit post is more fitting for the PR that got merged as a nixos module. It has not much to do with the current wiki page.
 
(6 intermediate revisions by 4 users not shown)
Line 1: Line 1:
This page is intended to explain how to use Sunshine, an open-source implementation of Nvidia’s Moonlight game streaming application.
This page is intended to explain how to use Sunshine, an open-source implementation of NVIDIA’s GameStream protocol.


== Install ==
== 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>
{{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;
     enable = true;
     allowedTCPPorts = [ 47984 47989 47990 48010 ];
     autoStart = true;
     allowedUDPPortRanges = [
     capSysAdmin = true; # only needed for Wayland -- omit this when using with Xorg
      { from = 47998; to = 48000; }
     openFirewall = true;
      { 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;
}
</nowiki>}}
</nowiki>}}


== Connecting to the host ==
== Connecting to the host ==


Sunshine needs to be started with the <pre>sunshine</pre> command.
When installed via the NixOS module, Sunshine is configured as a Systemd user unit, and will start automatically on login to a graphical session. Note that a logout/login or restart may be required for Sunshine to start after initially adding it to your configuration due to limitations of NixOS' handling of user units with <code>nixos-rebuild</code>. 
 
If <code>services.sunshine.autoStart</code> is set to <code>false</code>, Sunshine needs to be started with the <code>sunshine</code> command.


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


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 <code>https://localhost:47990</code>
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 <code>https://localhost:47990</code>
== Attribution ==
A substantial amount of the above came from [https://www.reddit.com/r/NixOS/comments/1bq2bx4/beginners_guide_to_sunshine_gamedesktop_streaming/ this fairly wonderful guide] posted to Reddit.


[[Category:Applications]]
[[Category:Applications]]
[[Category:Gaming]]
[[Category:Gaming]]
Retrieved from "https://wiki.nixos.org/wiki/Sunshine"