Official Documentationv1.3.0 · Linux Host · 19 articles

SolarFlare Documentation

Install, pair, tune, and automate a Linux Moonlight host. Use the category tabs in the header, the sidebar, or search with ⌘K.

Quickstart Configuration REST API Security

Install on Linux

Step-by-step setup using the automated installer, systemd user units, KMS capture, and Moonlight pairing.

Read guide

Host tunables and Audio FX

Network pacer, CPU pinning, AGC, VAD ducking, Opus modes, webhooks, and per-client profiles.

Explore tunables

Low-latency tuning

SCHED_RR capture, GPU governors, PipeWire quantum, DSCP marking, and ready-made profiles.

Optimize latency

REST API

Scoped tokens, stream telemetry, updater, game scanner, and curl examples for every route.

Open reference

Diagnostics

Black screen, no audio, pairing loops, encoder failures, and a structured log-first workflow.

Fix issues

Containers

Why SolarFlare does not ship an image, upstream Sunshine caveats, and experimental compose.

Container notes

Documentation Directory

Browse every article, or search with ⌘K.

Getting Started

3 articles

Installation, quickstart guides, setup, and client pairing.

Installation & QuickstartGuide6 min read

Complete guide to installing SolarFlare on Linux, configuring firewalls, and pairing Moonlight.

GameStream Migration4 min read

Migrate existing NVIDIA GameStream setups and library configurations to SolarFlare.

Operator GuidesHow-to9 min read

Curated LAN baseline, low-latency, headless, multi-GPU, HDR, per-client, webhook, and logging how-tos.

Operations

1 article

Containers, packaging caveats, and host operations that sit beside day-to-day streaming.

Docker and containersOps6 min read

Upstream Sunshine images, GPU passthrough caveats, and why SolarFlare prefers a native install.

Configuration

2 articles

Host settings, Audio FX DSP filters, Opus tuning, and client profiles.

Configuration ReferenceCore10 min read

Fork-specific network, scheduling, capture, and watchdog tunables plus Audio FX, Opus DSP, webhooks, API tokens, and per-client profiles.

App & Game Examples5 min read

Launch configs for Steam, Epic, Lutris, elevated commands, and encoder presets.

Optimization

2 articles

Latency reduction, real-time scheduling, and diagnostic workflows.

Performance & Latency TuningTuning7 min read

CPU pinning, GPU governors, PipeWire audio latency hints, and socket buffer tuning.

Troubleshooting & Diagnostics7 min read

Diagnosing KMS/Wayland capture, audio sink setup, hardware encoding, and logs.

Developer & API

4 articles

REST API endpoints, multi-distro builds, and compilation.

REST API ReferenceAPI9 min read

Full REST API reference for automation, scoped tokens, updater, and telemetry.

Multi-Distro Porting6 min read

Package translation matrices for Arch, Debian, Ubuntu, Fedora, and openSUSE.

Building from Source5 min read

Compiling with CMake, developer build profiles, testing with GoogleTest.

Dependencies & Third-Party6 min read

Bundled submodules, FFmpeg prebuilt pins, Flatpak versions, and community-package warnings.

Project & Release

7 articles

Release history, security advisories, and code standards.

Changelog & Releasesv1.3.08 min read

Chronological history of SolarFlare releases, cherry-picks, and enhancements.

Security Policy4 min read

Vulnerability disclosure policies, supported release branches, and advisory channels.

Contributing Guide5 min read

Code style guidelines, Doxygen documentation requirements, and testing rules.

Maintainer Release Guide8 min read

Standard operating procedure for creating tags, verifying binaries, and publishing.

Legal & Licensing5 min read

GPL-3.0 operator summary, trademarks, codec patents, redistribution checklist, and privacy.

Ecosystem & Upstream4 min read

Awesome-Sunshine catalog, upstream changelog feed, and SolarFlare vs upstream history.

Maintainer Handbook6 min read

Triage duties, dual versioning, artifact contracts, CI scope, and new-maintainer handoff.