martinboksa/hocuspocus

The Y.js WebSocket backend

Hocuspocus

A plug & play collaboration backend based on Y.js.

Documentation

The full documentation is a available on hocuspocus.dev/introduction.

Cloud Hosting

You want to use Hocuspocus, but don't want to care about hosting? Check our Cloud Offering: Tiptap Collab

Feedback

Send all your questions, feedback and bug reports to [email protected] or create an issue 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 (or prefixed with the WebSocket protocol on ws://127.0.0.1):

import { Server } from '@hocuspocus/server'
import { SQLite } from '@hocuspocus/extension-sqlite'

const server = Server.configure({
  port: 80,

  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

Sponsors 💖

überdosis

Cargo

Saga

Gamma

Outline

Ahrefs

Brickdoc

Sana

… and hundreds of awesome inviduals.

Using Hocuspocus in production? Invest in the future of Hocuspocus and become a sponsor!

Contributing

Please see CONTRIBUTING for details.

Contributors

kris (who wrote the initial version), Tom Moor, YousefED (@TypeCellOS) and many more.

License

The MIT License (MIT). Please see License File for more information.