ygo-server

Overview ¶

Command ygo-server is the stand-alone WebSocket sync server for ygo documents. It speaks the bare y-websocket subset of the Hocuspocus envelope (Sync + Awareness + QueryAwareness), which covers the universal interop subset shared by every JS Yjs adopter.

Usage:

ygo-server [-addr :8080] [-store path/to/ygo.db]

Without -store the server runs purely in-memory; documents are lost when their last connection disconnects. With -store the server persists every applied update to a SQLite database and loads the document history on first connect of a fresh server process.

Mount point: documents are addressed by the URL path. A client connecting to ws://host:8080/my-doc operates on docName "my-doc". The leading slash is stripped; query strings are ignored (matching y-websocket's convention).