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#
Follow the instructions for your preferred package type below.
CUDA Compatibility
CUDA is used for NVFBC capture.
Tip
See CUDA GPUS to cross reference Compute Capability to your GPU.
Package |
CUDA Version |
Min Driver |
CUDA Compute Capabilities |
---|---|---|---|
PKGBUILD |
User dependent |
User dependent |
User dependent |
sunshine.AppImage |
11.8.0 |
450.80.02 |
35;50;52;60;61;62;70;75;80;86;90 |
sunshine.pkg.tar.zst |
11.8.0 |
450.80.02 |
35;50;52;60;61;62;70;75;80;86;90 |
sunshine_{arch}.flatpak |
12.0.0 |
525.60.13 |
50;52;60;61;62;70;75;80;86;90 |
sunshine-debian-bookworm-{arch}.deb |
12.0.0 |
525.60.13 |
50;52;60;61;62;70;75;80;86;90 |
sunshine-debian-bullseye-{arch}.deb |
11.8.0 |
450.80.02 |
35;50;52;60;61;62;70;75;80;86;90 |
sunshine-fedora-37-{arch}.rpm |
12.0.0 |
525.60.13 |
50;52;60;61;62;70;75;80;86;90 |
sunshine-fedora-38-{arch}.rpm |
unavailable |
unavailable |
none |
sunshine-ubuntu-20.04-{arch}.deb |
11.8.0 |
450.80.02 |
35;50;52;60;61;62;70;75;80;86;90 |
sunshine-ubuntu-22.04-{arch}.deb |
11.8.0 |
450.80.02 |
35;50;52;60;61;62;70;75;80;86;90 |
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
Download
sunshine.AppImage
to your home directory.Open terminal and run the following code.
./sunshine.AppImage --install
- Start:
./sunshine.AppImage --install && ./sunshine.AppImage
- Uninstall:
./sunshine.AppImage --remove
Archlinux PKGBUILD#
Open terminal and run the following code.
wget https://github.com/LizardByte/Sunshine/releases/latest/download/PKGBUILD makepkg -fi
- Uninstall:
pacman -R sunshine
Archlinux pkg#
Open terminal and run the following code.
wget https://github.com/LizardByte/Sunshine/releases/latest/download/sunshine.pkg.tar.zst pacman -U --noconfirm sunshine.pkg.tar.zst
- Uninstall:
pacman -R sunshine
Debian Package#
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#
Install Flatpak as required.
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#
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
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#
Sunshine on macOS is experimental. Gamepads do not work. Other features may not work as expected.
dmg#
Warning
The dmg does not include runtime dependencies.
Download the
sunshine.dmg
file and install it.
- Uninstall:
cd /etc/sunshine/assets uninstall_pkg.sh
Portfile#
Install MacPorts
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
, thenY
to exit and save changes.- Add this line, replacing your username, below the line that starts with
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
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#
Download and install
sunshine-windows-installer.exe
Attention
You should carefully select or unselect the options you want to install. Do not blindly install or enable features.
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#
Download and extract
sunshine-windows-portable.zip
To uninstall, delete the extracted directory which contains the sunshine.exe
file.