From 33848c9d7762889eccbf488ab7b9ad147ea7e65b Mon Sep 17 00:00:00 2001 From: roboomp Date: Mon, 10 Aug 2026 14:37:54 +0000 Subject: [PATCH] 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 --- docs/collab.md | 4 ++++ packages/coding-agent/CHANGELOG.md | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/docs/collab.md b/docs/collab.md index 1a32139de..8e001e343 100644 --- a/docs/collab.md +++ b/docs/collab.md @@ -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/` 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), diff --git a/packages/coding-agent/CHANGELOG.md b/packages/coding-agent/CHANGELOG.md index a4d66e8d2..9648f69bc 100644 --- a/packages/coding-agent/CHANGELOG.md +++ b/packages/coding-agent/CHANGELOG.md @@ -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