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 jammy
[✔] Ubuntu impish
[✔] Ubuntu focal
[✖] Ubuntu bionic
[✖] Ubuntu xenial
[✖] Ubuntu trusty
[✖] CentOS 7
Download
sunshine-appimage.zip
and extract the contents to your home directory.Open terminal and run the following code.
./sunshine.AppImage --install
- Start:
./sunshine.AppImage --install && ./sunshine.AppImage
- Uninstall:
./sunshine.AppImage --remove
AUR Package#
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#
Download
sunshine.deb
and run the following code.sudo apt install -f ./sunshine.deb
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.flatpak
and run the following code.- System level (recommended)
flatpak install --system sunshine.flatpak
- User level
flatpak install --user sunshine.flatpak
- 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 uninstall --delete-data sunshine.flatpak
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#
pkg#
Warning
The pkg does not include runtime dependencies and should be considered experimental.
Download the
sunshine.pkg
file and install it as normal.
- 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.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#
Download and extract
sunshine-windows.zip
To uninstall, delete the extracted directory which contains the sunshine.exe
file.