> ## 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.

# Installation

> Install Sunshine on Linux, Windows, macOS, or FreeBSD using official binaries, Docker, or third-party packages.

## 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](https://github.com/LizardByte/Sunshine/releases/latest).

<Note>
  Pre-releases are also available with beta features. These should be considered experimental and may have missing release artifacts.
</Note>

## Platform Installation Guides

Select your platform to view detailed installation instructions:

<CardGroup cols={2}>
  <Card title="Linux" icon="linux" href="/installation/linux">
    AppImage, Debian/Ubuntu, Fedora, Arch Linux, Flatpak, and more
  </Card>

  <Card title="Windows" icon="windows" href="/installation/windows">
    MSI/EXE installers and portable versions
  </Card>

  <Card title="macOS" icon="apple" href="/installation/macos">
    Homebrew installation for macOS 14+
  </Card>

  <Card title="FreeBSD" icon="freebsd" href="/installation/freebsd">
    Package installation for FreeBSD 14.3+
  </Card>
</CardGroup>

## Docker Installation

<Warning>
  Docker images are not recommended for most users. They are experimental and primarily intended for building custom containers.
</Warning>

Docker images are available on [Docker Hub](https://hub.docker.com/repository/docker/lizardbyte/sunshine) and [GitHub Container Registry](https://github.com/orgs/LizardByte/packages?repo_name=sunshine).

### 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

```bash theme={null}
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

```yaml theme={null}
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"
```

<Tip>
  For production Docker setups, check out [Games on Whales](https://games-on-whales.github.io), which uses Sunshine for game streaming.
</Tip>

### Docker Parameters

| Parameter                | Function                 | Required |
| ------------------------ | ------------------------ | -------- |
| `-p 47990:47990`         | Web UI Port              | Yes      |
| `-v /path:/config`       | Configuration volume     | Yes      |
| `-e PUID=1001`           | User ID for permissions  | No       |
| `-e PGID=1001`           | Group ID for permissions | No       |
| `-e TZ=America/New_York` | Timezone                 | No       |

### Supported Architectures

| OS              | amd64/x86\_64 | arm64/aarch64 |
| --------------- | ------------- | ------------- |
| debian-bookworm | ✅             | ✅             |
| ubuntu-22.04    | ✅             | ✅             |
| ubuntu-24.04    | ✅             | ✅             |

## Third-Party Packages

<Warning>
  Third-party packages are maintained by the community. LizardByte does not provide support for third-party packages.
</Warning>

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:

<Card title="Quick Start" icon="rocket" href="/quickstart">
  Configure Sunshine and start streaming
</Card>