docs(collab): clarified relay distribution status

Documented that the hosted Go relay has no published source or standalone binaries, and linked the repository's WebSocket-only local protocol relay with its startup command and limitations.

Fixes #8165
This commit is contained in:
roboomp
2026-08-10 14:37:54 +00:00
parent 45e12e5bb7
commit 33848c9d77
2 changed files with 8 additions and 0 deletions
+4
View File
@@ -112,6 +112,10 @@ Set `collab.webUrl` when the browser UI is hosted separately from the websocket
## Self-hosting the relay
The production relay is not currently distributed for self-hosting: its Go source and standalone binaries are not published. The endpoint list below documents the hosted service's network contract, not an installable release.
For local protocol development, this repository includes a source-available, WebSocket-only stand-in at [`packages/collab-web/scripts/local-relay.ts`](../packages/collab-web/scripts/local-relay.ts). Run `bun run relay` from `packages/collab-web` to listen on `ws://localhost:7466`. It implements `/r/<roomId>` but does not serve the browser client, `/share` blobs, or `/healthz`, so it is not a replacement for the production service.
The relay is a small content-blind Go service. It keeps no state beyond live connections and exposes:
- `GET /` — the static collab-web guest client (target of the `/collab` deep link),
+4
View File
@@ -2,6 +2,10 @@
## [Unreleased]
### Changed
- Clarified that the production collab relay source and binaries are not currently published, and documented the source-available local protocol relay ([#8165](https://github.com/can1357/oh-my-pi/issues/8165)).
## [17.2.12] - 2026-08-08
### Fixed