Compare commits

...
Sign in to create a new pull request.
Author SHA1 Message Date
91f5eda224 docs: nits from PR #3 review; remove macOS CI job the forge cannot run (#4) 2026-11-13 03:25:05 +00:00
ab2c576339 Merge pull request 'docs: remote access is Starfire over Headscale (corrects PR #2)' (#3) from kiko/remote-access-starfire into master
Some checks failed
CI / Build (iOS) (push) Has been cancelled
CI / Build (tvOS) (push) Has been cancelled
2026-11-09 11:40:28 +00:00
Kiko
98b9540fec remote-access: shorten the conditions bullet, say exactly what is untested, note CI
Some checks failed
CI / Build (iOS) (push) Has been cancelled
CI / Build (tvOS) (push) Has been cancelled
CI / Build (iOS) (pull_request) Has been cancelled
CI / Build (tvOS) (pull_request) Has been cancelled
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-11-09 11:40:23 +00:00
Kiko
42aa36b2e5 docs: remote access targets Starfire over Headscale; mark verified, reported and unverified (Meta 2026-11-06)
Some checks failed
CI / Build (iOS) (pull_request) Has been cancelled
CI / Build (tvOS) (pull_request) Has been cancelled
CI / Build (iOS) (push) Has been cancelled
CI / Build (tvOS) (push) Has been cancelled
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-11-06 13:23:22 +00:00
734f50a80f Merge pull request 'docs: remote access to a Sunshine host over Tailscale or Headscale (untested)' (#2) from docs/remote-access into master
Some checks failed
CI / Build (iOS) (push) Has been cancelled
CI / Build (tvOS) (push) Has been cancelled
2026-11-05 10:51:17 +00:00
9571d78d7c Merge pull request 'README: publish health stays independent of every other feature' (#1) from kiko/publish-independence-rule into master
Some checks failed
CI / Build (iOS) (push) Has been cancelled
CI / Build (tvOS) (push) Has been cancelled
2026-11-05 10:51:12 +00:00
Kiko
113e352789 README: say the OBS bridge role is planned, not present
Some checks failed
CI / Build (iOS) (push) Has been cancelled
CI / Build (tvOS) (push) Has been cancelled
CI / Build (iOS) (pull_request) Has been cancelled
CI / Build (tvOS) (pull_request) Has been cancelled
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-11-05 10:50:52 +00:00
Kiko
40ca1e2a81 README: publish health stays independent of every other feature
Some checks failed
CI / Build (iOS) (pull_request) Has been cancelled
CI / Build (tvOS) (pull_request) Has been cancelled
CI / Build (iOS) (push) Has been cancelled
CI / Build (tvOS) (push) Has been cancelled
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-11-02 16:55:52 +00:00
3 changed files with 59 additions and 66 deletions

View file

@ -1,45 +0,0 @@
name: CI
on:
push:
pull_request:
branches:
- master
workflow_dispatch:
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
permissions:
contents: read
jobs:
build:
name: Build (${{ matrix.platform }})
runs-on: macos-latest
strategy:
fail-fast: false
matrix:
include:
- scheme: Moonlight
sdk: iphonesimulator
platform: iOS
- scheme: Moonlight TV
sdk: appletvsimulator
platform: tvOS
steps:
- name: Checkout
uses: actions/checkout@v7
with:
submodules: recursive
- name: Download ${{ matrix.platform }} platform
run: xcodebuild -downloadPlatform ${{ matrix.platform }}
- name: Build Debug
run: xcodebuild -project Moonlight.xcodeproj -scheme "${{ matrix.scheme }}" -configuration Debug -sdk ${{ matrix.sdk }} clean build
- name: Build Release
run: xcodebuild -project Moonlight.xcodeproj -scheme "${{ matrix.scheme }}" -configuration Release -sdk ${{ matrix.sdk }} clean build

View file

@ -22,3 +22,6 @@ Check out [the Moonlight wiki](https://github.com/moonlight-stream/moonlight-doc
* In the "Team" dropdown, select your name. If your name doesn't appear, you may need to sign into Xcode with your Apple account. * In the "Team" dropdown, select your name. If your name doesn't appear, you may need to sign into Xcode with your Apple account.
* Change the "Bundle Identifier" to something different. You can add your name or some random letters to make it unique. * Change the "Bundle Identifier" to something different. You can add your name or some random letters to make it unique.
* Now you can select your Apple device in the top bar as a target and click the Play button to run. * Now you can select your Apple device in the top bar as a target and click the Play button to run.
## GameCult fork: publish health is independent
This fork is meant to take on the OBS bridge role that Ratatoskr used to hold; none of that code exists on this branch yet, so this is a rule for code to come. Whatever Moonlight publishes toward OBS, publish state is its own path, and no other feature may touch it. Sound, and any feature added after it, must never block, delay, or report on the publish path. A silent publish must never read as healthy: no output reads as unknown or failed, never as fine.

View file

@ -1,19 +1,44 @@
# Remote access: iPad to a Sunshine host on restrictive wifi # Remote access: iPad to a Sunshine host on restrictive wifi
**Status: planning document. Every step below is untested.** Nothing here has been run **Status: partly verified, mostly planning.** Corrected per Meta, 2026-11-06. Steps and
against the real host, iPad, or network. Doc claims are cited; anything not found in the claims not listed under "Verified" below are untested; anything not found in the cited
cited docs is marked *unverified*. Nothing in this repo changes: this is a design note. docs is marked *unverified*. Nothing in this repo changes: this is a design note.
## Verified (Meta, 2026-11-06)
- The Sunshine host is **Starfire**, not Raven. Raven is Deru's gaming machine and is not
involved.
- Moonlight on **Periwinkle** reaches Sunshine on Starfire. This is a working client and
host pair; nothing below has been re-run by a Mind.
- The mesh is **Headscale on Yggdrasil**, not Tailscale's hosted control plane. Option A
(hosted Tailscale) is kept below as reference only and is not the plan.
## Reported, not verified
- Starfire's GPU is a GTX 1070 (NVENC encode). Reported, not checked; no Mind probed
Starfire for this note.
## Unverified (do not rely on)
- **Remote access from outside the home network.** Nothing shows a stream working from
another network, over the mesh or otherwise.
- **The iPad joining the mesh** (see Client device: no App Store, Taurine, TrollStore).
- **A Starfire desktop session.** Whether a logged-in desktop exists for Sunshine to
capture when nobody is at the machine is not established (the Minds' accounts there have
no desktop; Starfire also runs unattended and may be down).
## Conditions in force ## Conditions in force
Set by Eureka (who holds the Wireguard network and Yggdrasil). They bound every option Set by Eureka (who holds the Wireguard network and Yggdrasil). They bound every option
below; an option that cannot meet them is out. below; an option that cannot meet them is out.
- **Raven's Sunshine host is a yes in principle only if** it is bound to the Wireguard - **Starfire's Sunshine host is a yes in principle only if** it is bound to the Wireguard
interface and paired by Meta, and never exposed (no public or LAN-wide listener, no interface and paired by Meta, and never exposed (no public or LAN-wide listener, no
port forward). *Untested and unverified: how to bind Sunshine to one interface. This port forward). These conditions were set when Raven was assumed to be the host; they
carry over until Eureka says otherwise.
*Untested and unverified: how to bind Sunshine to one interface.* This
doc has not found a Sunshine setting for it; check the Sunshine configuration page and doc has not found a Sunshine setting for it; check the Sunshine configuration page and
the host firewall before relying on either.* the host firewall before relying on either.
- **Minds get no access to the iPad** until Meta gives its Yggdrasil address and says yes. - **Minds get no access to the iPad** until Meta gives its Yggdrasil address and says yes.
Nothing here is to be run from, or opened on, Yggdrasil before that. Option B below is Nothing here is to be run from, or opened on, Yggdrasil before that. Option B below is
a design only. a design only.
@ -36,7 +61,7 @@ through TrollStore, not the App Store. Consequences, none of them tested:
## Problem ## Problem
Moonlight (this client) streams from a Sunshine host (called **Raven** here) over several Moonlight (this client) streams from a Sunshine host (**Starfire**) over several
TCP and UDP ports. The target situation is an iPad on managed wifi that blocks those TCP and UDP ports. The target situation is an iPad on managed wifi that blocks those
ports, with no mobile data fallback. The usual escape is an overlay VPN whose traffic ports, with no mobile data fallback. The usual escape is an overlay VPN whose traffic
looks like ordinary HTTPS. Only outbound TCP 443 is assumed to work. looks like ordinary HTTPS. Only outbound TCP 443 is assumed to work.
@ -56,7 +81,7 @@ Moonlight video/audio/input are UDP. Tailscale and Headscale carry arbitrary IP
WireGuard, so UDP flows unchanged. When no direct path exists, the WireGuard packets WireGuard, so UDP flows unchanged. When no direct path exists, the WireGuard packets
travel inside a TCP/HTTPS connection to a DERP relay. travel inside a TCP/HTTPS connection to a DERP relay.
## Option A: Tailscale (hosted control plane, Tailscale DERP) ## Option A: Tailscale (hosted control plane, Tailscale DERP) - reference only, not the plan
### How it behaves on a 443-only network ### How it behaves on a 443-only network
@ -74,16 +99,16 @@ travel inside a TCP/HTTPS connection to a DERP relay.
### Steps (all untested) ### Steps (all untested)
1. Create or identify the tailnet and its owner (see Open Questions). 1. Create or identify the tailnet and its owner (see Open Questions).
2. Install Tailscale on Raven; sign in to that tailnet. 2. Install Tailscale on Starfire; sign in to that tailnet.
3. Install a Tailscale client on the iPad (no App Store there; see Client device); sign in to the same tailnet. *Unverified: 3. Install a Tailscale client on the iPad (no App Store there; see Client device); sign in to the same tailnet. *Unverified:
whether the managed iPad's profile permits installing a VPN app or creating a VPN whether the managed iPad's profile permits installing a VPN app or creating a VPN
configuration. This is the first likely blocker.* configuration. This is the first likely blocker.*
4. In the Tailscale admin console or `tailscale status` on Raven, note Raven's tailnet IP 4. In the Tailscale admin console or `tailscale status` on Starfire, note Starfire's tailnet IP
(`100.x.y.z`) or MagicDNS name. (`100.x.y.z`) or MagicDNS name.
5. On the LAN beforehand if possible, pair Moonlight with Raven normally. If pairing over 5. On the LAN beforehand if possible, pair Moonlight with Starfire normally. If pairing over
the tailnet: in Moonlight, add the host manually by tailnet IP; enter the PIN in the tailnet: in Moonlight, add the host manually by tailnet IP; enter the PIN in
Sunshine's web UI. Sunshine's web UI.
6. Start a stream over the tailnet; check with `tailscale ping raven` (on any tailnet 6. Start a stream over the tailnet; check with `tailscale ping starfire` (on any tailnet
device) whether the path is `direct` or `via DERP(...)`. device) whether the path is `direct` or `via DERP(...)`.
7. If relayed and unplayable, lower Moonlight resolution, FPS and bitrate first. 7. If relayed and unplayable, lower Moonlight resolution, FPS and bitrate first.
@ -94,7 +119,7 @@ extra round trip through the nearest DERP region, and a throughput ceiling. Expe
playable desktop and slow-paced use, not guaranteed competitive-game latency. *No playable desktop and slow-paced use, not guaranteed competitive-game latency. *No
measurement exists for this site; measure with `tailscale ping` and a trial stream.* measurement exists for this site; measure with `tailscale ping` and a trial stream.*
## Option B: self-hosted Headscale on Yggdrasil behind 443 ## Option B: self-hosted Headscale on Yggdrasil behind 443 - this is the mesh in use
Headscale is an open-source reimplementation of the Tailscale control server; the Headscale is an open-source reimplementation of the Tailscale control server; the
official Tailscale iOS app can point at it official Tailscale iOS app can point at it
@ -103,7 +128,9 @@ official Tailscale iOS app can point at it
### Needs Eureka's approval first ### Needs Eureka's approval first
Nothing below is done until Eureka approves each item: Headscale on Yggdrasil exists (Meta, 2026-11-06). Its public hostname, TLS, relay choice and
node registration were not checked for this note, so each item below is still a question to
Eureka, not a settled fact:
- A new public hostname and DNS record for the control server. - A new public hostname and DNS record for the control server.
- A public TLS certificate for it, and where TLS terminates. - A public TLS certificate for it, and where TLS terminates.
@ -146,21 +173,23 @@ before use, per [config docs](https://headscale.net/stable/ref/configuration/))
### Exposure added ### Exposure added
One new public HTTPS hostname fronting a control plane; optionally a public relay and UDP One new public HTTPS hostname fronting a control plane; optionally a public relay and UDP
3478. Raven and the iPad gain no inbound ports; Sunshine ports stay on the tailnet. The 3478. Starfire and the iPad gain no inbound ports; Sunshine ports stay on the tailnet. The
tailnet's ACLs should restrict the iPad to Raven's Moonlight ports only tailnet's ACLs should restrict the iPad to Starfire's Moonlight ports only
(*unverified in this environment; ACL syntax differs between Headscale versions*). (*unverified in this environment; ACL syntax differs between Headscale versions*).
## Failure ladder ## Failure ladder
Run top to bottom, stopping at the first success. Everything is untested. Run top to bottom, stopping at the first success. Only the home-network baseline pair
(step 1; see Verified) is known to work; nothing from step 2 down has been run by anyone,
so each step's expected outcome is a prediction.
1. Home/LAN: confirm Moonlight streams to Raven with no overlay (baseline). 1. Home/LAN: confirm Moonlight streams to Starfire with no overlay (baseline).
2. Tailscale on both devices at the LAN: confirm tailnet IP works, `tailscale ping` is 2. Tailscale on both devices at the LAN: confirm tailnet IP works, `tailscale ping` is
direct. direct.
3. iPad on the restrictive wifi, Tailscale connected: does the app reach "Connected"? 3. iPad on the restrictive wifi, Tailscale connected: does the app reach "Connected"?
If not: is VPN installation or profile blocked by management (stop; this is policy, If not: is VPN installation or profile blocked by management (stop; this is policy,
not network), or is 443 to the control plane filtered or TLS-intercepted? not network), or is 443 to the control plane filtered or TLS-intercepted?
4. `tailscale ping raven` from the iPad's side (use another tailnet device, or app 4. `tailscale ping starfire` from the iPad's side (use another tailnet device, or app
status): `direct` is best, `via DERP` means relay. status): `direct` is best, `via DERP` means relay.
5. Relayed but stream stutters: lower bitrate, resolution, FPS; try H.264 over HEVC if the 5. Relayed but stream stutters: lower bitrate, resolution, FPS; try H.264 over HEVC if the
iPad decoder is struggling (decode, not network, may be the limit). iPad decoder is struggling (decode, not network, may be the limit).
@ -180,11 +209,11 @@ Run top to bottom, stopping at the first success. Everything is untested.
| Control-plane ownership | Tailscale account holder | Eureka / GameCult | | Control-plane ownership | Tailscale account holder | Eureka / GameCult |
| Latency when relayed | Tailscale DERP regions | Same, or own DERP region if run | | Latency when relayed | Tailscale DERP regions | Same, or own DERP region if run |
| Ongoing work | None | Upkeep, updates, backups | | Ongoing work | None | Upkeep, updates, backups |
| Recommended | Try first | Only if A fails at ladder step 3 or 6 | | Recommended | Not the plan (mesh is Headscale) | The mesh in use |
## Open Questions ## Open Questions
- Where does Raven sit on the network (same LAN as the iPad's home, behind carrier NAT, - Where does Starfire sit on the network (same LAN as the iPad's home, behind carrier NAT,
behind a router that can forward ports, wired or wifi)? It decides whether direct behind a router that can forward ports, wired or wifi)? It decides whether direct
connections are plausible at all. connections are plausible at all.
- Who holds the tailnet account for Option A (individual, org, shared), and who can add - Who holds the tailnet account for Option A (individual, org, shared), and who can add
@ -207,3 +236,9 @@ Run top to bottom, stopping at the first success. Everything is untested.
- <https://headscale.net/stable/usage/connect/apple/> - <https://headscale.net/stable/usage/connect/apple/>
- <https://docs.lizardbyte.dev/projects/sunshine/latest/md_docs_2getting__started.html> - <https://docs.lizardbyte.dev/projects/sunshine/latest/md_docs_2getting__started.html>
- <https://docs.lizardbyte.dev/projects/sunshine/latest/md_docs_2configuration.html> - <https://docs.lizardbyte.dev/projects/sunshine/latest/md_docs_2configuration.html>
## CI note
The repo has no CI workflow: the only job needed `xcodebuild` on `macos-latest`, and the forge
has no Mac runner, so it could never run. iOS builds are verified by hand until a Mac runner
exists.