Skip to content

armgit / Piik

Public Imported from GitHub
0

Free, open-source screen sharing for private live streams with friends. Watch together in a browser or self-host Piik. 免费开源的私密屏幕共享,支持游戏直播、一起看电影与自部署。

docs(status): reconcile merged routing state

AAA484164d58a11
diff --git a/docs/adr/0001-p2p-first-media-topology.md b/docs/adr/0001-p2p-first-media-topology.md
index 8da7a819..07f333f8 100644
--- a/docs/adr/0001-p2p-first-media-topology.md
+++ b/docs/adr/0001-p2p-first-media-topology.md
@@ -28,7 +28,7 @@ Use separate control and media planes:
- Only pairs that cannot connect directly use authenticated TURN. Production requires STUN plus TURN over UDP and TCP; TURN/TLS is an optional restrictive-network enhancement, using its standard TCP port 5349 by default. Port 443 is optional and requires a dedicated public IP or a validated layer-4/SNI route when HTTPS already owns that address and port.
- Candidate selection is independent per pair. A room may simultaneously contain direct and relayed viewers without moving working peers onto the server.
- The deployed MVP broadcaster creates one peer connection per viewer. Rooms default to eight viewers and deployments may configure a limit from 1 through 16. Eight is an admission default, not a validated media-performance promise. A newer product target caps host media fanout at two; the current implementation does not satisfy that target above two viewers, and Proposed ADR-0004 owns the isolated experiment rather than silently changing this accepted baseline.
-- An SFU is not the default path for the normal product envelope. Closed PR #12's explicit whole-room mode is superseded by merged PR #17's default-off automatic fallback. When a deployment configures SFU capacity, ADR-0005 permits selecting it only after cheaper endpoint-carried routes fail; that experiment is not deployed or accepted for production.
+- An SFU is not the default path for the normal product envelope. Closed PR #12's explicit whole-room mode is superseded by merged PR #17's default-off automatic fallback. ADR-0005 permits selecting configured SFU capacity only after cheaper endpoint routes fail. The code ships in production but remains unconfigured, inactive, and unaccepted for production enablement.
## Consequences
diff --git a/docs/adr/0005-automatic-hybrid-media-routing.md b/docs/adr/0005-automatic-hybrid-media-routing.md
index 7e548fb3..516f329a 100644
--- a/docs/adr/0005-automatic-hybrid-media-routing.md
+++ b/docs/adr/0005-automatic-hybrid-media-routing.md
@@ -51,14 +51,15 @@ LiveKit endpoint/key/secret tuple. There is no user-facing topology selector and
no process-wide `MEDIA_MODE` union. Without the tuple, the same controller ends
at peer assistance and bounded waiting/failure.
-## Draft Implementation Status
+## Implementation Status
-Draft PR #17 (`feat/automatic-hybrid-routing`) implements this controller on top
-of Draft PR #13. Draft PR #20 (`spike/hybrid-warm-fallback`) adds only the
-bounded standby prewarm described below. Both pass CI but are not merged or
-deployed. Production remains on the ordinary one-host-peer-per-viewer path.
+Merged PR #17 implements this controller on top of merged PR #13. Merged PR #20
+adds only the bounded standby prewarm described below. Their code ships in
+production release `769de201f7cc`, but the deployment has neither
+`PEER_ASSISTED_MEDIA` nor a LiveKit tuple, so its active path remains ordinary
+one-host-peer-per-viewer P2P/TURN.
-The Draft keeps the LiveKit dependency dormant unless the complete URL, API key,
+The implementation keeps the LiveKit dependency dormant unless the complete URL, API key,
and API secret tuple is present together with `PEER_ASSISTED_MEDIA=true`. It
issues short-lived room-, role-, peer-, and publication-generation-bound grants,
and only allowlisted branch roots may subscribe. The server first retries a
@@ -199,7 +200,7 @@ second peer, then physically closed that new edge and reported its real
connection ID and active revision. The resulting plan had two allowlisted SFU
roots.
-| Failure report to | Cold Draft PR #17 | Authenticated standby |
+| Failure report to | Cold route controller | Authenticated standby |
| --- | ---: | ---: |
| SFU prepare | not retained | 5 ms |
| SFU active | 1,481 ms | 200 ms |
diff --git a/docs/research/low-server-media-routes.md b/docs/research/low-server-media-routes.md
index adaa12e2..fa4be907 100644
--- a/docs/research/low-server-media-routes.md
+++ b/docs/research/low-server-media-routes.md
@@ -31,8 +31,9 @@ The smallest current plan is:
Any browser-spike failure other than isolated relay re-encoding closes that
browser-relay route. It does not cancel the separate native sender plan. Closed
PR #12's explicit whole-room SFU mode is superseded. ADR-0005 and merged PR #17
-own the default-off automatic cross-mode controller; it remains undeployed.
-Corrected localhost Chrome/LiveKit functional recovery passed, while public
+own the default-off automatic cross-mode controller. Its code is deployed but
+inactive because production has no peer-assist flag or LiveKit tuple. Corrected
+localhost Chrome/LiveKit functional recovery passed, while public
transport, quality, load, and browser validation remain open.
## Token-Free SFU Standby Prewarm
diff --git a/docs/research/realtime-quality-adaptation.md b/docs/research/realtime-quality-adaptation.md
index 6cfcfeac..f49eb352 100644
--- a/docs/research/realtime-quality-adaptation.md
+++ b/docs/research/realtime-quality-adaptation.md
@@ -40,9 +40,9 @@ bitrate, and frame rate across all three profiles. This is a user observation,
not yet an instrumented result. The highest-confidence explanation is the
combination of one independent peer connection, sender, encoder pipeline, and
upload copy per viewer with `balanced` adaptation: host CPU or uplink pressure
-can grow per edge, and the browser may then reduce both dimensions. The current
-peer-assisted and SFU drafts are not deployed, so relay re-encoding and LiveKit
-cannot explain that production observation.
+can grow per edge, and the browser may then reduce both dimensions. Peer/SFU
+code now ships in `769de201f7cc`, but its production configuration is absent;
+relay re-encoding and LiveKit therefore cannot explain that earlier observation.
One controlled capture should classify the problem before changing constants: