liquidinvestigations/codimd-server

CodiMD Docker 镜像文档

镜像概述

CodiMD 是一个开源的实时协作 Markdown 笔记编辑器。它受 Hackpad 和 Etherpad 等协作编辑器的启发，允许用户创建、编辑和共享实时同步的 Markdown 文档。本镜像为 CodiMD 的 Docker 封装，旨在简化部署流程，帮助团队快速搭建私有化的协同文档与知识管理平台。

核心功能和特性

• 实时协作：支持多人同时编辑同一篇 Markdown 笔记，内容实时同步。
• 丰富的 Markdown 支持：支持标准 Markdown 语法及多种扩展（如数学公式、流程图、时序图等）。
• 多平台身份验证：集成 、、GitHub、GitLab、Mattermost、Dropbox、Google、LDAP、SAML 和 OAuth2 等多种登录方式。
• 灵活的存储后端：支持将图片和附件存储于本地，或集成 Imgur、AWS S3、MinIO、Azure 等云存储服务。
• 数据导入导出：支持通过 Dropbox 进行文档的便捷导入与导出。
• 多终端兼容：全面支持主流现代浏览器及移动端浏览器。

使用场景和适用范围

• 团队知识库：作为企业内部或团队内部的知识管理和文档沉淀平台。
• 会议记录：在会议过程中进行多人实时协同记录。
• 技术文档编写：开发团队协同编写 API 文档、架构设计或 README 文件。
• 教育与培训：教师与学生之间的实时笔记共享与协作。

使用方法和配置说明

环境变量与配置

CodiMD 支持通过配置文件或环境变量进行配置。在 Docker 环境中，推荐使用环境变量进行核心配置。常用环境变量包括：

更多高级配置（如 OAuth、S3 存储等）请参考官方配置文档。

Docker 部署示例

1. 使用 Docker Run 快速启动

以下命令将使用内置的 SQLite 数据库快速启动一个 CodiMD 实例，并将数据持久化到本地目录：

bash
docker run -d \
  --name codimd \
  -p 3000:3000 \
  -e CMD_DOMAIN=localhost \
  -e CMD_ALLOW_ANONYMOUS=true \
  -v /path/to/codimd/uploads:/codimd/public/uploads \
  -v /path/to/codimd/db:/data \
  codimd/server:latest

2. 使用 Docker Compose 部署（推荐）

对于生产环境，建议使用 Docker Compose 并结合 PostgreSQL 数据库进行部署，以获得更好的性能和数据安全性。

创建 docker-compose.yml 文件：

yaml
version: '3'
services:
  database:
    image: postgres:13-alpine
    environment:
      POSTGRES_USER: codimd
      POSTGRES_PASSWORD: your_secure_password
      POSTGRES_DB: codimd
    volumes:
      - database_data:/var/lib/postgresql/data
    restart: always

  codimd:
    image: codimd/server:latest
    depends_on:
      - database
    ports:
      - "3000:3000"
    environment:
      CMD_DB_URL: postgres://codimd:your_secure_password@database/codimd
      CMD_DOMAIN: yourdomain.com
      CMD_PORT: 3000
      CMD_ALLOW_ANONYMOUS: "false"
      CMD_ALLOW_EMAIL_REGISTER: "true"
      CMD_IMAGE_UPLOAD_TYPE: filesystem
    volumes:
      - codimd_uploads:/codimd/public/uploads
    restart: always

volumes:
  database_data:
  codimd_uploads:

启动服务：

bash
docker-compose up -d

浏览器支持

为确保最佳体验，请使用以下版本或更高版本的浏览器访问：

• Chrome / Chrome for Android >= 47
• Safari / iOS Safari >= 9 / 8.4
• Firefox >= 44
• Edge >= 12 (IE >= 9)
• Opera >= 34 (不支持 Opera Mini)
• Android Browser >= 4.4

许可证

本项目基于 AGPLv3 许可证开源。