How nextcloud/whiteboard works
Nextcloud Whiteboard is a browser-first collaborative drawing app. Users open or create a board, edit it in the Excalidraw-based UI, and save changes locally before syncing with Nextcloud; optional WebSocket sessions add live collaboration. The product also supports libraries and templates, comments and voting, version preview, and recordings. Edges are limited to relationships shown in excerpts or explicitly documented in the README; unsampled implementation details are represented only where the tree or README supports a subsystem.
Main entry points: App.tsx Whiteboard UI · useBoardDataManager.ts Board data manager · SocketService.js Socket and room service · useVersionPreview.ts Version preview
Components 26
Browser whiteboard
- Whiteboard UI
src/App.tsx - Client entry
src/main.ts - Board data manager
src/hooks/useBoardDataManager.ts - Board config
src/stores/useWhiteboardConfigStore.ts - JWT handling
src/stores/useJwtStore.ts - Version preview
src/hooks/useVersionPreview.ts - Collaboration client
src/hooks/useCollaboration.ts - Collaboration state
src/stores/useCollaborationStore.ts - Board comments
src/components/CommentSidebar.tsx
Board persistence
- Local board database
src/database/db.ts - Background sync worker
src/workers/syncWorker.ts - Scene sync utilities
src/utils/syncSceneData.ts
Nextcloud app
- Board API controller
lib/Controller/WhiteboardController.php - Board content service
lib/Service/WhiteboardContentService.php - JWT service
lib/Service/JWTService.php - App configuration
lib/Service/ConfigService.php - Canvas templates
lib/Service/CanvasTemplateService.php - Whiteboard libraries
lib/Service/WhiteboardLibraryService.php
Live collaboration
- WebSocket server
websocket_server/main.js - Socket and room service
websocket_server/Services/SocketService.js - Session storage
websocket_server/Services/StorageService.js - Board recording
websocket_server/Services/RecordingService.js - Presentation controls
websocket_server/Services/PresentationService.js - Voting controls
websocket_server/Services/VotingService.js
Other components
- Board user
- Nextcloud platform
Connections 28
- Board user → Whiteboard UI: opens and edits
README.md - Client entry → Whiteboard UI: renders
src/main.ts - Whiteboard UI → Board data manager: loads board data
src/App.tsx - Board data manager → Local board database: reads and writes
src/hooks/useBoardDataManager.ts - Board data manager → Nextcloud platform: fetches board
src/hooks/useBoardDataManager.ts - Board data manager → Board config: checks board state
src/hooks/useBoardDataManager.ts - Board data manager → JWT handling: uses token
src/hooks/useBoardDataManager.ts - Background sync worker → Local board database: reads and writes
src/workers/syncWorker.ts - Background sync worker → Scene sync utilities: uses sync helpers
src/workers/syncWorker.ts - Whiteboard UI → Collaboration client: starts collaboration
src/App.tsx - Collaboration client → Collaboration state: updates state
- Collaboration client → WebSocket server: joins live session
README.md - WebSocket server → Socket and room service: starts service
websocket_server/main.js - Socket and room service → Session storage: uses storage service
websocket_server/Services/SocketService.js - Socket and room service → Presentation controls: dispatches controls
websocket_server/Services/SocketService.js - Socket and room service → Voting controls: dispatches controls
websocket_server/Services/SocketService.js - Board user → Nextcloud platform: requests board
README.md - Nextcloud platform → Board API controller: routes requests
- Board API controller → Board content service: reads board content
lib/Controller/WhiteboardController.php - Board API controller → JWT service: validates token
lib/Controller/WhiteboardController.php - JWT service → App configuration: gets signing secret
lib/Service/JWTService.php - Whiteboard UI → Whiteboard libraries: loads libraries
src/App.tsx - Whiteboard UI → Canvas templates: uses templates
README.md - Whiteboard UI → Version preview: previews versions
src/App.tsx - Version preview → Local board database: updates local copy
src/hooks/useVersionPreview.ts - Version preview → Nextcloud platform: restores version
src/hooks/useVersionPreview.ts - Whiteboard UI → Board comments: shows sidebar
src/App.tsx - Board user → Board recording: records board
README.md