enricobuehler
9e015304ee
Make the host docs match the real distribution path and the actual CLI. Reviewed by a multi-agent pass (6 editors against one verified fact sheet + an accuracy reviewer); its findings (a wrong client-Recommends claim, a native-concurrency overstatement) folded in. - Install front door: new README "Install (host)" method-picker + docs-site/install.md (+ nav), routing each distro to its package registry; source build demoted to a fallback. - Registry-first install: ubuntu-gnome/ubuntu-kde now lead with the apt registry (not a cargo build); bazzite leads with the Gitea RPM registry (was COPR/source). Source builds moved to an appendix. - CLI accuracy: serve --native arms pairing from the web console (NOT --allow-pairing, which with --require-pairing/--max-concurrent is m3-host-only); --open disables mandatory pairing. host-cli/configuration/pairing/quickstart/troubleshooting corrected; mgmt API documented as always HTTPS+token. Native host serves one session at a time (extras queue) — not multi. - Firewall: real ports documented (native UDP 9777 + the ephemeral data port caveat + GameStream ports) for Debian + Arch (ufw + nftables), not just Bazzite. - Sync/accuracy: punktfunk-client (GTK4) presented as a shipping client (not "roadmap"), punktfunk-client-rs as the headless tool; host Recommends punktfunk-web only (not the client); COPR chroots f43/44; bootc header says Gitea registry not COPR. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
55 lines
2.0 KiB
Markdown
55 lines
2.0 KiB
Markdown
---
|
|
title: Quick Start
|
|
description: From nothing to streaming — set up a host and connect your first client.
|
|
---
|
|
|
|
This is the shortest path to a working stream. Each step links to the details.
|
|
|
|
## 1. Set up the host
|
|
|
|
On your Linux + NVIDIA machine, follow the guide for your system:
|
|
|
|
- [Ubuntu — GNOME](/docs/ubuntu-gnome)
|
|
- [Ubuntu — KDE Plasma](/docs/ubuntu-kde)
|
|
- [Fedora — KDE Plasma](/docs/fedora-kde)
|
|
- [Bazzite — gamescope / Steam](/docs/bazzite)
|
|
|
|
Each one covers the NVIDIA driver, the dependencies, and how to build and run the host. Check the
|
|
[Requirements](/docs/requirements) first if you're not sure your machine is a fit.
|
|
|
|
## 2. Start the host
|
|
|
|
From a terminal **inside your desktop session** (so the host can reach your compositor):
|
|
|
|
```sh
|
|
punktfunk-host serve --native
|
|
```
|
|
|
|
The host starts listening and prints its identity fingerprint. It advertises itself on your local
|
|
network, so clients can find it by name. Leave it running. (To start it automatically at boot, see
|
|
[Running as a Service](/docs/running-as-a-service).)
|
|
|
|
## 3. Connect and pair a client
|
|
|
|
On the device you want to stream to:
|
|
|
|
- **Apple (Mac, iPhone, iPad, Apple TV):** open the punktfunk app — your host appears under *On this
|
|
network*. Tap it, and when prompted, **pair**.
|
|
- **Anything with Moonlight:** add the host (it should be discovered automatically), then pair.
|
|
|
|
To pair, the host needs to show a PIN. Arm pairing from the host's web console — the host displays a
|
|
4-digit PIN, you type it into the client, and they trust each other from then on. Pairing is required
|
|
by default. Full details: [Pairing & Trust](/docs/pairing).
|
|
|
|
## 4. Stream
|
|
|
|
Once paired, select the host and start streaming. The host creates a virtual display at your device's
|
|
resolution and refresh, and the picture comes up. Mouse, keyboard, and controllers flow back to the
|
|
host.
|
|
|
|
## Next steps
|
|
|
|
- Tune [resolution, refresh, and bitrate](/docs/configuration).
|
|
- Run the host [as a background service](/docs/running-as-a-service) so it's always available.
|
|
- Hit a snag? See [Troubleshooting](/docs/troubleshooting).
|