lsiodev/codimd

linuxserver/codimd

镜像概述和主要用途

CodiMD 是一个实时、多平台协作的Markdown笔记编辑器。用户可以在桌面、平板甚至手机上与他人共同编写笔记，并支持通过***、***、GitHub等多个认证提供商登录。

LinuxServer.io团队提供的此镜像具有以下特点：

• 定期及时的应用更新
• 简单的用户映射（PGID、PUID）
• 基于s6 overlay的自定义基础镜像
• 每周基础操作系统更新，在整个LinuxServer.io生态系统中共享通用层，以最小化空间使用、 downtime和带宽
• 定期安全更新

核心功能和特性

• 实时协作编辑：多用户同时编辑同一文档，实时同步内容
• 多平台支持：可在桌面、平板和手机上使用
• 多认证方式：支持通过***、***、GitHub等多种第三方平台登录
• 丰富的Markdown支持：完整支持Markdown语法，满足各类笔记编写需求
• 灵活的部署选项：支持与MySQL数据库集成，可通过环境变量进行详细配置

支持的架构

本镜像支持多种架构，利用docker manifest实现多平台识别。只需拉取ghcr.io/linuxserver/codimd即可获取适合您架构的正确镜像，也可通过标签拉取特定架构的镜像。

支持的架构及对应标签：

使用方法

docker-compose（推荐）

兼容docker-compose v2架构。

yaml
version: "3"
services:
  mariadb:
    image: linuxserver/mariadb:latest
    container_name: codimd_mariadb
    restart: always
    volumes:
      - <mariadb数据路径>:/config
    environment:
      - MYSQL_ROOT_PASSWORD=<保密密码>
      - MYSQL_DATABASE=codimd
      - MYSQL_USER=codimd
      - MYSQL_PASSWORD=<保密密码>
      - PGID=1000
      - PUID=1000
      - TZ=Europe/London
  codimd:
    image: linuxserver/codimd:latest
    container_name: codimd
    restart: always
    depends_on:
      - mariadb
    volumes:
      - <配置路径>:/config
    environment:
      - DB_HOST=mariadb
      - DB_USER=codimd
      - DB_PASS=<保密密码>
      - DB_NAME=codimd
      - DB_PORT=3306
      - PGID=1000
      - PUID=1000
      - TZ=Europe/London
    ports:
      - "3000:3000"

docker cli

bash
docker run -d \
  --name=codimd \
  -e PUID=1000 \
  -e PGID=1000 \
  -e DB_HOST=<主机名或IP> \
  -e DB_PORT=3306 \
  -e DB_USER=codimd \
  -e DB_PASS=<保密密码> \
  -e DB_NAME=codimd \
  -e TZ=Europe/London \
  -p 3000:3000 \
  -v </path/to/appdata>:/config \
  --restart unless-stopped \
  ghcr.io/linuxserver/codimd

参数说明

容器镜像通过运行时传递的参数进行配置，格式为<外部>:<内部>。例如，-p 8080:80表示将容器内的80端口映射到主机的8080端口。

来自文件的环境变量（Docker secrets）

可以通过特殊前缀FILE__从文件中设置任何环境变量。例如：

bash
-e FILE__PASSWORD=/run/secrets/mysecretpassword

这将根据/run/secrets/mysecretpassword文件的内容设置PASSWORD环境变量。

应用程序运行的Umask

对于所有镜像，可使用可选的-e UMASK=022设置来覆盖容器内启动的服务的默认umask设置。请注意，umask不是chmod，它基于其值减去权限而非添加。请在寻求支持前阅读相关说明。

用户/组标识符

使用卷（-v标志）时，主机操作系统和容器之间可能会出现权限问题。通过指定用户PUID和组PGID可以避免此问题。

确保主机上的任何卷目录都由您指定的相同用户拥有，权限问题将迎刃而解。

在此示例中PUID=1000和PGID=1000，可通过id user命令查找您的PUID和PGID：

bash
$ id username
  uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

应用设置

CodiMD Web界面可通过http://${IP}:3000/访问。如果要使用自定义域名或非3000端口，需要利用其环境设置进行回调配置（特别是CMD_DOMAIN和CMD_URL_ADDPORT）。

https://github.com/codimd/server/blob/master/docs/configuration-env-vars.md

为方便起见，本文档提供了使用Mysql作为后端的工作示例。如果不希望使用我们的自定义环境值或Mysql数据库后端，可以使用上述链接中列出的任何设置。

