Backend for y-websocket
npm install @y/websocket-serverThe Websocket Provider is a solid choice if you want a central source that
handles authentication and authorization. Websockets also send header
information and cookies, so you can use existing authentication mechanisms with
this server.
``sh`
npm i @y/websocket-server
This repository implements a basic server that you can adopt to your specific use-case. (source code)
Start a y-websocket server:
`sh`
HOST=localhost PORT=1234 npx y-websocket
`js
import * as Y from 'yjs'
import { WebsocketProvider } from 'y-websocket'
const doc = new Y.Doc()
const wsProvider = new WebsocketProvider('ws://localhost:1234', 'my-roomname', doc)
wsProvider.on('status', event => {
console.log(event.status) // logs "connected" or "disconnected"
})
`
Start a y-websocket server:
`sh`
HOST=localhost PORT=1234 npx y-websocket
Since npm symlinks the y-websocket executable from your local ./node_modules/.bin folder, you can simply run npx. The PORT environment variable already defaults to 1234, and HOST defaults to localhost.
Persist document updates in a LevelDB database.
See LevelDB Persistence for more info.
`sh`
HOST=localhost PORT=1234 YPERSISTENCE=./dbDir npx y-websocket
Send a debounced callback to an HTTP server (POST) on document update. Note that this implementation doesn't implement a retry logic in case the CALLBACK_URL does not work.
Can take the following ENV variables:
* CALLBACK_URL : Callback server URLCALLBACK_DEBOUNCE_WAIT
* : Debounce time between callbacks (in ms). Defaults to 2000 msCALLBACK_DEBOUNCE_MAXWAIT
* : Maximum time to wait before callback. Defaults to 10 secondsCALLBACK_TIMEOUT
* : Timeout for the HTTP call. Defaults to 5 secondsCALLBACK_OBJECTS
* : JSON of shared objects to get data ('{"SHARED_OBJECT_NAME":"SHARED_OBJECT_TYPE}')
`sh`
CALLBACK_URL=http://localhost:3000/ CALLBACK_OBJECTS='{"prosemirror":"XmlFragment"}' npm startlocalhost:3000
This sends a debounced callback to 2 seconds after receiving an update (default DEBOUNCE_WAIT) with the data of an XmlFragment named "prosemirror"` in the body.
The MIT License © Kevin Jahns