enricobuehler
68744d5743
android / android (push) Successful in 4m38s
apple / swift (push) Successful in 58s
windows-host / package (push) Failing after 3m2s
ci / rust (push) Successful in 4m39s
ci / web (push) Successful in 30s
deb / build-publish (push) Successful in 2m4s
decky / build-publish (push) Successful in 22s
ci / bench (push) Successful in 4m39s
ci / docs-site (push) Successful in 31s
docker / build-push (., web/Dockerfile, punktfunk-web) (push) Successful in 16s
docker / build-push (--build-arg FEDORA_VERSION=44, ci, ci/fedora-rpm.Dockerfile, punktfunk-fedora44-rpm) (push) Successful in 3m8s
docker / build-push (ci, ci/fedora-rpm.Dockerfile, punktfunk-fedora-rpm) (push) Successful in 2m29s
docker / build-push (docs-site, docs-site/Dockerfile, punktfunk-docs) (push) Successful in 4s
docker / build-push (ci, ci/rust-ci.Dockerfile, punktfunk-rust-ci) (push) Successful in 2m19s
docker / deploy-docs (push) Has been cancelled
rpm / build-publish (bazzite, punktfunk-fedora-rpm) (push) Failing after 6m52s
rpm / build-publish (fedora-44, punktfunk-fedora44-rpm) (push) Failing after 6m58s
The first CI run failed only on the SudoVDA download: SudoMaker/SudoVDA has no releases (source-only repo; Apollo embeds the driver in its installer), so there was nothing to fetch. Vendor the prebuilt SIGNED driver in-repo instead. - packaging/windows/sudovda/: SudoVDA.inf/.cat/.dll + sudovda.cer (derived from the .cat signer CN=sudovda@su.mk), pulled from the dev-box driver store. v1.10.9.289, Class=Display, HWID Root\SudoMaker\SudoVDA, MIT/CC0. - fetch-sudovda.ps1 -> stage-sudovda.ps1: stage the vendored driver + fetch nefcon from its real pinned release (v1.17.40, sha256 812bae7e…, x64/nefconc.exe). - pack-host-installer.ps1: call stage-sudovda.ps1; README updated with the driver-refresh recipe. The rest of the pipeline already passed on the first run (host built --features nvenc via the llvm-dlltool import lib; ISCC + signtool found; signed with the real CN=unom cert). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
81 lines
4.7 KiB
Markdown
81 lines
4.7 KiB
Markdown
# Windows host packaging — signed Inno Setup installer
|
|
|
|
A one-file, signed `setup.exe` for the punktfunk streaming **host** on Windows, published to Gitea's
|
|
generic package registry (`punktfunk-host-windows`) by `.gitea/workflows/windows-host.yml`.
|
|
|
|
## Why not MSIX (like the client)
|
|
|
|
The host installs a **`LocalSystem` SCM service** that `CreateProcessAsUserW`'s from Session 0 into the
|
|
interactive session for secure-desktop (UAC / lock screen) capture, adds firewall rules, and depends
|
|
on the **SudoVDA** kernel/IDD virtual-display driver. MSIX's sandbox can install **neither** a SYSTEM
|
|
service of this kind **nor** a driver. So the host ships as a classic elevated installer.
|
|
|
|
The installer is deliberately thin: the real install logic — SCM registration, firewall rules, the
|
|
default `host.env`, and the SYSTEM→interactive-session supervisor — already lives in
|
|
`punktfunk-host service install` (`crates/punktfunk-host/src/service.rs`). The installer just lays the
|
|
exe into `C:\Program Files\punktfunk\` and calls that subcommand, elevated.
|
|
|
|
## What the installer does
|
|
|
|
- Installs `punktfunk-host.exe` (+ `host.env.example`, this README) to `{app}` (`C:\Program Files\punktfunk`).
|
|
- **Optional task** *Install the SudoVDA virtual display driver* — imports the driver's self-signed
|
|
cert (machine `Root` + `TrustedPublisher`), creates the `root\sudomaker\sudovda` device node (only
|
|
if absent — `install-sudovda.ps1`), and stages the driver with `pnputil /add-driver /install`.
|
|
Best-effort: a driver failure warns but never aborts the install (the host degrades to a physical
|
|
display without it).
|
|
- Runs `punktfunk-host service install` (idempotent; writes a default `host.env` only if absent, so
|
|
user config survives upgrades) and, by the *Start service now* task, `service start`.
|
|
- **Upgrade:** stops a running `PunktfunkHost` service and waits for `STOPPED` before replacing files
|
|
(otherwise the locked exe / respawning supervisor would block the copy), then re-points the service.
|
|
- **Uninstall** (Add/Remove Programs): runs `service uninstall` (stop + delete service + remove
|
|
firewall rules). The SudoVDA driver is intentionally left installed.
|
|
|
|
Silent install: `punktfunk-host-setup-<ver>.exe /VERYSILENT` (omit the driver with `/MERGETASKS="!installdriver"`).
|
|
|
|
## Prerequisites on the target box
|
|
|
|
- An **NVIDIA GPU + driver** — the installer's exe is built `--features nvenc` and load-depends on the
|
|
driver's `nvEncodeAPI64.dll`.
|
|
- **ViGEmBus** (optional) for virtual gamepads — still a manual prerequisite (not bundled yet):
|
|
<https://github.com/nefarius/ViGEmBus/releases>.
|
|
|
|
## Files here
|
|
|
|
| File | Role |
|
|
|------|------|
|
|
| `punktfunk-host.iss` | Inno Setup script (the installer definition). |
|
|
| `pack-host-installer.ps1` | Orchestrator: cert + sign, stage the driver bundle, run ISCC, sign setup.exe, emit registry paths. |
|
|
| `stage-sudovda.ps1` | Stage the **vendored** SudoVDA driver + fetch/verify the **pinned** nefcon release into the bundle. |
|
|
| `install-sudovda.ps1` | Runs at install time (elevated): trust cert → gated device-node create → `pnputil` install. |
|
|
| `sudovda/` | **Vendored** prebuilt SudoVDA driver: `SudoVDA.inf` / `sudovda.cat` / `SudoVDA.dll` / `sudovda.cer`. |
|
|
| `nvenc/nvenc.def`, `nvenc/gen-nvenc-importlib.ps1` | Synthesise `nvencodeapi.lib` for the `--features nvenc` link (llvm-dlltool / lib.exe). |
|
|
|
|
> **Vendored driver:** SudoVDA has no upstream release (its repo is a source-only VS solution; Apollo
|
|
> embeds the driver in its own installer), so the prebuilt **signed** driver is checked in under
|
|
> `sudovda/` (MIT/CC0; v1.10.9.289, signer `CN=sudovda@su.mk`, Class=Display, HWID
|
|
> `Root\SudoMaker\SudoVDA`). To refresh it, copy the four files out of a box's driver store
|
|
> (`C:\Windows\System32\DriverStore\FileRepository\sudovda.inf_amd64_*`) and re-derive `sudovda.cer`
|
|
> from the `.cat` signer (`(Get-AuthenticodeSignature sudovda.cat).SignerCertificate | Export-Certificate`).
|
|
> nefcon (the device-node tool) **is** fetched + SHA-256-verified from its pinned release in
|
|
> `stage-sudovda.ps1`.
|
|
|
|
## Build locally (Windows, MSVC + Windows SDK + Inno Setup)
|
|
|
|
```powershell
|
|
# 1. import lib for the nvenc link
|
|
pwsh -File packaging\windows\nvenc\gen-nvenc-importlib.ps1 -OutDir C:\t\nvenc
|
|
$env:PUNKTFUNK_NVENC_LIB_DIR = 'C:\t\nvenc'
|
|
|
|
# 2. build the host
|
|
cargo build --release -p punktfunk-host --features nvenc
|
|
|
|
# 3. pack (self-signed unless MSIX_CERT_PFX_B64/MSIX_CERT_PASSWORD are set; -NoDriver to skip SudoVDA)
|
|
pwsh -File packaging\windows\pack-host-installer.ps1 -Version 0.0.0-dev -TargetDir C:\t\release -OutDir C:\t\out
|
|
```
|
|
|
|
## Release
|
|
|
|
Push a `host-win-vX.Y.Z` tag — the workflow builds, signs, and publishes
|
|
`punktfunk-host-setup-X.Y.Z.exe` + the public `.cer`, and refreshes the `latest/` alias. Main pushes
|
|
publish rolling `0.2.<run>` builds (no `latest/` update).
|