linuxserver/hedgedoc

HedgeDoc 让您随时随地访问所有文件。

HedgeDoc是一款实时、多平台协作的Markdown笔记编辑器。这意味着您可以在桌面、平板甚至手机上与他人共同编写笔记。您可以在首页通过多种认证提供商（如***、***、GitHub等）登录。

![hedgedoc]([***]

支持的架构

我们利用Docker清单实现多平台支持。更多信息可参考Docker的文档和我们的公告。

只需拉取 lscr.io/linuxserver/hedgedoc:latest 即可获取适合您架构的正确镜像，您也可以通过标签拉取特定架构的镜像。

此镜像支持的架构：

应用设置

HedgeDoc Web界面可通过 [***]{IP}:3000/ 访问。如果您想使用自定义域名或非3000端口，需要利用其环境变量设置回调（特别是CMD_DOMAIN、CMD_PORT和CMD_URL_ADDPORT）。

HedgeDoc完整配置选项列表

为方便起见，本文档提供了一个使用Mariadb作为后端的工作示例。

若要在反向代理后运行，我们在SWAG镜像中提供了一个使用Docker网络的预配置配置，您可以在反向代理配置仓库中了解如何使用。

使用方法

为帮助您快速从该镜像创建容器，您可以使用docker-compose或docker命令行。

[!NOTE] 除非参数标记为“可选”，否则为必填项，必须提供值。

docker-compose（推荐，点击此处了解更多信息）

yaml
---
services:
  hedgedoc:
    image: lscr.io/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'] #可选
      - CMD_DB_DIALECT= #可选
    volumes:
      - /path/to/hedgedoc/config:/config
    ports:
      - 3000:3000
    restart: unless-stopped

docker cli（点击此处了解更多信息）

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'] `#可选` \
  -e CMD_DB_DIALECT= `#可选` \
  -p 3000:3000 \
  -v /path/to/hedgedoc/config:/config \
  --restart unless-stopped \
  lscr.io/linuxserver/hedgedoc:latest

参数

容器通过运行时传递的参数进行配置（如上所示）。这些参数用冒号分隔，表示<外部>:<内部>。例如，-p 8080:80会将容器内的80端口暴露到主机IP的8080端口。

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

您可以使用特殊前缀FILE__从文件中设置任何环境变量。

例如：

bash
-e FILE__MYVAR=/run/secrets/mysecretvariable

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

应用程序的Umask设置

对于我们所有的镜像，您可以使用可选的-e UMASK=022设置覆盖容器内服务的默认umask设置。请注意，umask不是chmod，它基于其值减去权限，而不是添加。请在请求支持前了解更多。

用户/组标识符

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

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

在此示例中，PUID=1000和PGID=1000，您可以通过以下命令查找您的用户ID：

bash
id your_user

示例输出：

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

Docker Mods

我们发布了各种Docker Mods，以启用容器内的附加功能。此镜像可用的Mods列表（如有）以及可应用于我们任何镜像的通用Mods可通过上方的动态徽章访问。

支持信息

• 容器运行时的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
  

更新信息

我们的大多数镜像是静态的、版本化的，需要更新镜像并重新创建容器才能更新内部的应用程序。除了某些例外情况（在相关readme.md中注明），我们不建议或支持在容器内更新应用程序。请参阅上文的应用设置部分，了解是否推荐对此镜像进行更新。

以下是更新容器的说明：

通过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 lscr.io/linuxserver/hedgedoc:latest
  

• 停止运行中的容器：

  bash
  docker stop hedgedoc
  

• 删除容器：

  bash
  docker rm hedgedoc
  

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

• 您还可以删除旧的悬空镜像：

  bash
  docker image prune
  

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

[!TIP] 我们推荐使用Diun获取更新通知。不推荐或支持其他自动更新容器的工具。

本地构建

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

bash
git clone [***]
cd docker-hedgedoc
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/hedgedoc:latest .

可以使用lscr.io/linuxserver/qemu-static在x86_64硬件上构建ARM变体，反之亦然：

bash
docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset

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

版本历史

• 14.10.25： - 基于Alpine 3.22重新构建。
• 24.02.25： - 添加缺失的icu-data-full以修复TextDecoder和图片上传的bug。
• 21.06.24： - 允许使用CMD_DB_DIALECT设置CMD_DB_URL。
• 06.06.24： - 基于Alpine 3.20重新构建。
• 23.12.23： - 基于Alpine 3.19重新构建。
• 18.06.23： - 基于Alpine 3.18重新构建，根据[***]
• 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： - 初始发布