linuxserver/codimd

linuxserver/codimd

CodiMD 是一个实时、多平台协作的 markdown 笔记编辑器。您可以在桌面、平板甚至手机上与他人共同编写笔记，并可通过 、、GitHub 等多种身份验证提供商登录。

支持的架构

该镜像支持多种架构，包括 x86-64、arm64 和 armhf。只需拉取 ghcr.io/linuxserver/codimd 即可获取适合您架构的正确镜像，也可通过标签拉取特定架构的镜像：

使用方法

docker-compose (推荐)

yaml
version: "3"
services:
  mariadb:
    image: docker.xuanyuan.run/linuxserver/mariadb:latest
    container_name: codimd_mariadb
    restart: always
    volumes:
      - <path to mariadb data>:/config
    environment:
      - MYSQL_ROOT_PASSWORD=<secret password>
      - MYSQL_DATABASE=codimd
      - MYSQL_USER=codimd
      - MYSQL_PASSWORD=<secret password>
      - PGID=1000
      - PUID=1000
      - TZ=Europe/London
  codimd:
    image: docker.xuanyuan.run/linuxserver/codimd:latest
    container_name: codimd
    restart: always
    depends_on:
      - mariadb
    volumes:
      - <path to config>:/config
    environment:
      - DB_HOST=mariadb
      - DB_USER=codimd
      - DB_PASS=<secret password>
      - DB_NAME=codimd
      - DB_PORT=3306
      - PGID=1000
      - PUID=1000
      - TZ=Europe/London
    ports:
      - "3000:3000"

docker cli

docker run -d \
  --name=codimd \
  -e PUID=1000 \
  -e PGID=1000 \
  -e DB_HOST=<hostname docker.xuanyuan.run/or ip> \
  -e DB_PORT=3306 \
  -e DB_USER=codimd \
  -e DB_PASS=<secret password> \
  -e DB_NAME=codimd \
  -e TZ=Europe/London \
  -p 3000:3000 \
  -v </path/to/appdata>:/config \
  --restart unless-stopped \
  ghcr.io/linuxserver/codimd

参数

用户/组标识符

使用卷(-v标志)时，主机操作系统和容器之间可能会出现权限问题。通过指定用户PUID和组PGID，可以避免此问题。确保主机上的任何卷目录都由您指定的相同用户拥有，权限问题就会迎刃而解。

要查找您的PUID和PGID，请使用id user命令：

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

应用设置

此镜像已弃用。CodiMD已更名为HedgeDoc，新的Docker镜像位于https://github.com/linuxserver/docker-hedgedoc。

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镜像中提供了一个使用docker网络的https://github.com/linuxserver/reverse-proxy-confs/blob/master/codimd.subdomain.conf.sample，您可以在https://github.com/linuxserver/reverse-proxy-confs/#how-to-use-these-reverse-proxy-configs中阅读如何使用它。

支持信息

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

版本历史

• 22.12.20: - 弃用该镜像，转而使用新的更名镜像https://github.com/linuxserver/docker-hedgedoc。
• 23.05.19: - 初始发布