azyobuzin/codimd

HedgeDoc镜像说明

镜像概述

HedgeDoc（原Codimd）是一款开源的实时协作Markdown笔记工具，支持多人同时编辑同一文档并实时同步内容。它灵感来源于Hackpad、Etherpad等协作编辑器，适用于团队协作、知识共享等场景。

核心功能

• 实时协作：多人同时编辑文档，内容实时同步，支持显示编辑者光标位置及身份标识。
• Markdown扩展：全面支持Markdown语法，包括数学公式、流程图、代码块高亮等高级功能。
• 多平台集成：支持GitHub、GitLab、Google、LDAP等多种登录方式；可集成Imgur、S3、Minio等存储服务管理图片/附件。
• 跨浏览器兼容：适配Chrome、Safari、Firefox等主流浏览器的最新稳定版本。

使用场景

• 团队协作编辑技术文档、项目计划或会议记录。
• 教育场景下师生共同编辑学习资料或作业。
• 个人/团队共享知识笔记，支持导出为PDF、Markdown等格式。

配置说明

HedgeDoc支持通过配置文件或环境变量进行设置，关键配置项包括：

• 数据库连接（PostgreSQL/MySQL等）。
• 登录认证方式（OAuth2、LDAP、SAML等）。
• 附件存储路径（本地或第三方服务）。

详细配置可参考官方文档：HedgeDoc配置指南

Docker部署示例

基础运行命令

bash
docker run -d -p 3000:3000 --name hedgedoc azyobuzin/codimd

带PostgreSQL数据库的配置示例

bash
docker run -d -p 3000:3000 \
  -e DB_TYPE=postgres \
  -e DB_HOST=your-postgres-host \
  -e DB_PORT=5432 \
  -e DB_USER=hedgedoc \
  -e DB_PASS=your-db-password \
  -e DB_NAME=hedgedoc \
  --name hedgedoc azyobuzin/codimd

备份与恢复

• 备份：需保存数据库数据、自定义配置文件及上传文件目录。
• 恢复：还原上述备份内容即可恢复HedgeDoc实例。

许可证

本镜像基于AGPLv3许可证开源，详细信息请查看官方仓库：https://github.com/hedgedoc/hedgedoc