feat(packaging): Fedora/Bazzite packaging — COPR RPM, bootc image, gamescope-default config

Roadmap #3 (install on other devices). Bazzite already ships gamescope + PipeWire + the NVIDIA stack, so the host slots in with minimal new deps (ffmpeg-libs from RPM Fusion + opus + libei). - packaging/rpm/punktfunk.spec — builds punktfunk-host from source (cargo), installs the binary + udev rule + systemd user unit + headless helpers; Requires/Recommends mapped from the Ubuntu bootstrap deps to Fedora. - packaging/bootc/Containerfile — layer punktfunk into a bazzite-nvidia bootc image for atomic, image-based installs. - packaging/bazzite/host.env — gamescope-default appliance config (spawned per session). - packaging/copr/ + packaging/README.md — COPR build-from-SCM settings + install docs (rpm-ostree and bootc paths), and why not Flatpak. - LICENSE-MIT + LICENSE-APACHE — materialize the declared `MIT OR Apache-2.0` (was unfiled); the RPM ships them. Not buildable on the Ubuntu dev box (no rpm tooling) — the COPR/Fedora build is operator-run; all spec-referenced files verified present and the cargo build is green. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-10 22:29:01 +00:00
parent 0755c823a5
commit 23bb814bac
7 changed files with 527 additions and 0 deletions
@@ -0,0 +1,80 @@
+# Packaging punktfunk for Fedora / Bazzite
+
+The punktfunk host is Linux-only and links system FFmpeg (NVENC), PipeWire, Opus and
+the NVIDIA driver. This directory packages it for the **Fedora Atomic / Bazzite** world
+(rpm-ostree + bootc), where most of those deps are already present.
+
+```
+packaging/
+  rpm/punktfunk.spec      # the RPM (builds punktfunk-host from source with cargo)
+  bazzite/host.env        # gamescope-default config for a Bazzite appliance
+  bootc/Containerfile     # bake punktfunk into a Bazzite-based atomic image
+  copr/                   # COPR build-from-SCM settings
+```
+
+## What's needed beyond base Fedora
+
+| Dependency | Where it comes from |
+|---|---|
+| `ffmpeg-libs` with **NVENC** | **RPM Fusion nonfree** (`ffmpeg`, not `ffmpeg-free`) |
+| NVIDIA driver (`libnvidia-encode`, `libEGL_nvidia`) | Bazzite **-nvidia** images ship it; plain Fedora: `akmod-nvidia` + `xorg-x11-drv-nvidia-cuda` |
+| gamescope, PipeWire, wireplumber | **Bazzite ships these**; plain Fedora: `dnf install gamescope pipewire wireplumber` |
+| `opus`, `libei` | Fedora base / updates |
+
+On **Bazzite** the only genuinely new runtime bits are `ffmpeg-libs` (RPM Fusion) + `opus` +
+`libei` — the rest of the stack is already there. The default backend is **gamescope**
+(`packaging/bazzite/host.env`), which the host spawns headless per session — no desktop login.
+
+## Option A — COPR (per-host, `rpm-ostree install`)
+
+1. Create a COPR project, enable **build-from-SCM** pointing at this repo, spec path
+   `packaging/rpm/punktfunk.spec` (see `copr/README.md`). Under *External Repositories* add
+   RPM Fusion nonfree so `ffmpeg-devel` resolves at build time.
+2. On the Bazzite host:
+   ```sh
+   # RPM Fusion (for the NVENC ffmpeg) — usually already enabled on Bazzite
+   rpm-ostree install \
+     https://mirrors.rpmfusion.org/free/fedora/rpmfusion-free-release-$(rpm -E %fedora).noarch.rpm \
+     https://mirrors.rpmfusion.org/nonfree/fedora/rpmfusion-nonfree-release-$(rpm -E %fedora).noarch.rpm
+   # enable the COPR + install punktfunk
+   sudo wget -O /etc/yum.repos.d/_copr_punktfunk.repo \
+     https://copr.fedorainfracloud.org/coprs/enricobuehler/punktfunk/repo/fedora-$(rpm -E %fedora)/
+   rpm-ostree install punktfunk
+   systemctl reboot
+   ```
+
+## Option B — bootc (image-based, atomic)
+
+Layer punktfunk into a Bazzite image once, then rebase any number of hosts onto it — no
+per-host drift. See `bootc/Containerfile`:
+```sh
+podman build -t ghcr.io/<you>/bazzite-punktfunk -f packaging/bootc/Containerfile .
+podman push  ghcr.io/<you>/bazzite-punktfunk
+# on the target:
+sudo bootc switch ghcr.io/<you>/bazzite-punktfunk && systemctl reboot
+```
+
+## First-run setup (either option)
+
+```sh
+sudo usermod -aG input "$USER"          # virtual gamepads need /dev/uinput (then re-login)
+mkdir -p ~/.config/punktfunk
+cp /usr/share/punktfunk/host.env.bazzite ~/.config/punktfunk/host.env   # edit (gamescope app, etc.)
+systemctl --user enable --now punktfunk-host
+```
+
+Pair a stock Moonlight client (mDNS-discovered), or connect the native punktfunk/1 client.
+
+## Why not Flatpak?
+
+The host needs unsandboxed access the zero-copy NVENC path, `/dev/uinput`, the PipeWire
+graph and the compositor's privileged protocols — a Flatpak sandbox fights all of these.
+An RPM (or the bootc layer) installs into the host system where those just work.
+
+## Building the SRPM/RPM locally (Fedora only)
+
+```sh
+git archive --format=tar.gz --prefix=punktfunk-0.0.1/ -o ~/rpmbuild/SOURCES/punktfunk-0.0.1.tar.gz HEAD
+rpmbuild -ba packaging/rpm/punktfunk.spec     # needs the BuildRequires from the spec
+```
+(Not buildable on Debian/Ubuntu — use a Fedora toolbox/container or COPR.)
@@ -0,0 +1,26 @@
+# punktfunk host config for Bazzite (~/.config/punktfunk/host.env).
+#
+# Bazzite ships gamescope, PipeWire and the NVIDIA driver, so the default backend here is
+# gamescope: the host spawns a headless gamescope per session at the client's exact mode and
+# captures its PipeWire node — no separate desktop session to bring up. Set PUNKTFUNK_GAMESCOPE_APP
+# to what you want to run inside it (e.g. `steam -gamepadui` for a SteamOS-like couch session).
+
+XDG_RUNTIME_DIR=/run/user/1000
+DBUS_SESSION_BUS_ADDRESS=unix:path=/run/user/1000/bus
+
+# gamescope backend: spawned per session, no compositor login required.
+PUNKTFUNK_COMPOSITOR=gamescope
+PUNKTFUNK_VIDEO_SOURCE=virtual
+PUNKTFUNK_GAMESCOPE_APP=steam -gamepadui
+
+# gamescope hosts its own EIS input socket — input lands in the nested session.
+PUNKTFUNK_INPUT_BACKEND=gamescope
+
+# GPU zero-copy capture (dmabuf -> CUDA -> NVENC). Auto-falls back to CPU if unavailable.
+PUNKTFUNK_ZEROCOPY=1
+
+#RUST_LOG=info
+
+# To drive the full Plasma/GNOME desktop instead of a nested gamescope, switch to:
+#   PUNKTFUNK_COMPOSITOR=kwin    (and run inside a KDE session — WAYLAND_DISPLAY/XDG_CURRENT_DESKTOP set)
+#   PUNKTFUNK_INPUT_BACKEND=libei
@@ -0,0 +1,39 @@
+# bootc / OCI image layer that bakes punktfunk into a Bazzite-based atomic image.
+#
+# Bazzite is already a bootc image (Fedora Atomic + gamescope + PipeWire + the NVIDIA
+# stack), so we layer punktfunk on top: enable RPM Fusion (for the NVENC ffmpeg) and our
+# COPR, install the package, and pre-enable the udev rule. Build + push this image, then
+# `bootc switch` (or rebase) a Bazzite host onto it for an image-based, atomic install —
+# no per-host `rpm-ostree install` drift.
+#
+#   podman build -t ghcr.io/<you>/bazzite-punktfunk -f packaging/bootc/Containerfile .
+#   podman push  ghcr.io/<you>/bazzite-punktfunk
+#   # on the target Bazzite host:
+#   sudo bootc switch ghcr.io/<you>/bazzite-punktfunk   # then reboot
+#
+# Pick the base tag that matches your hardware (NVIDIA shown). See ublue-os/bazzite tags.
+ARG BASE_IMAGE=ghcr.io/ublue-os/bazzite-nvidia:stable
+FROM ${BASE_IMAGE}
+
+# COPR project that hosts the punktfunk RPM (see packaging/copr/README). Override at build.
+ARG PUNKTFUNK_COPR=enricobuehler/punktfunk
+
+# RPM Fusion nonfree provides the NVENC-capable ffmpeg-libs punktfunk records/encodes with.
+# (Bazzite usually has RPM Fusion enabled already; this is belt-and-suspenders.)
+RUN dnf5 -y install \
+        https://mirrors.rpmfusion.org/free/fedora/rpmfusion-free-release-$(rpm -E %fedora).noarch.rpm \
+        https://mirrors.rpmfusion.org/nonfree/fedora/rpmfusion-nonfree-release-$(rpm -E %fedora).noarch.rpm \
+    || true
+
+# Enable our COPR and install punktfunk.
+RUN dnf5 -y copr enable ${PUNKTFUNK_COPR} && \
+    dnf5 -y install punktfunk && \
+    dnf5 -y copr disable ${PUNKTFUNK_COPR} && \
+    dnf5 clean all
+
+# The udev rule + systemd *user* unit ship in the RPM; nothing else to enable at image
+# build time (the host runs per-user in the graphical session, enabled with
+# `systemctl --user enable --now punktfunk-host` after first boot).
+
+# bootc image hygiene: the container build must leave a clean ostree commit.
+RUN ostree container commit
@@ -0,0 +1,35 @@
+# COPR build-from-SCM settings
+
+COPR builds the RPM from this git repo (no manual SRPM upload). Configure the project
+once in the COPR web UI (or with `copr-cli`):
+
+**Project → New Build → SCM**
+- Clone URL:      `https://git.unom.io/unom/punktfunk`
+- Committish:     `main` (or a release tag)
+- Subdirectory:   *(repo root)*
+- Spec File:      `packaging/rpm/punktfunk.spec`
+- Source build method: `rpkg` (or `make_srpm`)
+
+**Project settings**
+- Chroots: `fedora-41-x86_64`, `fedora-42-x86_64` (match your Bazzite Fedora base;
+  `rpm -E %fedora` on the host tells you which). Add `aarch64` if needed.
+- External repositories (so `ffmpeg-devel` resolves at build time):
+  `https://mirrors.rpmfusion.org/nonfree/fedora/rpmfusion-nonfree-release-$releasever.noarch.rpm`
+  and the matching `-free-` repo.
+- Enable network during build (cargo fetches crates from crates.io) — COPR allows this by
+  default.
+
+`copr-cli` equivalent:
+
+```sh
+copr-cli create punktfunk --chroot fedora-42-x86_64 \
+  --repo 'https://mirrors.rpmfusion.org/free/fedora/rpmfusion-free-release-$releasever.noarch.rpm' \
+  --repo 'https://mirrors.rpmfusion.org/nonfree/fedora/rpmfusion-nonfree-release-$releasever.noarch.rpm'
+copr-cli buildscm punktfunk \
+  --clone-url https://git.unom.io/unom/punktfunk \
+  --commit main --spec packaging/rpm/punktfunk.spec --method rpkg
+```
+
+Note: COPR caps build time/RAM; a full `cargo build --release` of the host (FFmpeg/PipeWire
+sys-crates + aws-lc-rs) is heavy but within the default COPR limits. If a chroot OOMs, lower
+parallelism with `CARGO_BUILD_JOBS` in the spec's `%build`.
@@ -0,0 +1,125 @@
+################################################################################
+# punktfunk — low-latency desktop/game streaming host (RPM for Fedora / Bazzite)
+#
+# Builds `punktfunk-host` from source with cargo and installs the binary, the
+# uinput udev rule (virtual gamepads), the systemd *user* unit, and the headless
+# session helpers. Designed for COPR (build-from-SCM): COPR clones the repo and
+# runs this spec; `cargo build` fetches crates over the network (COPR allows it).
+#
+# DEPENDENCIES NOT IN BASE FEDORA:
+#   * ffmpeg / ffmpeg-libs with NVENC — from RPM Fusion *nonfree*. Enable it in
+#     the COPR project (External Repositories) and on the target host.
+#   * The NVIDIA driver (libnvidia-encode / libEGL_nvidia) — present on Bazzite's
+#     -nvidia images; on plain Fedora install akmod-nvidia + xorg-x11-drv-nvidia-cuda.
+#
+# Bazzite already ships gamescope, PipeWire and the NVIDIA stack, so on Bazzite the
+# only new runtime bits are ffmpeg-libs (RPM Fusion) + opus + libei.
+################################################################################
+
+Name:           punktfunk
+Version:        0.0.1
+Release:        1%{?dist}
+Summary:        Low-latency desktop/game streaming host (Moonlight-compatible + punktfunk/1)
+
+License:        MIT OR Apache-2.0
+URL:            https://git.unom.io/unom/punktfunk
+# COPR SCM builds provide the checkout; for a tarball build, drop a git archive here:
+Source0:        %{name}-%{version}.tar.gz
+
+# punktfunk-host is Linux-only and links system FFmpeg/PipeWire/Opus.
+ExclusiveArch:  x86_64 aarch64
+
+# --- Build toolchain ---------------------------------------------------------
+BuildRequires:  cargo
+BuildRequires:  rust
+BuildRequires:  gcc
+BuildRequires:  gcc-c++
+BuildRequires:  clang
+BuildRequires:  clang-devel
+BuildRequires:  cmake
+BuildRequires:  nasm
+BuildRequires:  pkgconfig
+BuildRequires:  systemd-rpm-macros
+# Link-time system libraries (the -sys crates probe these via pkg-config):
+BuildRequires:  pkgconfig(libpipewire-0.3)
+BuildRequires:  pkgconfig(libspa-0.2)
+BuildRequires:  pkgconfig(wayland-client)
+BuildRequires:  pkgconfig(xkbcommon)
+BuildRequires:  pkgconfig(opus)
+# FFmpeg dev headers with NVENC — from RPM Fusion (ffmpeg-devel), NOT ffmpeg-free.
+BuildRequires:  pkgconfig(libavcodec)
+BuildRequires:  pkgconfig(libavformat)
+BuildRequires:  pkgconfig(libavutil)
+
+# --- Runtime -----------------------------------------------------------------
+Requires:       pipewire
+Requires:       pipewire-pulseaudio
+Requires:       wireplumber
+Requires:       opus
+Requires:       libei
+# FFmpeg runtime with NVENC (RPM Fusion). Weak-dep so the package installs even if
+# the user hasn't enabled RPM Fusion yet, but it WILL fail to encode without it.
+Recommends:     ffmpeg-libs
+# A compositor to drive. Bazzite ships gamescope; the others are user choice.
+Recommends:     gamescope
+Suggests:       kwin
+Suggests:       mutter
+# NVENC + GPU EGL come from the NVIDIA driver; on Bazzite the -nvidia image has it.
+Recommends:     (xorg-x11-drv-nvidia-cuda if xorg-x11-drv-nvidia)
+
+%description
+punktfunk is a Linux-first, low-latency desktop and game streaming host. It speaks
+the Moonlight/GameStream protocol (pair a stock Moonlight client) and its own native
+punktfunk/1 protocol (GF(2^16) Leopard FEC + AES-GCM, mid-stream mode renegotiation,
+client microphone passthrough). Each session gets a virtual output at the client's
+exact resolution and refresh via a per-compositor backend (KWin, gamescope, Mutter,
+Sway/wlroots), captured zero-copy (dmabuf -> CUDA -> NVENC) and split-encoded above
+~1 Gpix/s. Input (mouse/keyboard/gamepads) is injected back into the session.
+
+%prep
+%autosetup -n %{name}-%{version}
+
+%build
+# Release build of the host binary only (the workspace also has the core lib + clients).
+# cargo fetches crates over the network; COPR build hosts allow this.
+export RUSTFLAGS="%{?build_rustflags}"
+cargo build --release -p punktfunk-host
+
+%install
+# Binary
+install -Dm0755 target/release/punktfunk-host %{buildroot}%{_bindir}/punktfunk-host
+
+# udev rule — /dev/uinput access for virtual gamepads (input group).
+install -Dm0644 scripts/60-punktfunk.rules %{buildroot}%{_udevrulesdir}/60-punktfunk.rules
+
+# systemd *user* unit (the host runs in the graphical session, not as root).
+install -Dm0644 scripts/punktfunk-host.service %{buildroot}%{_userunitdir}/punktfunk-host.service
+
+# Headless session helpers + example config + OpenAPI doc (reference material).
+install -d %{buildroot}%{_datadir}/%{name}/headless
+install -Dm0755 scripts/headless/run-headless-kde.sh   %{buildroot}%{_datadir}/%{name}/headless/run-headless-kde.sh
+install -Dm0755 scripts/headless/run-headless-sway.sh  %{buildroot}%{_datadir}/%{name}/headless/run-headless-sway.sh
+install -Dm0644 scripts/host.env.example               %{buildroot}%{_datadir}/%{name}/host.env.example
+install -Dm0644 packaging/bazzite/host.env             %{buildroot}%{_datadir}/%{name}/host.env.bazzite
+install -Dm0644 docs/api/openapi.json                  %{buildroot}%{_datadir}/%{name}/openapi.json
+
+%files
+%license LICENSE-MIT LICENSE-APACHE
+%doc README.md docs/implementation-plan.md packaging/README.md
+%{_bindir}/punktfunk-host
+%{_udevrulesdir}/60-punktfunk.rules
+%{_userunitdir}/punktfunk-host.service
+%dir %{_datadir}/%{name}
+%{_datadir}/%{name}/*
+
+%post
+# Reload udev so /dev/uinput picks up the new rule without a reboot (best-effort).
+udevadm control --reload-rules 2>/dev/null || :
+udevadm trigger --subsystem-match=misc 2>/dev/null || :
+echo "punktfunk installed. Add yourself to the 'input' group (sudo usermod -aG input \$USER)"
+echo "then enable the host: systemctl --user enable --now punktfunk-host"
+echo "Config: cp %{_datadir}/%{name}/host.env.bazzite ~/.config/punktfunk/host.env"
+
+%changelog
+* Tue Jun 10 2026 punktfunk <noreply@anthropic.com> - 0.0.1-1
+- Initial RPM: punktfunk-host + udev rule + systemd user unit + headless helpers.