工作中有些文档需要多人协同在线一起完成,这里我推荐你们试试支持makedown语法的开源在线编辑器-CodiMD。他的原名叫hackmd ,此工具适合需要多人合作记录并及时共享信息的情况。其部署方式已经支持docker容器部署,简直是开箱即用噢!
部署前提
服务器已部署docker,docker-compose组件
云服务器记得防火墙开启3000默认端口(若更改codimd默认端口,防火墙放行端口更改成相应的端口即可)
CodiMD部署需要数据库支持,这里采用的是docker下的postgres数据库
部署postgres数据库 创建postgres docker 拉去 postgres(若您当前docker环境中已经有了postgres,那你只需要进入容器创建相应数据库,用户即可,此步可跳过)
1 2 3 docker pull postgres # 设置管理员账户并启动容器 docker run -d -p 5432:5432 --name=postgresql -v /home/user/pgdata:/var/lib/postgresql/data -e POSTGRES_PASSWORD=your_password postgres
postgres创建数据库与用户 进入postgres容器
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 docker exec -it postgresql bash # 切换postgres角色 su - postgres # 进入数据库 psql # 创建新用户为:codimd 并设置密码,注意此处密码若要修改应与docker-compose.yml文件中的POSTGRES_PASSWORD值保持一致 CREATE USER codimd WITH PASSWORD 'change_password'; # 创建新数据库codimd并赋予所有权限给新用户codimd CREATE DATABASE codimd OWNER codimd; # 退出数据库 \q # 退出角色 exit # 退出容器 exit
部署Codimd 找一个你喜欢的位置创建一个新的文件夹并进入,创建文件名为:docker-compose.yml,文件内容如下,复制粘贴即可:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 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.4.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: {}
保存退出,当前目录下执行命令启动:
启动成功后,访问: http://you_ip:3000 即可
项目地址 1 https://github.com/hackmdio/codimd
项目原文部署文档 1 https://hackmd.io/c/codimd-documentation
Docker部署原文 Using docker-compose to setup CodiMD The easiest way to spin up CodiMD with docker is using docker-compose, see below docker-compose for example config.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 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.4.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: {}
1.Copy the config above and save as docker-compose.yml 2.Modify your database username and password 3.Run docker-compose up -d 4.Visit http://localhost:3000 in your browser
OVER~