Skip to content

fix: document COLLAB_EMBEDDED_WS=true requirement for local self-hosting #56

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jessems wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: document COLLAB_EMBEDDED_WS=true requirement for local self-hosting #56

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,8 @@ VITE_ENABLE_TELEMETRY=false

# Optional app version tag for event properties
VITE_APP_VERSION=dev

# Required for local self-hosting: tells the server the collab WebSocket runs
# on the same port as the HTTP server (embedded mode). Without this, the server
# assumes the collab runtime is on PORT+1 and the editor stays in "connecting".
COLLAB_EMBEDDED_WS=true
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,13 @@ npm run dev
Start the local server:

```bash
npm run serve
COLLAB_EMBEDDED_WS=true npm run serve
```

The default setup serves the editor on `http://localhost:3000` and the API/server on `http://localhost:4000`.

> **Note:** `COLLAB_EMBEDDED_WS=true` is required for local self-hosting. Without it the server assumes the collab WebSocket runs on `PORT+1` (4001 by default) rather than the same port, and the editor will remain stuck in a "connecting" state. See `.env.example`.

## Core Routes

Canonical Proof SDK routes:
Expand Down