codimd在线协作文档部署

前言

codimd是一款在线的markdown编辑器，用于实时在线协作编辑，非常适合需要多人合作记录重点信息的情况。

安装部署

github地址

官方文档介绍了多种部署方式，其中docker部署最为快捷，本文介绍此场景下部署codimd的流程。

安装docker和docker-compose

1.安装https协议、CA证书、dirmngr

1
2
3

apt-get update
apt-get install -y apt-transport-https ca-certificates
apt-get install dirmngr

2.添加GPG密钥并添加更新源

1
2

curl -fsSL https://mirrors.tuna.tsinghua.edu.cn/docker-ce/linux/debian/gpg | sudo apt-key add -
echo 'deb https://mirrors.tuna.tsinghua.edu.cn/docker-ce/linux/debian/ buster stable' | sudo tee /etc/apt/sources.list.d/docker.list

3.系统更新以及安装docker

1 2	`apt-get update apt install docker-ce`

4.启动docker服务器

1	`service docker start\`

5.安装compose

1	`apt install docker-compose`

部署codimd

之前的老教程多数会使用本地的数据库，最新的docker部署方式已经不需要自己创建数据库，可拉取一个postgreSQL数据库镜像作为替代

我们只需要创建并编辑一个docker-compose.yml

将以下三项与后面数据库配置CMD_DB_URL的参数对应起来即可

1
2
3

POSTGRES_USER=codimd
POSTGRES_PASSWORD=change_password
POSTGRES_DB=codimd

完整的docker-compose.yml文档

version: "3"
services:
  database:
    image: postgres:11.6-alpine
    environment:
      - POSTGRES_USER=codimd
      - POSTGRES_PASSWORD=change_password
      - POSTGRES_DB=codimd
    volumes:
      - "database-data:/var/lib/postgresql/data"
    restart: always
  codimd:
    image: hackmdio/hackmd:2.3.2
    environment:
      - CMD_DB_URL=postgres://codimd:change_password@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: {}