从个人记录，到团队协作，再到对外分享。
自托管的文档与知识空间，让内容的整理、编辑和发布在同一处完成。
概览 · 功能 · 快速开始 · CLI 与 Agent · 版本动态 · 文档 · 开发
Orbis 将文集、块文档、多维表格和文档站放进同一个工作空间。用目录整理资料，通过正文协同一起完成内容，再交付给读者。各版本的开放入口以版本说明为准。
|
01 / WRITE 写下与整理 从一页文档开始，用文集和嵌套目录组织内容；文字、表格、图片与绘图可以一起表达想法。 |
02 / COLLABORATE 一起完成 通过成员角色、正文协同和自动保存推进工作；用多维表格组织结构化信息。 |
03 / PUBLISH 准备好，再发布 将选定内容发布为文档站。发布版本拥有独立快照，团队继续编辑草稿时，读者看到的内容保持稳定。 |
| 场景 | 当前支持 |
|---|---|
| 组织知识 | 工作空间、文集分组、嵌套目录、搜索、Markdown 导入导出 |
| 丰富表达 | 块文档、富文本、普通表格、图片与附件、原生画板引用、内容组件 |
| 团队协作 | 成员角色、邮件邀请、CRDT 正文协同与自动保存；评论与版本管理接口保留，Web 管理入口暂缓开放 |
| 随手记录 | 工作空间内个人私有随手记、富文本与附件、标签、搜索、置顶、回收站与本机草稿恢复 |
| 多维表格 | 字段、记录、视图、筛选、排序、分组、复制、撤销与 CSV/Markdown 导出 |
| 原生画板（暂缓开放） | 创建入口暂时隐藏，后续迭代开放；已有画板及正文引用继续保留 |
| 对外发布 | 已有文档站与分享链接继续可用；文档站导航、文档分享入口暂缓开放 |
| 工具接入 | 公共 API、工作空间范围的 Agent 令牌、独立 CLI、产品 Skill、持久化分块导入 |
旧版正文绘图已退役，不再提供旧编辑器、预览或数据下载。打开可编辑文档时，旧绘图块通过正文保存流程清除；原生画板和正文画板引用使用独立模块。
0.1.1 暂缓开放画板创建、文档分享、评论与版本面板、文档站导航和表格表单管理入口；已有数据、公共 API、画板引用、公开站点与表单读取继续保留。具体范围见 版本说明。
两种分享方式。 文档站交付显式发布的快照；可撤销的实时分享展示当前可见内容，未来新增或移入的文档也可能进入分享范围。 9816 布时私有文件会复制为发布专用对象；外部 HTTP(S) 媒体只固定 URL，不复制外部服务器的文件。
0.1.1 的封版源码使用 release/v0.1.1 标签，提供服务端、前端、协同引擎的构建定义和通用 Docker Compose 模板。你需要 Docker Engine、Compose V2 和 Git；运行构建后的镜像无需在宿主机安装 Go 或 Node.js。
获取封版源码，构建服务端、前端和协同引擎镜像：
git clone https://github.com/singous/orbis.git
cd orbis
git switch --detach refs/tags/release/v0.1.1
docker build --target server --build-arg ORBIS_VERSION=0.1.1 -t orbis-server:0.1.1 .
docker build --target frontend -t orbis-frontend:0.1.1 .
docker build --target collaboration -t orbis-collaboration:0.1.1 .
(umask 077; set -C; cat deploy/.env.example > deploy/.env)按 Compose 部署指南 填写 deploy/.env：为数据库、登录签名和协同引擎分别生成密钥，设置访问地址，并填入三个镜像的不可变引用。源码试用可通过 docker image inspect --format '{{.Id}}' IMAGE 取得本地镜像 ID。
配置完成后，仍在项目根目录执行：
docker compose --env-file deploy/.env -p orbis -f deploy/compose.yaml up -d --wait db redis
docker compose --env-file deploy/.env -p orbis -f deploy/compose.yaml --profile maintenance run --rm --no-deps migrate
docker compose --env-file deploy/.env -p orbis -f deploy/compose.yaml up -d --wait api web本机试用时，将 ORBIS_PUBLIC_BASE_URL 设置为 http://127.0.0.1:28190，启动后访问 初始化页面 创建所有者账号。公开部署需按实际域名配置 HTTPS 和 WebSocket 反向代理。
升级已有实例请先阅读 升级与备份说明，保留原有配置、密钥和持久化数据。
独立 CLI 通过公共 API 访问服务，可用于文档读取、导入导出及结构化写入。产品 Skill 为 Agent 提供操作约定与示例。
make cli-build
bin/orbis --version
bin/orbis --help从源码构建 CLI 需要 .go-version 固定的 Go 工具链。在工作空间的集成设置中生成专用令牌，再按 CLI 指南 配置连接；令牌的权限范围与 Web 中的资源可见性保持一致。
阅读 CLI 指南 → · 查看产品 Skill → · 查看 API 契约 →
新增个人随手记，改进多维表格的双击编辑、右键菜单与拖拽排序，完善正文嵌入、目录定位、首页与操作反馈。已有原生画板和正文引用继续保留，创建入口暂缓开放。
升级前请阅读旧正文绘图退役、暂缓开放入口与数据库迁移说明。
首个封版版本串联文档整理、多人协作、多维表格和文档站发布，并交付独立 CLI 与自托管部署模板。
Note
v0.1.0 的封版提交仍有浏览器端到端验收失败待处理。已完成的验证、使用边界和部署入口见 版本说明。
后续方向：自定义域名、API 调试台、高级站点模板和 S3 存储适配尚未提供；独立 MCP 服务将在出现实际需求后建立。
| 你想了解什么 | 文档 |
|---|---|
| 安装、配置、升级与备份 | Docker Compose 部署 |
| 本地开发、架构与运行参数 | 开发与运行参考 |
| 协同引擎与内容恢复 | 协同引擎说明 |
| 命令行与自动化接入 | CLI · 产品 Skill |
| 公共接口与数据格式 | OpenAPI |
| 版本范围与已知限制 | 0.1.1 封版说明 · v0.1.0 版本说明 |
后端采用 Go、Gin、GORM 与 PostgreSQL，前端使用 React 和 TypeScript；正文协同采用 Yjs 和独立 Node.js 引擎。CLI 使用独立 Go module，通过公共 API 访问服务。
开发环境需要 .go-version 固定的 Go、Node.js 24 和 Docker。工作从 develop 分支开始，详细命令见 本地开发 与 验证。
问题反馈请提交 Issue，功能与修复通过面向 develop 的 PR 评审。
Orbis 使用 GNU AGPL v3。