要在反向代理后运行，我们在https://github.com/linuxserver/docker-letsencrypt%E9%95%9C%E5%83%8F%E4%B8%AD%E6%8F%90%E4%BE%9B%E4%BA%86%E4%B8%80%E4%B8%AA%E4%BD%BF%E7%94%A8docker%E7%BD%91%E7%BB%9C%E7%9A%84https://github.com/linuxserver/reverse-proxy-confs/blob/master/codimd.subdomain.conf.sample%EF%BC%8C%E6%82%A8%E5%8F%AF%E4%BB%A5%E5%9C%A8https://github.com/linuxserver/reverse-proxy-confs/#how-to-use-these-reverse-proxy-configs%E4%B8%AD%E9%98%85%E8%AF%BB%E5%A6%82%E4%BD%95%E4%BD%BF%E7%94%A8%E5%AE%83%E3%80%82

Docker Mods

https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=codimd&query=%24.mods%5B%27codimd%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml]([] "查看此容器的可用mods") https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml]([] "查看可用的通用mods")

我们发布了各种https://github.com/linuxserver/docker-mods%E4%BB%A5%E5%90%AF%E7%94%A8%E5%AE%B9%E5%99%A8%E5%86%85%E7%9A%84%E5%85%B6%E4%BB%96%E5%8A%9F%E8%83%BD%E3%80%82%E6%AD%A4%E9%95%9C%E5%83%8F%E5%8F%AF%E7%94%A8%E7%9A%84Mods%E5%88%97%E8%A1%A8%EF%BC%88%E5%A6%82%E6%9C%89%EF%BC%89%E4%BB%A5%E5%8F%8A%E5%8F%AF%E5%BA%94%E7%94%A8%E4%BA%8E%E6%88%91%E4%BB%AC%E4%BB%BB%E4%BD%95%E9%95%9C%E5%83%8F%E7%9A%84%E9%80%9A%E7%94%A8Mods%E5%8F%AF%E9%80%9A%E8%BF%87%E4%B8%8A%E8%BF%B0%E5%8A%A8%E6%80%81%E5%BE%BD%E7%AB%A0%E8%AE%BF%E9%97%AE%E3%80%82

支持信息

• 容器运行时的Shell访问：docker exec -it codimd /bin/bash
• 实时监控容器日志：docker logs -f codimd
• 容器版本号：docker inspect -f '{{ index .Config.Labels "build_version" }}' codimd
• 镜像版本号：docker inspect -f '{{ index .Config.Labels "build_version" }}' ghcr.io/linuxserver/codimd

更新信息

我们的大多数镜像是静态的、版本化的，需要更新镜像并重新创建容器才能更新内部应用。除某些例外（如nextcloud、plex），我们不建议或支持在容器内更新应用。请参考上述应用设置部分，了解是否推荐对此镜像进行应用更新。

以下是更新容器的说明：

通过Docker Compose

• 更新所有镜像：docker-compose pull
  • 或更新单个镜像：docker-compose pull codimd
• 让compose按需更新所有容器：docker-compose up -d
  • 或更新单个容器：docker-compose up -d codimd
• 还可以删除旧的悬空镜像：docker image prune

通过Docker Run

• 更新镜像：docker pull ghcr.io/linuxserver/codimd
• 停止运行中的容器：docker stop codimd
• 删除容器：docker rm codimd
• 使用上述相同的docker run参数重新创建新容器（如果正确映射到主机文件夹，您的/config文件夹和设置将被保留）
• 还可以删除旧的悬空镜像：docker image prune

通过Watchtower自动更新器（仅在忘记原始参数时使用）

• 拉取最新标签的镜像并使用相同的环境变量替换：

  bash
  docker run --rm \
  -v /var/run/docker.sock:/var/run/docker.sock \
  containrrr/watchtower \
  --run-once codimd
  

• 还可以删除旧的悬空镜像：docker image prune

注意： 我们不认可使用Watchtower作为现有Docker容器自动更新的解决方案。事实上，我们通常不鼓励自动更新。但是，对于您忘记原始参数的容器，这是一个有用的一次性手动更新工具。从长远来看，我们强烈建议使用Docker Compose。

镜像更新通知 - Diun（Docker Image Update Notifier）

• 我们推荐Diun用于更新通知。不推荐或支持其他自动更新容器的工具。

本地构建

如果您想对这些镜像进行本地修改以用于开发目的或自定义逻辑：

bash
git clone https://github.com/linuxserver/docker-codimd.git
cd docker-codimd
docker build \
  --no-cache \
  --pull \
  -t ghcr.io/linuxserver/codimd:latest .

可以使用multiarch/qemu-user-static在x86_64硬件上构建ARM变体：

bash
docker run --rm --privileged multiarch/qemu-user-static:register --reset

注册后，可以使用-f Dockerfile.aarch64指定要使用的dockerfile。

版本历史

• 23.05.19： - 初始发布