Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/nestrilabs/nestri/llms.txt

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

Nestri is an open-source cloud gaming platform that captures, encodes, and streams games and desktop applications over WebRTC — so you can play from any browser without installing anything locally. Whether you want to use Nestri’s hosted infrastructure or self-host on your own GPU, Nestri gives you the flexibility to run it your way.

Quickstart

Get up and running with Nestri in minutes — from account setup to your first streaming session.

Core concepts

Understand how Nestri’s relay, streaming server, and container runners work together.

Self-hosting guide

Deploy Nestri on your own hardware using Docker. Bring your own GPU.

API reference

Explore the REST API for managing games, accounts, Steam profiles, and friends.

What is Nestri?

Nestri streams games and applications from a Linux container directly to your browser. The platform has three main components that work together:
  • Streaming server (nestri-server) — a Rust process that captures the Wayland display, encodes video with GStreamer, and sends it over WebRTC
  • Relay — a Go-based libp2p relay node that brokers P2P connections between the streaming server and your browser
  • Maitred — an orchestration daemon that manages game runner containers on your machine

Steam integration

Link your Steam account and stream your existing library to any device.

Heroic Games

Stream Epic Games and GOG titles with the Heroic launcher runner.

Streaming server

Configure GPU selection, video codecs, bitrates, and encoding settings.

Custom games

Run any Linux-compatible application inside a Nestri container.

How it works

1

Set up a relay

Deploy a Nestri relay node (or use the managed one). The relay handles WebRTC signaling and P2P hole-punching so your stream reaches any network.
2

Start a runner container

Launch a game runner container (Steam, Heroic, or custom). Nestri’s nestri-server starts inside, capturing the virtual display and encoding video using your GPU.
3

Connect and play

Open the Nestri web app, select your game, and start playing — streamed directly to your browser over an encrypted WebRTC connection.
Nestri is experimental software under active development. Self-hosting requires a Linux machine with a compatible GPU (NVIDIA, AMD, or Intel). See the self-hosting guide for hardware requirements.

Build docs developers (and LLMs) love