docs: restructure host setup by distro, configuration by compositor
apple / swift (push) Successful in 1m8s
apple / screenshots (push) Successful in 5m33s
android / android (push) Successful in 4m43s
arch / build-publish (push) Successful in 5m38s
ci / web (push) Successful in 1m3s
ci / docs-site (push) Successful in 1m17s
ci / rust (push) Successful in 4m48s
ci / bench (push) Successful in 5m7s
decky / build-publish (push) Successful in 14s
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 5s
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 4s
deb / build-publish (push) Successful in 4m29s
docker / build-push (docs-site, docs-site/Dockerfile, punktfunk-docs) (push) Successful in 1m16s
rpm / build-publish (43, bazzite, punktfunk-fedora-rpm) (push) Successful in 10m24s
docker / deploy-docs (push) Successful in 6s
rpm / build-publish (44, fedora-44, punktfunk-fedora44-rpm) (push) Successful in 10m3s
apple / swift (push) Successful in 1m8s
apple / screenshots (push) Successful in 5m33s
android / android (push) Successful in 4m43s
arch / build-publish (push) Successful in 5m38s
ci / web (push) Successful in 1m3s
ci / docs-site (push) Successful in 1m17s
ci / rust (push) Successful in 4m48s
ci / bench (push) Successful in 5m7s
decky / build-publish (push) Successful in 14s
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 5s
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 4s
deb / build-publish (push) Successful in 4m29s
docker / build-push (docs-site, docs-site/Dockerfile, punktfunk-docs) (push) Successful in 1m16s
rpm / build-publish (43, bazzite, punktfunk-fedora-rpm) (push) Successful in 10m24s
docker / deploy-docs (push) Successful in 6s
rpm / build-publish (44, fedora-44, punktfunk-fedora44-rpm) (push) Successful in 10m3s
Split the docs' single distro×desktop axis (ubuntu-gnome / ubuntu-kde / fedora-kde) into two,
which deduplicates the shared mechanics and scales to distros that run several desktops (Arch):
- Install the host — per distro/OS (ubuntu, fedora, arch, bazzite, steamos-host, windows-host):
GPU driver + package + input group, then a canonical "Configure your desktop" funnel.
- Configure your desktop — per compositor (kde, gnome, gamescope, sway): host.env, compositor
quirks, the headless session, and starting the host.
New shared web-console page (enable · login password · arm pairing) removes the console/password
block that was copy-pasted across all seven host pages. Merged ubuntu-gnome + ubuntu-kde into
ubuntu; renamed fedora-kde to fedora; kept bazzite and steamos-host as dedicated appliance guides
(trimmed of duplication). Moved the KWin headless session, the GNOME EGL/lock traps, and the
gamescope attach/managed model out of the distro pages onto their compositor pages.
Fixed while restructuring: distro-specific paths on kde (kde-desktop-setup.sh is Fedora/Bazzite-only;
the .deb ships host.env.kde under /usr/share/punktfunk-host), the interactive "start the host" step
that was lost in the merge, sway over-claiming Hyprland, and a pre-existing broken anchor in
how-it-works.
Removal of the three old pages was captured by the preceding commit 8ebb614 (a concurrent commit
swept up the staged git-rm); the net docs tree is correct. Fumadocs build + internal link/anchor
check green.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -86,9 +86,8 @@ When it finishes it prints the web-console URL and how to pair.
|
||||
|
||||
By default the host **requires PIN pairing** (secure). Two ways to pair:
|
||||
|
||||
- **Web console** (printed at the end of step 2): open `http://<device-ip>:47992`, log in with the
|
||||
generated password (in `~/.config/punktfunk/web.env`), go to **Devices → arm pairing**, and enter
|
||||
the PIN on your client.
|
||||
- **Web console** (printed at the end of step 2): open `http://<device-ip>:47992`,
|
||||
[arm pairing](/docs/web-console#arm-pairing), and enter the PIN on your client.
|
||||
- **From the client directly**: pick this host (it advertises over mDNS as `_punktfunk._udp`) and
|
||||
enter the PIN the host shows.
|
||||
|
||||
@@ -96,17 +95,9 @@ On a trusted home LAN you can instead install with `--open` and skip pairing ent
|
||||
|
||||
### Console login password
|
||||
|
||||
The installer generates a random console login password and writes it to
|
||||
`~/.config/punktfunk/web.env` (as `PUNKTFUNK_UI_PASSWORD=…`); it's also printed at the end of the
|
||||
install run (step 2). Read it back with:
|
||||
|
||||
```sh
|
||||
sed -n 's/^PUNKTFUNK_UI_PASSWORD=//p' ~/.config/punktfunk/web.env
|
||||
```
|
||||
|
||||
To set your own password, edit that file and restart the console:
|
||||
`systemctl --user restart punktfunk-web`. Forgot it? This is the recovery path linked from the
|
||||
console login screen — see [Forgot your Password?](/docs/forgot-password).
|
||||
The installer generates a random console login password (printed at the end of step 2) and writes it
|
||||
to `~/.config/punktfunk/web.env`. To read it back or set your own, see
|
||||
[The Web Console](/docs/web-console#login-password).
|
||||
|
||||
## 4. Verify
|
||||
|
||||
@@ -118,7 +109,8 @@ journalctl --user -u punktfunk-host -f # watch a client connect
|
||||
Connect from a [native client](/docs/clients), or from [Moonlight](/docs/moonlight) (unless you
|
||||
installed with `--no-gamestream`). In Game Mode the host attaches to the running gamescope session and
|
||||
streams it at your client's resolution; in Desktop Mode it streams the KDE desktop. The host
|
||||
auto-detects which session is live per connection.
|
||||
auto-detects which session is live per connection. See [Steam / gamescope](/docs/gamescope) for the
|
||||
attach-vs-managed detail and known limits.
|
||||
|
||||
## Updating
|
||||
|
||||
|
||||
Reference in New Issue
Block a user