CodiMD 介绍

一款强大的实时协作 Markdown 笔记工具

CodiMD 是一个开源的实时协作 Markdown 笔记工具，它允许用户在任何平台上共同编辑 Markdown 文档。核心功能是实时协作，它允许多个用户同时编辑同一个文档，并实时看到彼此的更改。支持实时渲染预览，支持超多的富文本格式，比如常用的图片、表格、emoji 表情和代码段，此外还有各种图表和数学公式。

🚢 项目地址

Github：https://github.com/hackmdio/codimd
官网: https://hackmd.io/

🚀CodiMD 特征

🚀 开源且自由：CodiMD 完全开源，您可以自由地在私有服务器上部署，完全掌控您的数据。
⏰ 强大的 Markdown 支持：它对 Markdown 语法有出色的支持，各种流程图，并且可以实时预览编辑的效果。
🔌 高度自定义：除了基本的编辑功能，CodiMD 还提供了 API 和插件支持，允许开发者进行进一步的扩展和定制。
👤 实时协作：多人可以在同一份文档上进行实时编辑，且每个人的编辑都会有不同的颜色标记，方便追踪。
🌐 良好的兼容性：兼容主要浏览器，包括 Chrome、Safari 和 Firefox 等，使用户在不同的设备和操作系统上均可获得流畅体验
🔑 独立自主的存储解决方案: 与大多数依赖于云端存储的工具不同，CodiMD 允许用户自主管控所有数据。通过选择适合的托管解决方案，用户可根据需求设计专属的安全性与隐私策略。

🛠️ 部署 CodiMD

👻 先决条件/要求

最低 512MB RAM（推荐 1GB+）
具备 docker，docker-compose 环境

🐳 使用 Docker Compose 部署

version: "3"
services:
  database:
    #image: postgres:11.6-alpine
    image: docker.cnb.cool/srebro/pidin/postgres:11.6-alpine ##CNB 镜像加速地址
    environment:
      - POSTGRES_USER=codimd
      - POSTGRES_PASSWORD=pidin.srebro.cn  ##自定义密码
      - POSTGRES_DB=codimd
    volumes:
      - "database-data:/var/lib/postgresql/data"
    restart: always
  codimd:
    #image: nabo.codimd.dev/hackmdio/hackmd:2.5.4
    image: docker.cnb.cool/srebro/pidin/hackmd:2.5.4 ##CNB 镜像加速地址
    environment:
      - CMD_DB_URL=postgres://codimd:pidin.srebro.cn@database/codimd
      - CMD_USECDN=false
    depends_on:
      - database
    ports:
      - "3000:3000"
    volumes:
      - upload-data:/home/hackmd/app/public/uploads
    restart: always
volumes:
  database-data: {}
  upload-data: {}

浏览器访问 CodiMD 地址：http://ip:3000/

🧭 使用 Nginx 反向代理

#CodiMD
  server {
        listen       443 ssl;
        server_name  codimp.srebro.cn;  ##替换成自己的域名
        error_page  404              /404/404.html;
        charset utf-8;

        ssl_certificate /home/application/nginx/cert/srebro.cn.pem; 
        ssl_certificate_key /home/application/nginx/cert/srebro.cn.key;
        ssl_session_cache    shared:SSL:1m;
        ssl_ciphers  HIGH:!aNULL:!MD5;
        ssl_prefer_server_ciphers  on;

    location / {
    proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header x-wiz-real-ip $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header Host $http_host;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_pass http://localhost:3000;
        }
}