linuxserver/codimd

[!TIP]

前半部分是翻译官方的文档,最后一部分是我的简单试用(个别软件会深度试用),如果对Docker已经有一定的了解了,可以直接跳转到最后面 翻译之外 这部分来查看。

Codimd → https://demo.codimd.org/

GitHub → https://github.com/linuxserver/docker-codimd

Docker Hub → https://hub.docker.com/r/linuxserver/codimd

Codimd 可以让你在任何地方访问你的文件。

CodiMD 是一个实时、多平台协作的markdown编辑器。这意味着你可以在任何地方与其他人通过电脑、平板甚至手机上记笔记。你可以使用Facebook、Twitter、GitHub等账号进行验证登录。


支持的系统架构

得益于docker的跨平台属性,我们的镜像也支持多架构(如,x86-64、arm64、armhf)。

直接拉取 ghcr.io/linuxserver/codimd 应该就可以自动获取适合你系统架构的版本,当然你也可以通过 tag 获取特定的版本。

架构 Tag
x86-64 amd64-latest
arm64 arm64v8-latest
armhf arm32v7-latest

拉取镜像

  1. docker pull ghcr.io/linuxserver/codimd

使用方法

以下是一些简单的示例。

docker-compose(推荐

兼容docker-compose v2

  1. version: "3"
  2. services:
  3. mariadb:
  4. image: linuxserver/mariadb:latest
  5. container_name: codimd_mariadb
  6. restart: always
  7. volumes:
  8. - <path to mariadb data>:/config
  9. environment:
  10. - MYSQL_ROOT_PASSWORD=<secret password>
  11. - MYSQL_DATABASE=codimd
  12. - MYSQL_USER=codimd
  13. - MYSQL_PASSWORD=<secret password>
  14. - PGID=1000
  15. - PUID=1000
  16. - TZ=Europe/London
  17. codimd:
  18. image: linuxserver/codimd:latest
  19. container_name: codimd
  20. restart: always
  21. depends_on:
  22. - mariadb
  23. volumes:
  24. - <path to config>:/config
  25. environment:
  26. - DB_HOST=mariadb
  27. - DB_USER=codimd
  28. - DB_PASS=<secret password>
  29. - DB_NAME=codimd
  30. - DB_PORT=3306
  31. - PGID=1000
  32. - PUID=1000
  33. - TZ=Europe/London
  34. ports:
  35. - "3000:3000"

docker cli

  1. docker run -d \
  2. --name=codimd \
  3. -e PUID=1000 \
  4. -e PGID=1000 \
  5. -e DB_HOST=<hostname or ip> \
  6. -e DB_PORT=3306 \
  7. -e DB_USER=codimd \
  8. -e DB_PASS=<secret password> \
  9. -e DB_NAME=codimd \
  10. -e TZ=Europe/London \
  11. -p 3000:3000 \
  12. -v </path/to/appdata>:/config \
  13. --restart unless-stopped \
  14. linuxserver/codimd

参数

Docker镜像在使用的时候需要配置一些参数,这些参数使用 : 分隔,分别表示 宿主机:容器内。例如 -p 8080:80 指的是将容器内的80端口映射到宿主机上的8080端口,即通过宿主机网络访问的话,访问8080端口即是访问容器内的80端口。

端口(-p

port 说明
3000 WEB界面

环境变量(-e

env 说明
PUID=1000 用户的 UID,详见下面的说明
PGID=1000 用户的 GID,详见下面的说明
TZ=Europe/London 设置时区,在国内的话可以使用 Asia/Shanghai
DB_HOST=<hostname or ip> mysql数据库的地址
DB_PORT=3306 mysql数据库端口
DB_USER=codimd mysql数据库用户名
DB_PASS=<secret password> mysql数据库密码
DB_NAME=codimd mysql数据库名

卷映射(-v

volume 说明
/config 配置文件所在路径

从文件加载环境变量

可以使用前缀名为 FILE__ 的文件来加载环境变量。

例:

  1. -e FILE__PASSWORD=/run/secrets/mysecretpassword

将把 /run/secrets/mysecretpassword 文件中的内容作为 PASSWORD 变量的值。


运行程序的umask(文件掩码)

我们所有的镜像都可以使用 -e UMASK=022 来设置覆盖容器内服务的umask。关于Linux umask可以通过这里了解,或自行百度学习。


UID和GID

当使用 -v 映射卷的时候,宿主机和容器内会出现关于权限的问题,我们的镜像可以通过指定 PUIDGUID 来避免此类问题。

可以使用你目前正在使用的用户的UID和GID进行设置,这样就不会存在权限问题。

可以通过如下的方式查看当前用户的UID和GID:

  1. $ id $user
  2. uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

[!NOTE]

如果没特殊需求,可以将后续所有容器的id都设置为当前非root用户的id,这样会省去解决很多关于文件权限的问题(可以查看 什么是PUID和PGID 这篇文章了解更多)。当然,如果有特殊需要可以给不同的容器设置不同的id,即分配给不同的用户。使用 useradd 命令即可添加用户。通常来说,除root账户外,第一个建立的用户的UID和GID都是1000,然后递增生成。


安装说明

访问WEB界面:http://ip:8443

如果你想用其他域名或者端口俩进行访问,可以修改环境变量。全部设置请查看:https://github.com/codimd/server/blob/master/docs/configuration.md


支持

  • 进入容器:
    • docker exec -it codimd /bin/bash
  • 查看容器日志:
    • docker logs -f codimd
  • 查看容器版本号:
    • docker inspect -f '{% raw %}{{% endraw %}{ index .Config.Labels "build_version" }}' codimd
  • 查看镜像版本号:
    • docker inspect -f '{% raw %}{{% endraw %}{ index .Config.Labels "build_version" }}' ghcr.io/linuxserver/codimd

翻译之外

可以跟好友共同协作编辑markdown文件,但更多的自定义设置需要参考官方提供的文档来设置,并不像其他的软件有傻瓜式的控制面板。

多人协作就和在线文档一样,这边有人编辑,另一边会即时呈现。

image-20201024145732423

image-20201024150531098

image-20201024150617003