lsiodev/hedgedoc

linuxserver/hedgedoc

HedgeDoc是一个实时、多平台协作的Markdown笔记编辑器，支持在桌面、平板或手机上与他人共同编写笔记，并可通过***、***、GitHub等多种身份验证方式登录。LinuxServer.io团队提供的此Docker镜像具有定期应用更新、简单的用户映射、自定义基础镜像及每周基础系统更新等特点。

!https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/hedgedoc-banner.png

支持的架构

该镜像利用Docker manifest实现多平台支持，拉取lscr.io/linuxserver/hedgedoc:latest即可获取适合您架构的正确镜像，也可通过标签拉取特定架构镜像。支持的架构如下：

应用设置

HedgeDoc Web界面可通过http://${IP}:3000/访问。若使用自定义域名或非3000端口，需配置回调相关环境变量（特别是CMD_DOMAIN、CMD_PORT和CMD_URL_ADDPORT）。

HedgeDoc完整配置选项

本文档提供了使用Mysql作为后端的示例配置，若不希望使用自定义环境变量或Mysql数据库，可参考上述链接中的其他设置。

如需在反向代理后运行，可使用https://github.com/linuxserver/docker-swag%E9%95%9C%E5%83%8F%E4%B8%AD%E5%8C%85%E5%90%AB%E7%9A%84https://github.com/linuxserver/reverse-proxy-confs/blob/master/hedgedoc.subdomain.conf.sample%EF%BC%8C%E5%85%B7%E4%BD%93%E4%BD%BF%E7%94%A8%E6%96%B9%E6%B3%95%E8%A7%81https://github.com/linuxserver/reverse-proxy-confs/#how-to-use-these-reverse-proxy-configs%E3%80%82

使用方法

可通过docker-compose（推荐）或docker cli创建容器。

docker-compose（推荐，https://docs.linuxserver.io/general/docker-compose%EF%BC%89

yaml
---
version: "2.1"
services:
  hedgedoc:
    image: docker.xuanyuan.run/linuxserver/hedgedoc:latest
    container_name: hedgedoc
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
      - "DB_HOST=<主机名或IP>"
      - DB_PORT=3306
      - DB_USER=hedgedoc
      - "DB_PASS=<机密密码>"
      - DB_NAME=hedgedoc
      - CMD_DOMAIN=localhost
      - CMD_URL_ADDPORT=false #可选
      - CMD_PROTOCOL_USESSL=false #可选
      - CMD_PORT=3000 #可选
      - CMD_ALLOW_ORIGIN=['localhost'] #可选
    volumes:
      - /path/to/appdata:/config
    ports:
      - 3000:3000
    restart: unless-stopped

docker cli（https://docs.docker.com/engine/reference/commandline/cli/%EF%BC%89

bash
docker run -d \
  --name=hedgedoc \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e DB_HOST="<主机名或IP>" \
  -e DB_PORT=3306 \
  -e DB_USER=hedgedoc \
  -e DB_PASS="<机密密码>" \
  -e DB_NAME=hedgedoc \
  -e CMD_DOMAIN=localhost \
  -e CMD_URL_ADDPORT=false `#可选` \
  -e CMD_PROTOCOL_USESSL=false `#可选` \
  -e CMD_PORT=3000 `#可选` \
  -e CMD_ALLOW_ORIGIN=['localhost'] `#可选` \
  -p 3000:3000 \
  -v /path/to/appdata:/config \
  --restart unless-stopped \
  lscr.io/linuxserver/hedgedoc:latest

参数

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

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

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

bash
-e FILE__MYVAR=/run/secrets/mysecretvariable

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

应用运行的Umask

所有镜像支持通过可选参数-e UMASK=022覆盖容器内服务的默认umask设置。注意umask是从权限中减去而非添加，详情请参考umask说明。

用户/组标识符

使用卷（-v标志）时，主机OS与容器之间可能出现权限问题。通过指定用户PUID和组PGID可避免此问题。确保主机上的卷目录由指定用户拥有，权限问题将迎刃而解。

此处PUID=1000和PGID=1000，可通过id your_user命令获取您的ID：

bash
id your_user

示例输出：

text
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

Docker Mods

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

