Relocate hocuspocus to "extensions" folder

This commit is contained in:
Kabiru Mwenja
2026-02-12 20:01:02 +03:00
parent 258bdeb024
commit 90a0690f37
32 changed files with 27 additions and 27 deletions
+1 -1
View File
@@ -59,7 +59,7 @@ updates:
- dependency-name: "openproject-octicons_helper"
- dependency-name: "openproject-primer_view_components"
- package-ecosystem: "npm"
directory: "/blocknote/hocuspocus"
directory: "/extensions/op-blocknote-hocuspocus"
schedule:
interval: "weekly"
target-branch: "dev"
+3 -3
View File
@@ -6,7 +6,7 @@ on:
- dev
- release/*
paths:
- 'blocknote/hocuspocus/**'
- 'extensions/op-blocknote-hocuspocus/**'
workflow_call:
inputs:
tags:
@@ -16,7 +16,7 @@ on:
defaults:
run:
working-directory: ./blocknote/hocuspocus
working-directory: ./extensions/op-blocknote-hocuspocus
jobs:
build:
@@ -44,7 +44,7 @@ jobs:
- name: Build and push
uses: docker/build-push-action@v6
with:
context: ./blocknote/hocuspocus
context: ./extensions/op-blocknote-hocuspocus
push: true
platforms: linux/amd64,linux/arm64/v8
tags: ${{ inputs.tags }}
+3 -3
View File
@@ -3,14 +3,14 @@ on:
pull_request:
types: [opened, reopened, synchronize]
paths:
- 'blocknote/hocuspocus/**'
- 'extensions/op-blocknote-hocuspocus/**'
permissions:
contents: read
defaults:
run:
working-directory: ./blocknote/hocuspocus
working-directory: ./extensions/op-blocknote-hocuspocus
jobs:
units:
@@ -26,7 +26,7 @@ jobs:
with:
node-version: '22.19'
cache: npm
cache-dependency-path: blocknote/hocuspocus/package-lock.json
cache-dependency-path: extensions/op-blocknote-hocuspocus/package-lock.json
- name: Install Dependencies
id: npm-i
+1 -1
View File
@@ -87,7 +87,7 @@ glossary:
github:
href: https://github.com/opf/openproject
hocuspocus_server_docs:
href: https://github.com/opf/openproject/tree/dev/blocknote/hocuspocus
href: https://github.com/opf/openproject/tree/dev/extensions/op-blocknote-hocuspocus
ical_docs:
href: https://www.openproject.org/docs/user-guide/calendar/#subscribe-to-a-calendar
installation_guides:
@@ -9,4 +9,4 @@ services:
working_dir: /app
command: sh -c "npm run dev"
volumes:
- ../../../blocknote/hocuspocus:/app
- ../../../extensions/op-blocknote-hocuspocus:/app
@@ -153,7 +153,7 @@ Configuring OpenProject through environment variables is described in detail [in
#### Real-time collaboration
The AIO (all-in-one) container comes bundled with the [hocuspocus](https://github.com/opf/openproject/tree/dev/blocknote/hocuspocus) server needed
The AIO (all-in-one) container comes bundled with the [hocuspocus](https://github.com/opf/openproject/tree/dev/extensions/op-blocknote-hocuspocus) server needed
for the real-time collaboration feature for documents.
This is controlled via the following two environment variables, shown with their default values.
@@ -192,7 +192,7 @@ The [package-based installation](../installation/packaged) requires one of the f
Both the package and docker based installations will install and setup the the [Ruby runtime](https://www.ruby-lang.org/en/), as well as the [Puma application server](https://puma.io/) that are required by OpenProject to run.
For the [packaged installation](../installation/packaged/) and the [all-in-one docker container](../installation/docker#all-in-one-container) container, an [Apache](https://httpd.apache.org/) web server and a [PostgreSQL 17](https://www.postgresql.org/) database are installed.
The all-in-one container will only additionally install [hocuspocus](https://github.com/opf/openproject/tree/dev/blocknote/hocuspocus), which is required for the [real-time collaboration](../../user-guide/documents/#collaborative-editing) feature in OpenProject.
The all-in-one container will only additionally install [hocuspocus](https://github.com/opf/openproject/tree/dev/extensions/op-blocknote-hocuspocus), which is required for the [real-time collaboration](../../user-guide/documents/#collaborative-editing) feature in OpenProject.
## Client
OpenProject supports the latest versions of the major browsers.
+2 -2
View File
@@ -65,7 +65,7 @@ You will see a dialogue informing you of the consequences.
Real-time collaboration for OpenProjects **Documents** module was introduced with the 17.0 release. When enabled, it allows multiple users to edit the same document at the same time. Changes are synchronized instantly, and users can see each others cursors and edits as they occur. This improves collaboration, especially for teams working on shared documentation or meeting notes.
From a technical perspective, real-time collaboration relies on a running [Hocuspocus server](https://github.com/opf/openproject/tree/dev/blocknote/hocuspocus), which handles synchronization between users. OpenProject connects to this service to provide a seamless collaborative editing experience within documents.
From a technical perspective, real-time collaboration relies on a running [Hocuspocus server](https://github.com/opf/openproject/tree/dev/extensions/op-blocknote-hocuspocus), which handles synchronization between users. OpenProject connects to this service to provide a seamless collaborative editing experience within documents.
![Administration settings for real-time documents collaboration in OpenProject](openproject_system_guide_documents_real_time_collaboration.png)
@@ -76,7 +76,7 @@ From a technical perspective, real-time collaboration relies on a running [Hocus
> - Containerized installations
> - Cloud-hosted installations
>
> Packaged installations (DEB/RPM) require additional manual setup. This includes installing and configuring a [Hocuspocus server](https://github.com/opf/openproject/tree/dev/blocknote/hocuspocus) to enable real-time collaboration.
> Packaged installations (DEB/RPM) require additional manual setup. This includes installing and configuring a [Hocuspocus server](https://github.com/opf/openproject/tree/dev/extensions/op-blocknote-hocuspocus) to enable real-time collaboration.
### Enable real-time collaboration for packaged installations
@@ -12,7 +12,7 @@ A real-time collaborative editing server for [OpenProject](https://www.openproje
```bash
# Clone the OpenProject repository
git clone https://github.com/opf/openproject.git
cd openproject/blocknote/hocuspocus
cd openproject/extensions/op-blocknote-hocuspocus
# Install dependencies
npm install
@@ -18,7 +18,7 @@
"bugs": {
"url": "https://github.com/opf/openproject/issues"
},
"homepage": "https://github.com/opf/openproject/tree/dev/blocknote/hocuspocus#readme",
"homepage": "https://github.com/opf/openproject/tree/dev/extensions/op-blocknote-hocuspocus#readme",
"engines": {
"node": ">=22.18"
},