|
2 | 2 | # y-websocket :tophat:
|
3 | 3 | > WebSocket Provider for Yjs
|
4 | 4 |
|
5 |
| -The Websocket Provider implements a classical client server model. Clients connect to a single endpoint over Websocket. The server distributes awareness information and document updates among clients. |
| 5 | +The Websocket Provider implements a classical client server model. Clients |
| 6 | +connect to a single endpoint over Websocket. The server distributes awareness |
| 7 | +information and document updates among clients. |
| 8 | + |
| 9 | +This repository contains a simple in-memory backend that can persist to |
| 10 | +databases, but it can't be scaled easily. The |
| 11 | +[y-redis](https://github.com/yjs/y-redis/) repository contains an alternative |
| 12 | +backend that is scalable, provides auth*, and can persist to different backends. |
| 13 | + |
| 14 | +The Websocket Provider is a solid choice if you want a central source that |
| 15 | +handles authentication and authorization. Websockets also send header |
| 16 | +information and cookies, so you can use existing authentication mechanisms with |
| 17 | +this server. |
| 18 | + |
| 19 | +* Supports cross-tab communication. When you open the same document in the same |
| 20 | +browser, changes on the document are exchanged via cross-tab communication |
| 21 | +([Broadcast |
| 22 | +Channel](https://developer.mozilla.org/en-US/docs/Web/API/Broadcast_Channel_API) |
| 23 | +and |
| 24 | +[localStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage) |
| 25 | +as fallback). |
| 26 | +* Supports exchange of awareness information (e.g. cursors). |
6 | 27 |
|
7 |
| -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. |
8 | 28 |
|
9 |
| -* Supports cross-tab communication. When you open the same document in the same browser, changes on the document are exchanged via cross-tab communication ([Broadcast Channel](https://developer.mozilla.org/en-US/docs/Web/API/Broadcast_Channel_API) and [localStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage) as fallback). |
10 |
| -* Supports exchange of awareness information (e.g. cursors). |
11 | 29 |
|
12 | 30 | ## Quick Start
|
13 | 31 |
|
|
0 commit comments