y-websocket-server :tophat:

> Simple backend for y-websocket

The 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.

Quick Start

$3

``sh
npm i @y/websocket-server
`

$3

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
`

$3

`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"
})
`

Websocket Server

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.

$3

Persist document updates in a LevelDB database.

See LevelDB Persistence for more info.

`sh
HOST=localhost PORT=1234 YPERSISTENCE=./dbDir npx y-websocket
`

$3

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 URL
* CALLBACK_DEBOUNCE_WAIT : Debounce time between callbacks (in ms). Defaults to 2000 ms
* CALLBACK_DEBOUNCE_MAXWAIT : Maximum time to wait before callback. Defaults to 10 seconds
* CALLBACK_TIMEOUT : Timeout for the HTTP call. Defaults to 5 seconds
* CALLBACK_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 start
`
This sends a debounced callback to localhost:3000 2 seconds after receiving an update (default DEBOUNCE_WAIT) with the data of an XmlFragment named "prosemirror"` in the body.

License

The MIT License © Kevin Jahns