雨云搭建 HedgeDoc 实时协作文档教程

实时协作 Markdown 编辑器(CodiMD/HackMD 开源分支):多人同编、光标可见、版本可回滚
发布于
10

团队写方案、记会议纪要,最怕版本满天飞:微信群里一个 .docx、邮箱里又一个「最终版2」,改着改着谁也说不清哪份是新的。HedgeDoc 是开源的实时协作 Markdown 编辑器(原 CodiMD 分支),多人同时编辑同一篇、光标互相可见、改动即时同步,所有内容存你自己的服务器。本文记录在雨云 VPS 上用 Docker 部署 HedgeDoc 的过程。

一、HedgeDoc 解决什么

核心能力:

  • 实时协作:多人开同一篇文档,输入即时同步,适合共同写稿、头脑风暴;
  • Markdown 原生:左边写 MD、右边实时预览,程序员友好;
  • 版本历史:可回滚到之前的快照,误删能找回来;
  • 权限粒度:单篇可设公开/私有/登录可见,链接分享方便。

和前面写过的 Wiki.js(见 12255)、Outline(见 12267)、BookStack(见 12274)不同,这三者偏「结构化知识库」,HedgeDoc 偏「多人临时共创一篇」,定位更接近在线协作文档而非文档系统。

二、环境准备

HedgeDoc 本体不重,1 核 1G 就能跑,但生产建议配一个数据库(Postgres 或 MySQL)和 Redis(协同编辑依赖)。系统 Ubuntu 22.04,装好 Docker(入门见 12235)。雨云入门版即可起步,后续按需升配。

新用户用优惠码 admin01 可享 五折优惠,雨云支持 7 天无理由退款。入口:雨云官网

三、部署要点与坑

官方提供 docker-compose.yml,关键环境变量:

  • CMD_DB_URL:数据库连接串,生产务必用外部库而非默认 SQLite;
  • CMD_DOMAIN:对外访问域名,必须填正式域名;
  • CMD_ALLOW_ANONYMOUS:是否允许匿名编辑,对外服务建议关掉;
  • 协同编辑走 WebSocket,反代需放行 Upgrade 头。

踩坑提醒:

  • 别用 SQLite 跑生产:高并发协作下锁表严重,切到 Postgres 更稳;
  • WebSocket 要配:用 Nginx 反代时,ConnectionUpgrade 头不加会导致实时同步失效,退化为手动刷新;
  • 匿名编辑要关:公开实例开着匿名编辑容易被灌垃圾内容,建议至少要求登录。

如果担心后台暴露,可用 Authelia(见 12340)给编辑入口加一层登录保护。

四、备份与协作流

文档存数据库,定期用 BorgBackup(见 12306)备份数据库卷即可。典型用法是把 HedgeDoc 作为「会议现场共创板」,会前建好模板,会上多人同时填,散会直接导出 MD/PDF 归档到 Wiki.js 或 BookStack。

五、典型场景

  • 远程团队写稿:多人同时改一篇文案,告别来回传文件;
  • 会议纪要:会上实时记录,散会即定稿;
  • 技术评审:贴代码块、画流程图,边看边改。

合规提醒

多人协作文档的内容由参与者共同产生,运营方需履行《网络安全法》规定的信息内容管理责任,发现违法不良信息应及时处置;同时应在页面明示使用规范,提示用户不得上传侵权或违规内容。

常见问题(FAQ)

和 HackMD 什么关系?
HedgeDoc 是 HackMD 社区版(CodiMD)的开源分支,核心体验接近,优势是完全自托管、数据自主。
离线能编辑吗?
Web 端依赖服务器实时同步,没有真正的离线编辑;需要离线建议本地写 MD 再粘贴进来。
能导出哪些格式?
支持 Markdown、HTML、PDF、幻灯片(reveal.js),导出后可直接进知识库归档。
多人同时编辑会冲突吗?
基于 OT 协同算法,常规并写自动合并;极端情况下靠版本历史回滚,不会丢整体内容。

本文由作者原创/授权发布于极跃圈(jiyueip.com)未经许可,禁止转载。题图来自Unsplash,基于CC0协议。

声明:极跃圈(JIYUEIP.com)内网友所发表的所有内容及言论仅代表其本人,并不反映任何极跃圈(JIYUEIP.com)之意见及观点。

0 讨论
热门最新
总结
暂无总结
0 / 600

用雨云 KVM 云服务器 Docker 自建 Outline 团队文档协作(Outline+PostgreSQL+Redis+对象存储),配 Nginx 反代 HTTPS、空间权限与备份。含环境变量坑与优惠码 admin01 五折。

用雨云 KVM 云服务器 Docker 部署 Wiki.js + PostgreSQL,搭一个自己托管的私有知识库,文档可接 Git 后端自动备份。含内存调优、反代 HTTPS 与优惠码 admin01 五折。

用雨云 KVM 云服务器 Docker 自建 BookStack 团队文档/wiki,BookStack+MySQL 部署、Nginx 反代 HTTPS、书架层级与权限。含默认密码坑、413 上传限制与优惠码 admin01 五折。