点击上方“蓝字”，关注更多精彩

0x00 痛点分析

团队协作文档编辑工具，有很多，类似著名的TX文档、shimo文档等，但是这些都会连接外网，不够保密。

平时在做项目时希望有一个私有环境下的团队协作编辑文档的环境，同时能够很方便地搭建，不依赖服务器在个人电脑上就能搭建。

0x01 CodiMD

https://github.com/hackmdio/codimd

CodiMD 是一个开源项目，可实现 MarkDown 文档的协同编辑，功能与 HackMD 一致，用于实时在线协作编辑，非常适合需要多人合作记录重点信息的情况，部署极为简单，一台Linux虚拟机就可以安装成功。

0x02 CodiMD安装部署

前期准备

使用centos、ubuntu均可，需要安装docker和docker-compose，记得关闭防火墙。

项目部署

https://github.com/hackmdio/codimd

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

之前的老教程多数会使用本地的数据库，最新的docker部署方式已经不需要自己创建数据库，可拉取一个postgreSQL数据库镜像作为替代，我们只需要创建并编辑一个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:[email protected]/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: {}

接着运行docker-compose up -d

等待镜像拉取完毕并运行，使用以下命令查看运行状态

docker logs -f -t --tail 10  <codimd_container_id>

访问虚拟机地址的3000端口，出现下面的页面成功。

codimd更新

可以通过查看项目版本号，来更改docker-compose.yml中image的版本号。

codimd使用

1、点击登录，随便输入邮箱密码，点击注册。

2、成功注册后登录，点击新建笔记，

3、就可以十分便捷地书写md文档了，如果需要团队编写，直接将url发给团队即可。其他协作者可以放心大胆地使用，后台密码均进行了严格加密，密码防泄漏做得很好的。再说了，这是部署在内网中的，无所谓了。

4、随后导出，在弹出的网页按ctrl+s即可保存文件。

0x03 References

http://uuzdaisuki.com/2021/05/09/codimd%E5%9C%A8%E7%BA%BF%E5%8D%8F%E4%BD%9C%E6%96%87%E6%A1%A3%E9%83%A8%E7%BD%B2/

https://hackmd.io/c/codimd-documentation/%2Fs%2Fcodimd-docker-deployment