enricobuehler
cba3ae48e2
apple / swift (push) Successful in 56s
ci / rust (push) Successful in 1m37s
ci / web (push) Successful in 31s
ci / docs-site (push) Successful in 40s
android / android (push) Successful in 3m19s
deb / build-publish (push) Failing after 1m9s
decky / build-publish (push) Successful in 22s
docker / build-push (--build-arg FEDORA_VERSION=44, ci, ci/fedora-rpm.Dockerfile, punktfunk-fedora44-rpm) (push) Successful in 5s
docker / build-push (., web/Dockerfile, punktfunk-web) (push) Successful in 4s
docker / build-push (ci, ci/fedora-rpm.Dockerfile, punktfunk-fedora-rpm) (push) Successful in 3s
docker / build-push (ci, ci/rust-ci.Dockerfile, punktfunk-rust-ci) (push) Successful in 2m21s
ci / bench (push) Successful in 4m45s
docker / build-push (docs-site, docs-site/Dockerfile, punktfunk-docs) (push) Successful in 26s
rpm / build-publish (fedora-44, punktfunk-fedora44-rpm) (push) Failing after 3m22s
docker / deploy-docs (push) Successful in 18s
rpm / build-publish (bazzite, punktfunk-fedora-rpm) (push) Successful in 10m25s
Refresh the README and documentation for public visitors: - README: public-facing rewrite with accurate status for all four native clients (macOS, Linux, Windows, Android) and the Windows host. - docs site: fix stale client status (Android is a full client, not a scaffold; Windows client is stage-1 complete + signed MSIX), add the missing Android client section, correct "which client" guidance. - Windows host: corrected from "deferred/scoped" to implemented & shipping (NVIDIA-only, x64-only) across windows-host, roadmap, status, requirements, running-as-a-service, and the README. - Remove internal infrastructure from public docs (box names, private IPs, SSH/token commands, deploy topology); rewrite status.md as a public project-status page; sanitize ci.md and implementation-plan.md. - Update clients/android and clients/apple READMEs to current state. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
64 lines
3.1 KiB
Markdown
64 lines
3.1 KiB
Markdown
---
|
|
title: Configuration
|
|
description: The host.env settings — compositor, resolution, bitrate, input — and how to tune them.
|
|
---
|
|
|
|
The host reads its settings from **`~/.config/punktfunk/host.env`** (a simple `KEY=value` file). Your
|
|
[setup guide](/docs/requirements) gives you a starting `host.env` for your desktop; this page is the
|
|
reference.
|
|
|
|
## Session settings
|
|
|
|
These tell the host which desktop session to attach to. Your setup guide sets them for you.
|
|
|
|
| Setting | What it does |
|
|
|---|---|
|
|
| `WAYLAND_DISPLAY` | The Wayland socket of your session (`wayland-0` for a normal desktop). |
|
|
| `XDG_CURRENT_DESKTOP` | Your desktop (`GNOME`, `KDE`). |
|
|
| `XDG_RUNTIME_DIR`, `DBUS_SESSION_BUS_ADDRESS` | Needed when the host runs outside your interactive session (e.g. as a service). |
|
|
|
|
## Core settings
|
|
|
|
| Setting | Values | Meaning |
|
|
|---|---|---|
|
|
| `PUNKTFUNK_COMPOSITOR` | `mutter` · `kwin` · `gamescope` · `wlroots` | Which backend creates the virtual display. Match your desktop. |
|
|
| `PUNKTFUNK_VIDEO_SOURCE` | `virtual` · `portal` | `virtual` creates a per-client display at its exact mode (the normal choice). `portal` captures an existing monitor instead. |
|
|
| `PUNKTFUNK_ZEROCOPY` | `1` · `0` | GPU zero-copy capture→encode. Leave on; it falls back to a CPU path automatically. |
|
|
| `PUNKTFUNK_INPUT_BACKEND` | `libei` · `gamescope` · `wlr` · `uinput` | How input is injected. `libei` for GNOME/KDE, `gamescope` for Bazzite. |
|
|
|
|
## Resolution and refresh rate
|
|
|
|
You don't set these on the host — **the client chooses them**. When a device connects, the host
|
|
creates a virtual display at that device's resolution and refresh rate. A 1080p60 laptop and a
|
|
1440p120 desktop each get their own. (With Moonlight, set the mode in Moonlight's settings; the
|
|
native clients let you pick a mode or default to the device's display.)
|
|
|
|
## Bitrate
|
|
|
|
The client requests a bitrate; the host encodes to it. To find a good value for your link:
|
|
|
|
- **Native clients (Apple, Linux, and more):** use the built-in **speed test** (from a host's menu).
|
|
It measures your link, suggests a bitrate, and applies it.
|
|
- **Moonlight:** set the bitrate in Moonlight's settings. Start moderate and raise it.
|
|
|
|
## Multiple devices at once
|
|
|
|
Today the native `punktfunk/1` host (`serve --native`) streams **one session at a time** — additional
|
|
clients wait in the accept queue until the active session ends. Each session gets its own virtual
|
|
display at the client's exact resolution; concurrent native sessions are on the roadmap.
|
|
|
|
(`punktfunk1-host`, the standalone test host, has a `--max-concurrent N` knob, default 4, bounded by your
|
|
GPU's encoder — see the [Host CLI](/docs/host-cli) reference — but `serve --native` does **not** take
|
|
that flag.)
|
|
|
|
## Codec and FEC
|
|
|
|
- The host encodes **HEVC (H.265)** by default; **AV1** is available for clients that support it.
|
|
- The native protocol adds forward error correction for lossy links. `PUNKTFUNK_FEC_PCT=N` sets the
|
|
redundancy percentage (the default is sensible for a normal LAN).
|
|
|
|
## Diagnostics
|
|
|
|
- `PUNKTFUNK_PERF=1` logs per-stage timing (capture, encode, send) — handy when tuning latency.
|
|
- `RUST_LOG=info` (or `debug`) controls log verbosity.
|