Getting Started
Prerequisites
- Cloudflare account with Workers enabled
- S2.dev account with a basin that has
Create stream on append/read
enabled - Scoped access token to your S2 basin
- R2 bucket for snapshot storage
Environment Variables
Deployment
Client Integration
Connect to the deployed worker using the Yjs WebSocket provider:How It Works
- Document Updates: When users make changes to a Yjs document, updates are sent to the y-s2 worker via WebSocket
- S2: Updates are appended to an S2 stream for durability and real-time distribution
- Client Distribution: Connected clients receive updates in real-time through WebSocket connections
- R2 Persistence: Document snapshots are periodically saved to R2 bucket storage for efficient loading