hocuspocus

> [!TIP] > Help us **chart the future of Hocuspocus** by telling us about your needs in a short survey. Plus, you’ll get a chance to earn a $50 gift card. > **[Take the survey →](https://docs.google.com/forms/d/e/1FAIpQLSeUS8S1iZTud58GBSD_d4c8lfUvkZHvzU99kWxP1wnNZnPKpw/viewform?usp=header)** # Hocuspocus A plug & play collaboration backend based on [Y.js](https://github.com/yjs/yjs). ## Documentation The full documentation is a available on [hocuspocus.dev/introduction](https://tiptap.dev/docs/hocuspocus/introduction). ## Cloud Hosting You want to use Hocuspocus, but don't want to care about hosting? Check our [Cloud Offering: Tiptap Collab](https://tiptap.dev/collab) ## Feedback Send all your questions, feedback and bug reports to [[email protected]](mailto:[email protected]) or [create an issue](https://github.com/ueberdosis/hocuspocus/issues/new/choose) here. ## Usage The following example is a example setup you need to start a WebSocket server. By default, it’s listening on [http://127.0.0.1](http://127.0.0.1) (or prefixed with the WebSocket protocol on ws://127.0.0.1): ```js import { Server } from '@hocuspocus/server' import { SQLite } from '@hocuspocus/extension-sqlite' const server = new Server({ port: 1234, async onConnect() { console.log('') }, extensions: [ new SQLite({ database: 'db.sqlite', }), ], }); server.listen(); ``` ## Community For help, discussion about best practices, or any other conversation: [Join the Tiptap Discord Server](https://discord.gg/WtJ49jGshW) ## Sponsors

Tiptap	Cargo	Saga	Gamma	Outline	Ahrefs	Brickdoc	Sana
Poggio

… and hundreds of awesome inviduals. Using Hocuspocus in production? Invest in the future of Hocuspocus and [become a sponsor!](https://github.com/sponsors/ueberdosis) ## Contributing Please see [CONTRIBUTING](docs/contributing.md) for details. ## Contributors [kris](https://github.com/kriskbx) (who wrote the initial version), [Tom Moor](https://github.com/tommoor), [YousefED (@TypeCellOS)](https://github.com/YousefED) and [many more](../../contributors). ## License The MIT License (MIT). Please see [License File](LICENSE.md) for more information.