Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/LizardByte/Sunshine/llms.txt

Use this file to discover all available pages before exploring further.

Self-hosted game streaming
made simple

Low-latency game streaming server for Moonlight. Stream your games from anywhere with hardware-accelerated encoding support for AMD, Intel, and Nvidia GPUs.

Get startedInstallation guide
Multi-platform
Hardware encoding
Open source

Quick start

Get streaming in minutes with these simple steps

1

Install Sunshine on your host

Download and install Sunshine on the computer you want to stream from. We provide binaries for Linux, Windows, macOS, and FreeBSD.
# Linux (Debian/Ubuntu)
sudo apt install ./sunshine-ubuntu-24.04-amd64.deb

# Windows (via winget)
winget install LizardByte.Sunshine

# macOS (via Homebrew)
brew install sunshine
2

Configure your stream settings

Access the web UI at https://localhost:47990 to configure your stream quality, encoder settings, and add applications.
Use hardware encoding for the best performance. Sunshine supports AMD, Intel, and Nvidia GPU encoding.
3

Pair your Moonlight client

Install Moonlight on your client device and pair it with your Sunshine host using the PIN shown in the web UI.
Moonlight is available on Windows, macOS, Linux, Android, iOS, and more.
4

Start streaming

Select your configured application in Moonlight and start streaming. Enjoy low-latency gaming from anywhere on your network.

Key features

Everything you need for professional game streaming

Hardware acceleration

Support for AMD, Intel, and Nvidia GPU encoding with automatic detection and configuration

Multi-platform support

Run on Linux, Windows, macOS, or FreeBSD with native optimizations for each platform

Web-based configuration

Configure everything through an intuitive web interface with real-time validation

4K HDR streaming

Stream in up to 4K resolution with HDR support on compatible hardware

Multiple controller types

Emulate Xbox, PlayStation, and Nintendo controllers for maximum compatibility

RESTful API

Automate and integrate with our comprehensive REST API

Explore documentation

Deep dive into specific topics

Configuration

Learn how to configure audio, video, input, network settings, and applications

Read the guide

Deployment

Deploy Sunshine with Docker, systemd, or as a standalone service

View deployment options

API Reference

Explore the REST API for automation and integration

Browse API docs

Troubleshooting

Find solutions to common issues and get help

Get help

Community and support

Get help and connect with other users

GitHub

Report issues, request features, and contribute code

Discord

Chat with the community and get real-time help

Documentation

Browse guides and troubleshooting resources

Ready to start streaming?

Install Sunshine and start streaming your games in minutes

Get started now