op-blocknote-hocuspocus

A real-time collaborative editing server for OpenProject documents, powered by Yjs and Hocuspocus.

Installation

From Source

# Clone the repository
git clone https://github.com/opf/op-blocknote-hocuspocus.git
cd op-blocknote-hocuspocus

# Install dependencies
npm install

# Start the server with the appropriate environment variables setup
SECRET=secret12345 npm run start

The SECRET environment variable is a shared value between this application and OpenProject. Make sure to configure the same value in OpenProject - Settings Hocuspocus secret and in the SECRET environment variable of this project.

Using Docker

docker pull openproject/hocuspocus:latest

docker run -d \
  -p 1234:1234 \
  -e SECRET=secret12345 \
  openproject/hocuspocus:latest

Usage

Starting the Server

# Development Mode (with hot reload):
npm run dev

# Production Mode
npm run start

# Debug Mode (with Node.js inspector):
npm run debug

# Run tests
npm run test

# Lint code
npm run lint

Links

• OpenProject
• Hocuspocus Documentation
• Yjs Documentation
• BlockNote Editor
• Repository Issues

---

Maintained by the OpenProject team