Skip to content

Latest commit

 

History

2,010 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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 →

Hocuspocus

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

Build Status Version Downloads License Chat Sponsor

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 humans@tiptap.dev 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 = 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

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!

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.

About

The Yjs CRDT WebSocket backend for conflict-free real-time collaboration in your app.

Topics

Resources

Security policy

Stars

2.6k stars

Watchers

102 watching

Forks

Releases

Sponsor this project

Used by

Contributors

Languages