Installation

The recommended method for running Sunshine is to use the binaries bundled with the latest release.

Attention

Additional setup is required after installation. See Setup.

Binaries

Binaries of Sunshine are created for each release. They are available for Linux, macOS, and Windows. Binaries can be found in the latest release.

Tip

Some third party packages also exist. See Third Party Packages.

Docker

Docker images are available on Dockerhub.io and ghcr.io.

See Docker for additional information.

Linux

First, follow the instructions for your preferred package type below.

Then start sunshine with the following command, unless a start command is listed in the specified package.

sunshine

AppImage

According to AppImageLint the supported distro matrix of the AppImage is below.

• [✖] Debian oldstable (buster)

• [✔] Debian stable (bullseye)

• [✔] Debian testing (bookworm)

• [✔] Debian unstable (sid)

• [✔] Ubuntu kinetic

• [✔] Ubuntu jammy

• [✔] Ubuntu focal

• [✖] Ubuntu bionic

• [✖] Ubuntu xenial

• [✖] Ubuntu trusty

• [✖] CentOS 7

1. Download sunshine.AppImage to your home directory.

2. Open terminal and run the following code.

   ./sunshine.AppImage --install
   

Start:

./sunshine.AppImage --install && ./sunshine.AppImage

Uninstall:

./sunshine.AppImage --remove

AUR Package

1. Open terminal and run the following code.

   git clone https://aur.archlinux.org/sunshine.git
   cd sunshine
   makepkg -fi
   

Uninstall:

pacman -R sunshine

Debian Package

1. Download sunshine-{ubuntu-version}.deb and run the following code.

   sudo apt install -f ./sunshine-{ubuntu-version}.deb
   

Note

The {ubuntu-version} is the version of ubuntu we built the package on. If you are not using Ubuntu and have an issue with one package, you can try another.

Tip

You can double click the deb file to see details about the package and begin installation.

Uninstall:

sudo apt remove sunshine

Flatpak Package

1. Install Flatpak as required.

2. Download sunshine_{arch}.flatpak and run the following code.

   Note

   Be sure to replace {arch} with the architecture for your operating system.

   System level (recommended)

   flatpak install --system ./sunshine_{arch}.flatpak
   

   User level

   flatpak install --user ./sunshine_{arch}.flatpak
   

   Additional installation (required)

   flatpak run --command=additional-install.sh dev.lizardbyte.sunshine
   

Start:

X11 and NVFBC capture (X11 Only)

flatpak run dev.lizardbyte.sunshine

KMS capture (Wayland & X11)

sudo -i PULSE_SERVER=unix:$(pactl info | awk '/Server String/{print$3}') flatpak run dev.lizardbyte.sunshine

Uninstall:

flatpak run --command=remove-additional-install.sh dev.lizardbyte.sunshine
flatpak uninstall --delete-data dev.lizardbyte.sunshine

RPM Package

1. Add rpmfusion repositories by running the following code.

   sudo dnf install https://mirrors.rpmfusion.org/free/fedora/rpmfusion-free-release-$(rpm -E %fedora).noarch.rpm \
   https://mirrors.rpmfusion.org/nonfree/fedora/rpmfusion-nonfree-release-$(rpm -E %fedora).noarch.rpm
   

2. Download sunshine.rpm and run the following code.

   sudo dnf install ./sunshine.rpm
   

Tip

You can double click the rpm file to see details about the package and begin installation.

Uninstall:

sudo dnf remove sunshine

macOS

pkg

Warning

The pkg does not include runtime dependencies and should be considered experimental.

1. Download the sunshine.pkg file and install it as normal.

Uninstall:

cd /etc/sunshine/assets
uninstall_pkg.sh

Portfile

1. Install MacPorts

2. Update the Macports sources.

   sudo nano /opt/local/etc/macports/sources.conf
   

   Add this line, replacing your username, below the line that starts with rsync.

   file:///Users/<username>/ports

   Ctrl+x, then Y to exit and save changes.

3. Download the Portfile to ~/Downloads and run the following code.

   mkdir -p ~/ports/multimedia/sunshine
   mv ~/Downloads/Portfile ~/ports/multimedia/sunshine/
   cd ~/ports
   portindex
   sudo port install sunshine
   

4. The first time you start Sunshine, you will be asked to grant access to screen recording and your microphone.

Uninstall:

sudo port uninstall sunshine

Windows

Installer

1. Download and install sunshine-windows.exe

To uninstall, find Sunshine in the list here and select “Uninstall” from the overflow menu. Different versions of Windows may provide slightly different steps for uninstall.

Standalone

1. Download and extract sunshine-windows.zip

To uninstall, delete the extracted directory which contains the sunshine.exe file.