Self-healing headless, working JARVIS install fixes, public-safe docs
This bundles every fix we made debugging the first real install plus a comprehensive troubleshooting reference. Working tree is now PII-safe for public distribution: hostname-based default mode is driven by a HEADLESS_HOSTS env var instead of a hardcoded literal; docs use placeholders for hostnames and LAN IPs. Self-healing headless management - bin/sunshine-prestart.sh (new): runs as systemd ExecStartPre. Resolves the Hyprland instance signature from XDG_RUNTIME_DIR/hypr when systemd-user env didn't propagate it. Reduces to exactly one headless output by keeping the lowest-numbered HEADLESS-N and removing the rest. Rewrites the managed sunshine.conf's output_name line to match the surviving name — Hyprland's HEADLESS-N counter is monotonic and ignores the optional name argument to 'output create headless', so without active sync output_name drifts off HEADLESS-1 after the first restart cycle. - bin/sunshine-stream-do.sh: dropped the hardcoded MON=HEADLESS-1. Now discovers whatever HEADLESS-* exists via jq. Resize and workspace migration target the actual output. - bin/sunshine-stream-undo.sh: reads the headless name from a state file the do-script wrote, with discovery fallback. Stops removing the output between sessions — the create/destroy race caused fatal startup encoder errors on the next Sunshine restart. - files/headless-prestart.conf, files/sunshine.service: ExecStartPre now points at the new prestart script. - lib/headless.sh: install_headless_hooks now installs all three scripts. New install_headless_prestart_dropin resolves the actual systemd unit name (sunshine.service vs app-dev.lizardbyte.app.Sunshine.service) and lands the drop-in under <unit>.service.d/. Firewall detection - lib/firewall.sh: _ufw_active now uses 'systemctl is-active ufw.service' instead of 'ufw status'. The latter requires root to read /etc/ufw state, so the unprivileged probe returned false and we silently skipped opening Sunshine's ports on hosts where ufw was actively dropping packets. Service unit fallbacks - lib/service.sh: ensure_sunshine_unit_present looks for sunshine.service in every systemd-user path first; falls back to the reverse-DNS AUR-source unit name; last resort drops a repo-provided fallback unit. systemctl reset-failed before each restart so a previous start-limit-hit doesn't immediately reject the new attempt. Preflight - lib/preflight.sh: new preflight_headless step that, only when STREAM_MODE is headless, surfaces missing hyprctl / jq / Hyprland reachability before install proceeds. Public-safe defaults - install.sh: streaming-mode default is now driven by HEADLESS_HOSTS env var (comma-separated, case-insensitive). Unset by default — every host gets mirror mode unless its hostname is listed or --headless is passed explicitly. Past versions hardcoded a specific hostname. - README.md: replaced JARVIS-specific examples with HEADLESS_HOSTS prose. Docs - docs/TROUBLESHOOTING.md (new): comprehensive failure-mode reference. Every issue hit during the first end-to-end install, in order, with symptom → cause → fix → permanent prevention. Plus a "Custom keybinding to escape Moonlight" section and an outstanding-followups punch list (1Password black-rectangle workarounds, hypridle inhibit during stream, busiest- workspace auto-switch, jarvis.lan DNS, 1Password SSH agent timeouts).
This commit is contained in:
81
bin/sunshine-prestart.sh
Executable file
81
bin/sunshine-prestart.sh
Executable file
@@ -0,0 +1,81 @@
|
||||
#!/usr/bin/env bash
|
||||
# Runs as a systemd ExecStartPre for the Sunshine service. Two jobs:
|
||||
# 1. Make sure exactly one Hyprland headless output exists.
|
||||
# 2. Sync sunshine.conf's `output_name` to whatever the headless output is
|
||||
# currently named — Hyprland's HEADLESS-N counter doesn't reset across
|
||||
# session restarts, so pinning to HEADLESS-1 drifts after the first
|
||||
# remove/create cycle.
|
||||
#
|
||||
# Non-fatal at every step: a stale state can't worsen things by aborting here.
|
||||
|
||||
set -uo pipefail
|
||||
|
||||
log() { printf '[sunshine-prestart] %s\n' "$*" >&2; }
|
||||
|
||||
CONF="$HOME/.config/sunshine/sunshine.conf"
|
||||
|
||||
# Recover Hyprland's instance signature when the unit's env didn't propagate it.
|
||||
if [[ -z "${HYPRLAND_INSTANCE_SIGNATURE:-}" ]]; then
|
||||
for sig in "${XDG_RUNTIME_DIR:-/run/user/$(id -u)}"/hypr/*/; do
|
||||
[[ -d "$sig" ]] || continue
|
||||
export HYPRLAND_INSTANCE_SIGNATURE="$(basename "$sig")"
|
||||
break
|
||||
done
|
||||
fi
|
||||
if [[ -z "${HYPRLAND_INSTANCE_SIGNATURE:-}" ]]; then
|
||||
log "Hyprland not running; nothing to prepare."
|
||||
exit 0
|
||||
fi
|
||||
|
||||
if ! command -v hyprctl >/dev/null || ! command -v jq >/dev/null; then
|
||||
log "hyprctl/jq missing; skipping prestart."
|
||||
exit 0
|
||||
fi
|
||||
|
||||
# Reduce to exactly one headless output. Hyprland's HEADLESS-N counter
|
||||
# increments on every create and never decrements, so previous failed runs
|
||||
# leave extras laying around. Remove all but the lowest-numbered one (most
|
||||
# likely to be the one with workspaces bound to it).
|
||||
mapfile -t headless_outputs < <(hyprctl monitors -j 2>/dev/null \
|
||||
| jq -r '.[] | select(.name | startswith("HEADLESS")) | .name' \
|
||||
| sort -V)
|
||||
existing="${headless_outputs[0]:-}"
|
||||
|
||||
if [[ -z "$existing" ]]; then
|
||||
log "No headless output present; creating one"
|
||||
hyprctl output create headless >/dev/null
|
||||
for _ in 1 2 3 4 5; do
|
||||
existing="$(hyprctl monitors -j 2>/dev/null \
|
||||
| jq -r '.[] | select(.name | startswith("HEADLESS")) | .name' \
|
||||
| sort -V | head -1)"
|
||||
[[ -n "$existing" ]] && break
|
||||
sleep 0.1
|
||||
done
|
||||
elif [[ ${#headless_outputs[@]} -gt 1 ]]; then
|
||||
log "Found ${#headless_outputs[@]} headless outputs; keeping $existing, removing the rest"
|
||||
for extra in "${headless_outputs[@]:1}"; do
|
||||
hyprctl output remove "$extra" >/dev/null 2>&1 || true
|
||||
done
|
||||
fi
|
||||
|
||||
if [[ -z "$existing" ]]; then
|
||||
log "Failed to obtain a headless output; Sunshine will start without one."
|
||||
exit 0
|
||||
fi
|
||||
log "Headless output present: $existing"
|
||||
|
||||
# Sync sunshine.conf's output_name. Only touch the file if it's our managed
|
||||
# variant (has the management marker) AND the line has actually drifted.
|
||||
if [[ -f "$CONF" ]] && grep -qF '# managed-by: omarchy-moonlight' "$CONF"; then
|
||||
current="$(awk '/^output_name = / {print $3; exit}' "$CONF" 2>/dev/null || true)"
|
||||
if [[ "$current" != "$existing" ]]; then
|
||||
log "Updating sunshine.conf output_name: ${current:-(unset)} -> $existing"
|
||||
if grep -q '^output_name = ' "$CONF"; then
|
||||
sed -i "s|^output_name = .*|output_name = $existing|" "$CONF"
|
||||
else
|
||||
printf '\noutput_name = %s\n' "$existing" >> "$CONF"
|
||||
fi
|
||||
fi
|
||||
fi
|
||||
|
||||
exit 0
|
||||
@@ -14,7 +14,6 @@ log() { printf '[sunshine-do] %s\n' "$*" >&2; }
|
||||
WIDTH="${SUNSHINE_CLIENT_WIDTH:-1920}"
|
||||
HEIGHT="${SUNSHINE_CLIENT_HEIGHT:-1080}"
|
||||
FPS="${SUNSHINE_CLIENT_FPS:-60}"
|
||||
MON="HEADLESS-1"
|
||||
STATE_DIR="${XDG_RUNTIME_DIR:-/tmp}/sunshine-headless"
|
||||
mkdir -p "$STATE_DIR"
|
||||
|
||||
@@ -43,16 +42,26 @@ hyprctl monitors -j > "$STATE_DIR/prev-monitors.json" 2>/dev/null || true
|
||||
PREV_WS="$(hyprctl activeworkspace -j 2>/dev/null | jq -r '.id // 1' || echo 1)"
|
||||
echo "$PREV_WS" > "$STATE_DIR/prev-workspace-id"
|
||||
|
||||
# Ensure headless exists.
|
||||
if ! hyprctl monitors all -j 2>/dev/null | jq -e --arg m "$MON" '.[] | select(.name == $m)' >/dev/null; then
|
||||
log "Creating headless output $MON"
|
||||
# Discover whatever headless output already exists. sunshine-prestart.sh is
|
||||
# responsible for ensuring one exists and aligning sunshine.conf's output_name
|
||||
# to its actual name (Hyprland's HEADLESS-N counter drifts across restarts).
|
||||
MON="$(hyprctl monitors -j 2>/dev/null \
|
||||
| jq -r '.[] | select(.name | startswith("HEADLESS")) | .name' | head -1)"
|
||||
if [[ -z "$MON" ]]; then
|
||||
log "No headless output found; creating one"
|
||||
hyprctl output create headless >/dev/null
|
||||
# Brief settle so Hyprland registers the new output before we configure it.
|
||||
for _ in 1 2 3 4 5; do
|
||||
hyprctl monitors all -j | jq -e --arg m "$MON" '.[] | select(.name == $m)' >/dev/null 2>&1 && break
|
||||
MON="$(hyprctl monitors -j 2>/dev/null \
|
||||
| jq -r '.[] | select(.name | startswith("HEADLESS")) | .name' | head -1)"
|
||||
[[ -n "$MON" ]] && break
|
||||
sleep 0.1
|
||||
done
|
||||
fi
|
||||
if [[ -z "$MON" ]]; then
|
||||
log "Failed to obtain a headless output; bailing."
|
||||
exit 0
|
||||
fi
|
||||
echo "$MON" > "$STATE_DIR/headless-name"
|
||||
|
||||
# Resize headless to the client's resolution / framerate.
|
||||
log "Sizing $MON → ${WIDTH}x${HEIGHT}@${FPS}"
|
||||
|
||||
@@ -7,8 +7,9 @@ set -euo pipefail
|
||||
|
||||
log() { printf '[sunshine-undo] %s\n' "$*" >&2; }
|
||||
|
||||
MON="HEADLESS-1"
|
||||
STATE_DIR="${XDG_RUNTIME_DIR:-/tmp}/sunshine-headless"
|
||||
# Headless name was captured by sunshine-stream-do.sh; fall back to discovery.
|
||||
MON="$(cat "$STATE_DIR/headless-name" 2>/dev/null || true)"
|
||||
|
||||
if ! command -v hyprctl >/dev/null 2>&1; then
|
||||
log "hyprctl not found; nothing to undo."
|
||||
@@ -29,6 +30,11 @@ fi
|
||||
|
||||
PREV_WS="$(cat "$STATE_DIR/prev-workspace-id" 2>/dev/null || echo 1)"
|
||||
|
||||
if [[ -z "$MON" ]]; then
|
||||
MON="$(hyprctl monitors -j 2>/dev/null \
|
||||
| jq -r '.[] | select(.name | startswith("HEADLESS")) | .name' | head -1)"
|
||||
fi
|
||||
|
||||
# Find a non-headless monitor to move the workspace back to. If there isn't one
|
||||
# (truly headless host with KVM detached), the workspace just lives on whatever
|
||||
# Hyprland reassigns it to when we remove the output.
|
||||
|
||||
Reference in New Issue
Block a user