Our take
Inactiveno commits in over a year- Activity
- 19
- Community
- 4
- Issues
- 21
- Pull requests
- 20
+0 stars in the last 30 days
- Fewer contributors than 91% of the projects we track
This is a focused Cloudflare and Yjs demonstration, but its inactive maintenance and reliance on one contributor make it a poor default for production adoption.
Good fit if
- You want to study a concrete Yjs WebSocket provider built with Workers and Durable Objects.
- You are prototyping a collaborative editor and can assess or maintain the code yourself.
- You want to run the included Wrangler and TipTap demo locally.
Look elsewhere if
- You need a maintained production service: the project has had no commits or releases in over a year, and most of the code comes from one person.
- You need active issue or pull request handling; there has been no recent issue closure or merged pull request activity.
- You want a production-oriented Yjs deployment rather than a learning project. The README points to PartyKit as an alternative.
All health signals
| Last commit | 2025-09-04 (1.1 years ago) |
|---|---|
| Commits, last 90 days | 0 |
| Releases, last 12 months | 0 |
| Contributors | 1 |
| Issues closed, last 90 days | 0 |
| Pull requests merged, last 90 days | 0 |
| Project age | 3 years |
Checked on 2026-10-12 with the GitHub API.
Project history
Daily GitHub snapshots since Oct 7, 2026. History covers stars and forks; health signals are not tracked historically.
Stars
32Forks
5Change since Nov 17, 2026: 0 stars·0 forks
Overview
This project hosts a WebSocket relay for Yjs collaborative documents on Cloudflare Workers and Durable Objects. It is compatible with the Yjs WebSocket Connector, so existing clients using y-websocket can connect to it.
It demonstrates a serverless approach to real-time collaboration: Durable Objects manage client connections, while document state is periodically saved to Cloudflare R2. The author describes it as a learning and demonstration project, rather than a production-ready service.
Key Features
- Relays Yjs document updates between WebSocket clients.
- Compatible with the Yjs WebSocket Connector (
y-websocket). - Uses Cloudflare Workers and Durable Objects for the serverless hosting model.
- Uses Durable Objects WebSocket Hibernation to avoid duration charges while connections are idle.
- Periodically saves document state to a Cloudflare R2 bucket.
- Clears partial updates from Durable Object storage during periodic cleanup.
- Configures the cleanup interval with
YJS_VACUUM_INTERVAL_IN_MS, defaulting to 30 seconds. - Includes a local demo app with a TipTap editor, served through Wrangler.
Use Cases
- A developer learning how Workers, Durable Objects, WebSocket Hibernation, and R2 fit together in a real-time application.
- A prototype that needs Yjs clients to exchange collaborative document updates through a WebSocket endpoint.
- A local experiment with Yjs and TipTap, using the included demo app to test collaboration.
- A team evaluating Cloudflare's serverless model for a Yjs relay before choosing a production service.
What you need
Detected in the repository
- Node.js (from package.json)
License in plain words
MITpermissive
- Commercial use: yes
- Modify and redistribute: yes
- You must keep: the copyright and license notice
- Share your changes: no
A summary, not legal advice: the LICENSE file is what applies.
Getting Started
npm install
npm run dev
This starts the local Wrangler server and demo app. See the README for details.
Considerations
- The repository is marked inactive, with no commits or releases in over a year. Its sole contributor accounts for all recorded contributions, so ongoing maintenance is concentrated in one person.
- This is explicitly presented as a learning and demonstration project. The README recommends PartyKit for a production-ready option that supports the Yjs API.
- Running the project requires Node.js and Cloudflare services for deployment, including Durable Objects and an R2 bucket for persisted document state. The repository metadata reports no tests or CI configuration.
- The project uses the MIT license. Reuse and distribution require retaining the license and copyright notice.
Found this useful?
Share it with someone who would like yjs-cf-ws-provider.