enricobuehler
ef39050dbc
Six parallel audits swept the root docs, docs-site, every per-directory README, and the packaging docs; every claim below was verified against the source before editing. - README: Layout gains the six missing crates (pf-client-core, pf-presenter, pf-console-ui, pf-ffvk, pf-driver-proto, punktfunk-tray), clients/session, api/ and ci/; Linux/Windows client rows reflect the shell + Vulkan-session split and the Vulkan Video -> VAAPI/D3D11VA -> software decode chains; the "every client over a C ABI" claim is corrected (Rust clients link the core directly); tiered stats overlay + console shell noted; Apple row mentions AV1. - CONTRIBUTING: drop the dead CLAUDE.md link (deliberately untracked); point at the README's build/invariants sections. SECURITY: 0.9.0. - host-cli/pairing: --allow-pairing/--require-pairing are no-op legacy names — pairing is required by default, --allow-tofu is the real flag; document --data-port and --idle-timeout-ms. - configuration: document PUNKTFUNK_RECOVER_SESSION_CMD (session-crash recovery hook), PUNKTFUNK_MDNS, PUNKTFUNK_DATA_PORT. - virtual-displays/gnome: GNOME per-client scaling shipped (host- persisted) — flip the ❌ to ✅ and describe how it works. - stats: new "Detail levels" section (Off/Compact/Normal/Detailed + per-platform cycle gestures); retire the GTK hand-off note. - clients/install-client/status/roadmap: decode chains, Windows client validation narrowed to HDR-only pending, adaptive bitrate, console shell, Apple AV1, Windows host vendor list. - Sub-READMEs: clients/linux rewritten for the re-architecture; session Windows decode rung + d3d11va knob; Windows tiered overlay; Android minSdk 28; decky file table; host zerocopy/ path; scripts port 47992 and steamos-host.md; pf-dualsense source path. - packaging: canary version bases are tag-derived (<next-minor> via pf-version.sh/.ps1), codecs-extra not ffmpeg-full, document the pinned offline-Skia tarball + SKIA_BINARIES_URL and vulkan-headers. - Convert 15 dangling design/*.md links to the punktfunk-planning prose convention (those docs live in the private planning repo). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
3.7 KiB
title, description
| title | description |
|---|---|
| GNOME (Mutter) | Configure a punktfunk host for GNOME — host.env, the EGL/lock traps, and a headless session. |
Configure a host running GNOME. The host drives GNOME's Mutter compositor to create a per-client
virtual display over D-Bus (RecordVirtual), zero-copy. This page assumes the host is already
installed — see Ubuntu, Fedora, or Arch.
New here? Read Security & Safe Use first — a streaming host is remote control of the machine, so keep it on a trusted LAN or VPN and require pairing.
host.env
Write ~/.config/punktfunk/host.env with the GNOME settings. The host auto-detects the compositor
from your session, so the explicit PUNKTFUNK_COMPOSITOR is belt-and-braces:
# ~/.config/punktfunk/host.env
WAYLAND_DISPLAY=wayland-0
XDG_CURRENT_DESKTOP=GNOME
PUNKTFUNK_COMPOSITOR=mutter
PUNKTFUNK_VIDEO_SOURCE=virtual
# GPU zero-copy (dmabuf → CUDA → NVENC) is ON by default; auto-falls back to CPU. Set =0 to force CPU.
PUNKTFUNK_INPUT_BACKEND=libei
You must be on a Wayland session (not X11), and Mutter must be ≥ 48. See the Configuration reference for every option.
The GL/EGL userspace
On NVIDIA, gnome-shell fails to start — or the host logs "GPU … not supported by EGL" — when the
NVIDIA GL/EGL userspace is missing. The base driver package doesn't always pull it in. Install your
distro's NVIDIA GL/EGL userspace package — on Ubuntu/Debian it's libnvidia-gl-<version> matching
your driver; on Fedora/Arch it ships with the RPM Fusion / repo driver — then confirm the glvnd
vendor file exists:
ls /usr/share/glvnd/egl_vendor.d/10_nvidia.json # must exist
Installing the driver itself is covered on your distro's install page (Ubuntu, Fedora, Arch).
Do not lock the session
A locked GNOME session blocks screen capture — the host fails with "Session creation inhibited". On an always-on or headless host there's no one to unlock it, so disable the lock:
gsettings set org.gnome.desktop.screensaver lock-enabled false
gsettings set org.gnome.desktop.session idle-delay 0
Start the host
With host.env in place, start the host from inside your GNOME session:
systemctl --user enable --now punktfunk-host
journalctl --user -u punktfunk-host -f # watch it come up and print its identity fingerprint
Then bring up The Web Console to arm pairing and connect a client. For an always-on box, see the headless session below.
Display scaling you set while streaming sticks per client: the host remembers each device's scale and reapplies it on reconnect — see Persistent scaling.
Headless session
To run with no monitor and no login, keep a GNOME Wayland session up at all times and start the host without a login. Have GDM auto-login your user:
# /etc/gdm3/custom.conf (Ubuntu) · /etc/gdm/custom.conf (Fedora)
[daemon]
AutomaticLoginEnable = true
AutomaticLogin = your-user
Disable the lock (see above), then enable the host user service and let it linger past logout:
systemctl --user enable --now punktfunk-host
sudo loginctl enable-linger "$USER"
Reboot and the host comes up on the auto-login session. Full walkthrough: Running as a Service.
Troubleshooting
More fixes — black screen, discovery, pairing — in Troubleshooting.
Once the host is up, bring the console up and pair — see The Web Console.