enricobuehler
91d5874e94
Replace the dev/agent-log pages with a proper user-facing doc set: - Getting Started: Introduction (rewritten), How It Works, Quick Start. - Host Setup: Requirements, then clean per-platform guides — Ubuntu GNOME, Ubuntu KDE, Fedora KDE (new), Bazzite (rewritten) — plus Running as a Service (desktop / headless GNOME / headless KDE). - Connecting: Clients overview, Moonlight, Pairing & Trust. - Configuration: host.env reference, Host CLI, Troubleshooting. - The dev/design notes (architecture, roadmap, the deferred design specs, CI) move to a clearly-separated "Project & Internals" nav section. Removes the superseded box-specific pages (gnome-box, headless-box, linux-setup, overview). status.md (the internal progress tracker, with box IPs) is kept as a file but dropped from the public nav. Site builds clean. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2.3 KiB
title, description
| title | description |
|---|---|
| Host CLI | The punktfunk-host commands and the flags you'll actually use. |
The host is one binary, punktfunk-host. Most of the time you'll run a single command; the rest reads
its settings from host.env.
serve --native
The normal way to run a host. Starts the unified host: the GameStream server (for Moonlight) and
the native punktfunk/1 server, plus the management API/web console — all in one process.
punktfunk-host serve --native
| Flag | Meaning |
|---|---|
--native |
Also run the native punktfunk/1 server (recommended; enables the Apple app and discovery). |
--native-port <PORT> |
Native QUIC port (default 9777). |
--open |
Don't require pairing — serve any device on the network. Off by default; only for trusted single-user setups. |
--mgmt-bind <IP:PORT> |
Management API address (default loopback 127.0.0.1:47990). |
--mgmt-token <TOKEN> |
Bearer token for the management API; required when --mgmt-bind isn't loopback. |
By default the host requires pairing — see Pairing & Trust. Arm pairing from the
web console (or the m3-host flags below for a quick test).
m3-host
A standalone native-only host, mainly for testing the punktfunk/1 path without the GameStream server
or web console.
punktfunk-host m3-host --source virtual
| Flag | Meaning |
|---|---|
--port <N> |
QUIC listen port (default 9777). |
--source virtual |
Use a real virtual display + NVENC (vs. synthetic test frames). |
--max-concurrent <N> |
Stream at most N sessions at once (default 4); overflow waits in the queue. |
--max-sessions <N> |
Exit after N sessions (0 = serve forever). |
--allow-pairing |
Accept PIN pairing; the host prints a PIN when a client pairs. |
--require-pairing |
Only serve paired devices (implies --allow-pairing). |
Both serve --native and m3-host advertise the host on the network so clients can discover it. List
hosts from another machine with punktfunk-client-rs --discover.
Environment
Most behaviour (compositor, video source, input backend, zero-copy) is set in
host.env, not on the command line. When running as a
service, the unit loads host.env for you.