我们发布了多种https://github.com/linuxserver/docker-mods%E4%BB%A5%E5%A2%9E%E5%BC%BA%E5%AE%B9%E5%99%A8%E5%8A%9F%E8%83%BD%E3%80%82%E4%B8%8A%E8%BF%B0%E5%8A%A8%E6%80%81%E5%BE%BD%E7%AB%A0%E5%8F%AF%E8%AE%BF%E9%97%AE%E6%AD%A4%E9%95%9C%E5%83%8F%E5%8F%AF%E7%94%A8%E7%9A%84Mods%E5%8F%8A%E9%80%82%E7%94%A8%E4%BA%8E%E4%BB%BB%E4%BD%95LinuxServer.io%E9%95%9C%E5%83%8F%E7%9A%84%E9%80%9A%E7%94%A8Mods%E3%80%82

支持信息

• 容器运行时的Shell访问：

  bash
  docker exec -it hedgedoc /bin/bash
  

• 实时监控容器日志：

  bash
  docker logs -f hedgedoc
  

• 容器版本号：

  bash
  docker inspect -f '{{ index .Config.Labels "build_version" }}' hedgedoc
  

• 镜像版本号：

  bash
  docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/hedgedoc:latest
  

更新信息

大多数镜像为静态、版本化，需更新镜像并重建容器以更新内部应用。除部分例外（如nextcloud、plex），不建议或支持在容器内更新应用。请参考应用设置部分确认是否推荐更新。

以下是更新容器的说明：

通过Docker Compose

• 更新镜像：

  • 所有镜像：

    bash
    docker-compose pull
    

  • 单个镜像：

    bash
    docker-compose pull hedgedoc
    

• 更新容器：

  • 所有容器：

    bash
    docker-compose up -d
    

  • 单个容器：

    bash
    docker-compose up -d hedgedoc
    

• 可删除旧的悬空镜像：

  bash
  docker image prune
  

通过Docker Run

• 更新镜像：

  bash
  docker pull docker.xuanyuan.run/linuxserver/hedgedoc:latest
  

• 停止运行中的容器：

  bash
  docker stop hedgedoc
  

• 删除容器：

  bash
  docker rm hedgedoc
  

• 使用上述相同的docker run参数重建容器（若正确映射到主机文件夹，/config文件夹和设置将保留）

• 可删除旧的悬空镜像：

  bash
  docker image prune
  

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

• 拉取最新镜像并使用相同环境变量运行：

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

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

警告：我们不认可使用Watchtower作为现有Docker容器的自动更新解决方案。事实上，我们通常不鼓励自动更新。但对于忘记原始参数的容器，这是一个有用的一次性手动更新工具。长期来看，强烈建议使用https://docs.linuxserver.io/general/docker-compose%E3%80%82

镜像更新通知 - Diun（Docker镜像更新通知器）

提示：推荐使用https://crazymax.dev/diun/%E8%8E%B7%E5%8F%96%E6%9B%B4%E6%96%B0%E9%80%9A%E7%9F%A5%E3%80%82%E4%B8%8D%E6%8E%A8%E8%8D%90%E6%88%96%E6%94%AF%E6%8C%81%E5%85%B6%E4%BB%96%E8%87%AA%E5%8A%A8%E6%9B%B4%E6%96%B0%E5%AE%B9%E5%99%A8%E7%9A%84%E5%B7%A5%E5%85%B7%E3%80%82

本地构建

如需为开发或自定义逻辑修改镜像：

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

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

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

注册后，可使用-f Dockerfile.aarch64指定Dockerfile。

版本历史

• 18.06.23: - 基于Alpine 3.18重建，根据https://www.linuxserver.io/armhf%E5%BC%83%E7%94%A8armhf%E3%80%82
• 02.11.22: - 基于Alpine 3.16重建，迁移到s6v3。
• 10.04.22: - 使用python3构建node sqlite3。
• 10.02.22: - 基于Alpine 3.15重建。
• 09.02.22: - 添加可选变量CMD_PORT，用于非80、443、3000端口访问。
• 09.12.21: - 添加可选变量CMD_PROTOCOL_USESSL，用于反向代理。
• 07.12.21: - 基于Ubuntu Focal重建，更新到node 16，确保上传文件持久化。
• 15.10.21: - 添加必填环境变量CMD_DOMAIN。
• 05.05.21: - 移除从config到/opt/hedgedoc/public的部分文件夹符号链接。
• 03.05.21: - 移除已弃用的sequalizerc步骤。
• 22.12.20: - 初始发布