Skip to main content

​
Installation Methods

Sunshine provides multiple installation methods to suit different use cases and platforms. The recommended method is to use the official binaries from the latest release.
Pre-releases are also available with beta features. These should be considered experimental and may have missing release artifacts.

​
Platform Installation Guides

Select your platform to view detailed installation instructions:

Linux

AppImage, Debian/Ubuntu, Fedora, Arch Linux, Flatpak, and more

Windows

MSI/EXE installers and portable versions

macOS

Homebrew installation for macOS 14+

FreeBSD

Package installation for FreeBSD 14.3+

​
Docker Installation

Docker images are not recommended for most users. They are experimental and primarily intended for building custom containers.
Docker images are available on Docker Hub and GitHub Container Registry.

​
Available Image Tags

Images are tagged in the format <version>-<os>, where: Versions:
  • latest - Latest stable release
  • master - Latest development build
  • vX.X.X - Specific version
  • Commit hash - Specific commit
OS Options:
  • debian-bookworm
  • ubuntu-22.04
  • ubuntu-24.04
Example: latest-ubuntu-24.04

​
Docker Run Example

docker run -d \
  --device /dev/dri/ \
  --name=sunshine \
  --restart=unless-stopped \
  --ipc=host \
  -e PUID=1001 \
  -e PGID=1001 \
  -e TZ=America/New_York \
  -v /path/to/config:/config \
  -p 47984-47990:47984-47990/tcp \
  -p 48010:48010 \
  -p 47998-48000:47998-48000/udp \
  lizardbyte/sunshine:latest-ubuntu-24.04

​
Docker Compose Example

version: '3'
services:
  sunshine:
    image: lizardbyte/sunshine:latest-ubuntu-24.04
    container_name: sunshine
    restart: unless-stopped
    volumes:
      - /path/to/config:/config
    environment:
      - PUID=1001
      - PGID=1001
      - TZ=America/New_York
    ipc: host
    ports:
      - "47984-47990:47984-47990/tcp"
      - "48010:48010"
      - "47998-48000:47998-48000/udp"
For production Docker setups, check out Games on Whales, which uses Sunshine for game streaming.

​
Docker Parameters

ParameterFunctionRequired
-p 47990:47990Web UI PortYes
-v /path:/configConfiguration volumeYes
-e PUID=1001User ID for permissionsNo
-e PGID=1001Group ID for permissionsNo
-e TZ=America/New_YorkTimezoneNo

​
Supported Architectures

OSamd64/x86_64arm64/aarch64
debian-bookworm✅✅
ubuntu-22.04✅✅
ubuntu-24.04✅✅

​
Third-Party Packages

Third-party packages are maintained by the community. LizardByte does not provide support for third-party packages.
Some third-party package managers may offer Sunshine. Third-party packages include Homebrew (for Linux and macOS), AUR packages, Winget (Windows), and various distribution-specific repositories.

​
Next Steps

After installation, continue to the quick start guide:

Quick Start

Configure Sunshine and start streaming

Build docs developers (and LLMs) love

Get started for freeTalk to us