enricobuehlerandClaude Fable 5
6617275387
ci / docs-site (push) Successful in 54s
ci / web (push) Successful in 59s
apple / swift (push) Successful in 1m21s
decky / build-publish (push) Successful in 28s
docker / build-push (--build-arg FEDORA_VERSION=44, ci, ci/fedora-rpm.Dockerfile, punktfunk-fedora44-rpm) (push) Successful in 25s
docker / build-push (., web/Dockerfile, punktfunk-web) (push) Successful in 14s
docker / build-push (ci, ci/fedora-rpm.Dockerfile, punktfunk-fedora-rpm) (push) Successful in 10s
ci / bench (push) Successful in 6m23s
docker / build-push (ci, ci/rust-ci-noble.Dockerfile, punktfunk-rust-ci-noble) (push) Successful in 4m43s
apple / screenshots (push) Successful in 6m18s
docker / build-push (docs-site, docs-site/Dockerfile, punktfunk-docs) (push) Successful in 1m9s
arch / build-publish (push) Successful in 13m44s
deb / build-publish (push) Successful in 13m48s
docker / build-push (ci, ci/rust-ci.Dockerfile, punktfunk-rust-ci) (push) Successful in 7m39s
deb / build-publish-host (push) Successful in 13m11s
docker / deploy-docs (push) Successful in 32s
android / android (push) Successful in 16m23s
rpm / build-publish (43, bazzite, punktfunk-fedora-rpm) (push) Successful in 15m15s
ci / rust (push) Successful in 24m12s
rpm / build-publish (44, fedora-44, punktfunk-fedora44-rpm) (push) Successful in 14m55s
Field triage (Nobara, Discord): the kde.md starter host.env told desktop users to set PUNKTFUNK_COMPOSITOR=kwin, which PINS the backend — detect() short-circuits and the capture-loss rebuild never re-detects — so a mid-stream switch to Game Mode killed the stream instead of following it. A follow-up hardcoded XDG_RUNTIME_DIR=/run/user/1000 anchor broke PipeWire for any non-1000 uid (pw audio connect: Creation failed). Revamp across every starter/example/reference: - Desktop starters (kde/gnome/hyprland/sway) shrink to PUNKTFUNK_VIDEO_SOURCE=virtual + an explicit warning that pinning disables session-following; forcing a backend is CI/appliance-only. - host.env.example: rewritten around auto-detection; anchors demoted to a commented ssh/cron-only block with the uid trap spelled out; the gamescope ATTACH/MANAGED knobs documented (previously missing); case-sensitivity called out. - packaging/bazzite/host.env + README: drop the uid-1000 anchors (a systemctl --user service inherits/derives them); README's stale PUNKTFUNK_COMPOSITOR=gamescope-era template synced to the real one. - packaging/kde/host.env: loud APPLIANCE-ONLY header (it pins on purpose). - configuration.md: session-anchors section inverted to "leave unset", compositor row states the pin consequence, case-sensitivity note. - troubleshooting.md: new "session fails right after editing host.env" section (case, wrong-uid anchors, stale pin, restart-to-apply). - gamescope.md/bazzite.md: attach/managed descriptions match current behavior (managed is the infra-detected default; attach re-modes a box-owned session to the client's resolution). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
102 lines
3.9 KiB
Markdown
102 lines
3.9 KiB
Markdown
---
|
|
title: GNOME (Mutter)
|
|
description: 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](/docs/ubuntu), [Fedora](/docs/fedora), or [Arch](/docs/arch).
|
|
|
|
> New here? Read [Security & Safe Use](/docs/security) first — a streaming host is remote control of
|
|
> the machine, so keep it on a trusted LAN or VPN and require pairing.
|
|
|
|
## host.env
|
|
|
|
The host auto-detects the compositor from your live session on every connect, so the starter
|
|
`~/.config/punktfunk/host.env` is one line:
|
|
|
|
```ini
|
|
# ~/.config/punktfunk/host.env (keys are case-sensitive)
|
|
PUNKTFUNK_VIDEO_SOURCE=virtual
|
|
# GPU zero-copy (dmabuf → CUDA → NVENC) is ON by default; auto-falls back to CPU. Set =0 to force CPU.
|
|
```
|
|
|
|
> **Don't set `PUNKTFUNK_COMPOSITOR`, `WAYLAND_DISPLAY`, or `XDG_CURRENT_DESKTOP` here.** Pinning
|
|
> the compositor turns auto-detection **off** — per connect *and* mid-stream — so the host stops
|
|
> following session switches, and stale session values point it at dead sockets. Forcing a backend
|
|
> is a CI / dedicated-appliance posture, not desktop configuration.
|
|
|
|
You must be on a **Wayland** session (not X11), and Mutter must be **≥ 48**. See the
|
|
[Configuration reference](/docs/configuration) 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:
|
|
|
|
```sh
|
|
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](/docs/ubuntu), [Fedora](/docs/fedora), [Arch](/docs/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:
|
|
|
|
```sh
|
|
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**:
|
|
|
|
```sh
|
|
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](/docs/web-console) to arm pairing and connect a
|
|
[client](/docs/clients). For an always-on box, see the [headless session](#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](/docs/virtual-displays#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:
|
|
|
|
```ini
|
|
# /etc/gdm3/custom.conf (Ubuntu) · /etc/gdm/custom.conf (Fedora)
|
|
[daemon]
|
|
AutomaticLoginEnable = true
|
|
AutomaticLogin = your-user
|
|
```
|
|
|
|
Disable the lock (see [above](#do-not-lock-the-session)), then enable the host user service and let it
|
|
linger past logout:
|
|
|
|
```sh
|
|
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](/docs/running-as-a-service).
|
|
|
|
## Troubleshooting
|
|
|
|
More fixes — black screen, discovery, pairing — in [Troubleshooting](/docs/troubleshooting).
|
|
|
|
Once the host is up, bring the console up and pair — see [The Web Console](/docs/web-console).
|