ghcr.io/colanode/web:0.3.3

Colanode

开源且本地优先的协作工作区，支持自托管

Colanode 是一个一体化协作平台，旨在简化协作流程，同时将数据隐私和控制权放在首位。采用本地优先的设计理念，它能帮助团队进行沟通、组织和项目管理——无论在线还是离线。使用 Colanode，您不仅能获得现代协作工具的灵活性，还能因拥有数据所有权而倍感安心。

Colanode 能做什么？

• 实时聊天：通过团队和个人即时消息保持联系。
• 富文本页面：使用直观的编辑器创建文档、知识库和笔记，类似于 Notion。
• 可自定义数据库：通过结构化数据、自定义字段和动态视图（表格、看板、日历）组织信息。
• 文件管理：在安全的工作区内轻松存储、共享和管理文件。

Colanode 为个人和团队打造，能适应您的需求——无论是运行小型项目、管理团队，还是在整个组织内协作。凭借其自托管模式，您可以在享受完善且功能丰富的体验的同时，保留对数据的完全控制权。

工作原理

Colanode 包含客户端应用（网页或桌面版）和自托管服务器。您可以通过单个应用连接到多个服务器，每个服务器包含一个或多个用于不同团队或项目的工作区。登录后，您可以选择一个工作区开始协作——发送消息、编辑页面或更新数据库记录。

本地优先工作流

您所做的所有更改首先保存到本地 SQLite 数据库，然后同步到服务器。后台进程处理此同步，因此即使您的计算机或服务器离线，您也可以继续工作。数据读取也在本地进行，确保您能立即访问所有有权查看的内容。

并发编辑

Colanode 依靠无冲突复制数据类型（CRDTs）——由 Yjs 提供支持——实现页面或数据库记录等条目的实时协作。这意味着多人可以同时编辑，系统会平滑合并所有人的更新。删除操作也作为特殊事务进行跟踪。消息和文件操作不支持并发编辑，使用更简单的数据库表。

要使用 Docker Compose 启动本地依赖项（Postgres、Redis 和邮件服务器）——默认使用文件系统存储——请从项目根目录运行以下命令：

docker compose -f hosting/docker/docker-compose.yaml up -d

如果希望在本地使用 S3 兼容后端，请使用 s3 配置文件启用可选的 MinIO 服务：

docker compose -f hosting/docker/docker-compose.yaml --profile s3 up -d

该 Compose 文件包含一个 server 服务。如果要通过 npm run dev 在本地运行 API，请注释掉（或覆盖）该服务，以便只启动支持服务。

Server

cd apps/web
npm run dev

Desktop

cd apps/desktop
npm run dev

当偏好本地S3兼容后端时，可使用s3配置文件启用可选的MinIO服务：

docker compose -f hosting/docker/docker-compose.yaml --profile s3 up -d

compose文件包含一个server服务。当希望通过npm run dev在本地运行API时，请注释掉（或覆盖）该服务，以便仅启动支持服务。

Web

cd apps/web
npm run dev

Desktop

cd apps/desktop
npm run dev

测试

Colanode包含服务器和Web端的测试。

服务器测试

在apps/server目录下：

npm run test

服务器测试使用Testcontainers来运行Postgres和Redis，因此Docker必须处于运行状态。详情请参见apps/server/README.md。

Web测试

在apps/web目录下：

npm run test

许可证

Colanode基于Apache 2.0许可证发布。