linuxserver/hedgedocHedgeDoc 让您随时随地访问所有文件。
HedgeDoc是一款实时、多平台协作的Markdown笔记编辑器。这意味着您可以在桌面、平板甚至手机上与他人共同编写笔记。您可以在首页通过多种认证提供商(如***、***、GitHub等)登录。
。
HedgeDoc完整配置选项列表
为方便起见,本文档提供了一个使用Mariadb作为后端的工作示例。
若要在反向代理后运行,我们在SWAG镜像中提供了一个使用Docker网络的预配置配置,您可以在反向代理配置仓库中了解如何使用。
为帮助您快速从该镜像创建容器,您可以使用docker-compose或docker命令行。
[!NOTE] 除非参数标记为“可选”,否则为必填项,必须提供值。
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
bashdocker 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端口。
| 参数 | 功能 |
|---|---|
-p 3000:3000 | Web界面端口(如果使用非80、443和3000端口访问,内部端口也需要更改)。 |
-e PUID=1000 | 用户ID - 详见下文说明 |
-e PGID=1000 | 组ID - 详见下文说明 |
-e TZ=Etc/UTC | 指定时区,详见列表。 |
-e DB_HOST=<主机名或IP> | MariaDB数据库主机地址 |
-e DB_PORT=3306 | MariaDB数据库端口,默认为3306 |
-e DB_USER=hedgedoc | 数据库用户 |
-e DB_PASS=<密码> | 数据库密码 |
-e DB_NAME=hedgedoc | 数据库名称 |
-e CMD_DOMAIN=localhost | 访问界面的地址(例如:192.168.1.1 或 hedgedoc.domain.com)。 |
-e CMD_URL_ADDPORT=false | 如果使用非80或443端口,设为true。 |
-e CMD_PROTOCOL_USESSL=false | 通过反向代理使用https访问时设为true。 |
-e CMD_PORT=3000 | 如果要使用非80、443或3000端口访问HedgeDoc,需将此项设为该端口(例如:CMD_PORT=5000),并相应更改端口映射(5000:5000)。 |
-e CMD_ALLOW_ORIGIN=['localhost'] | 逗号分隔的允许主机名列表 |
-e CMD_DB_DIALECT= | 此变量允许选择数据库引擎(如果未设置DB_HOST)。可用选项:mariadb、mysql、postgres、sqlite。 |
-v /config | 持久化配置文件 |
您可以使用特殊前缀FILE__从文件中设置任何环境变量。
例如:
bash-e FILE__MYVAR=/run/secrets/mysecretvariable
将根据/run/secrets/mysecretvariable文件的内容设置环境变量MYVAR。
对于我们所有的镜像,您可以使用可选的-e UMASK=022设置覆盖容器内服务的默认umask设置。请注意,umask不是chmod,它基于其值减去权限,而不是添加。请在请求支持前了解更多。
使用卷(-v标志)时,主机操作系统和容器之间可能会出现权限问题,我们通过允许您指定用户PUID和组PGID来避免此问题。
确保主机上的任何卷目录都由您指定的同一用户拥有,权限问题将迎刃而解。
在此示例中,PUID=1000和PGID=1000,您可以通过以下命令查找您的用户ID:
bashid your_user
示例输出:
textuid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
我们发布了各种Docker Mods,以启用容器内的附加功能。此镜像可用的Mods列表(如有)以及可应用于我们任何镜像的通用Mods可通过上方的动态徽章访问。
容器运行时的Shell访问:
bashdocker exec -it hedgedoc /bin/bash
实时监控容器日志:
bashdocker logs -f hedgedoc
容器版本号:
bashdocker inspect -f '{{ index .Config.Labels "build_version" }}' hedgedoc
镜像版本号:
bashdocker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/hedgedoc:latest
我们的大多数镜像是静态的、版本化的,需要更新镜像并重新创建容器才能更新内部的应用程序。除了某些例外情况(在相关readme.md中注明),我们不建议或支持在容器内更新应用程序。请参阅上文的应用设置部分,了解是否推荐对此镜像进行更新。
以下是更新容器的说明:
更新镜像:
所有镜像:
bashdocker-compose pull
单个镜像:
bashdocker-compose pull hedgedoc
更新容器:
所有容器:
bashdocker-compose up -d
单个容器:
bashdocker-compose up -d hedgedoc
您还可以删除旧的悬空镜像:
bashdocker image prune
更新镜像:
bashdocker pull lscr.io/linuxserver/hedgedoc:latest
停止运行中的容器:
bashdocker stop hedgedoc
删除容器:
bashdocker rm hedgedoc
使用上述相同的docker run参数重新创建新容器(如果正确映射到主机文件夹,您的/config文件夹和设置将被保留)
您还可以删除旧的悬空镜像:
bashdocker image prune
[!TIP] 我们推荐使用Diun获取更新通知。不推荐或支持其他自动更新容器的工具。
如果您想对这些镜像进行本地修改以用于开发目的或自定义逻辑:
bashgit clone [***] cd docker-hedgedoc docker build \ --no-cache \ --pull \ -t lscr.io/linuxserver/hedgedoc:latest .
可以使用lscr.io/linuxserver/qemu-static在x86_64硬件上构建ARM变体,反之亦然:
bashdocker run --rm --privileged lscr.io/linuxserver/qemu-static --reset
注册后,您可以使用-f Dockerfile.aarch64指定要使用的dockerfile。
CMD_DB_DIALECT设置CMD_DB_URL。CMD_PORT,用于访问非80、443和3000的端口。CMD_PROTOCOL_USESSL,用于反向代理。CMD_DOMAIN。manifest unknown 错误
TLS 证书验证失败
DNS 解析超时
410 错误:版本过低
402 错误:流量耗尽
身份认证失败错误
429 限流错误
凭证保存错误
来自真实用户的反馈,见证轩辕镜像的优质服务