docs(ntfy): 添加环境变量注释说明

为ntfy服务的环境变量配置添加详细的中文注释,说明每个变量的用途和配置意义,便于后续维护和理解配置项。
This commit is contained in:
cnphpbb
2025-09-02 16:06:03 +08:00
parent 2b1e6aaed0
commit 3a3ada7247

View File

@@ -15,19 +15,20 @@ services:
ports: ports:
- '5480:80' - '5480:80'
environment: environment:
- TZ=Asia/Shanghai - TZ=Asia/Shanghai # 时区设置为上海时区
- NTFY_BASE_URL=<http://ntfy:80> - NTFY_BASE_URL=<http://ntfy:80> # ntfy服务的基础访问URL协议+主机+端口)
- NTFY_CACHE_FILE=/var/lib/ntfy/cache.db #缓存数据 - NTFY_CACHE_FILE=/var/lib/ntfy/cache.db # 缓存数据的存储文件路径
- NTFY_AUTH_FILE=/var/lib/ntfy/auth.db #授权数据 - NTFY_AUTH_FILE=/var/lib/ntfy/auth.db # 授权信息(如用户认证数据)的存储文件路径
- NTFY_AUTH_DEFAULT_ACCESS=deny-all #禁用非授权访问 - NTFY_AUTH_DEFAULT_ACCESS=deny-all # 默认访问权限:禁止所有未授权访问
- NTFY_BEHIND_PROXY=true - NTFY_BEHIND_PROXY=true # 标识ntfy服务运行在代理服务器后方如Nginx等
- NTFY_ATTACHMENT_CACHE_DIR=/var/lib/ntfy/attachments #设置附件缓存目录 - NTFY_ATTACHMENT_CACHE_DIR=/var/lib/ntfy/attachments # 附件资源的缓存存储目录
- NTFY_ENABLE_LOGIN=true #开启登录授权访问 - NTFY_ENABLE_LOGIN=true # 启用登录功能,允许用户通过账号密码授权访问
- NTFY_WEB_PUSH_PUBLIC_KEY= <public_key> - NTFY_WEB_PUSH_PUBLIC_KEY= <public_key> # Web推送功能的公钥用于消息加密
- NTFY_WEB_PUSH_PRIVATE_KEY= <private_key> - NTFY_WEB_PUSH_PRIVATE_KEY= <private_key> # Web推送功能的私钥与公钥配对用于解密/签名)
- NTFY_WEB_PUSH_FILE=/var/lib/ntfy/webpush.db #设置web推送数据文件 - NTFY_WEB_PUSH_FILE=/var/lib/ntfy/webpush.db # Web推送相关的数据存储文件路径
- NTFY_WEB_PUSH_EMAIL_ADDRESS= <email> - NTFY_WEB_PUSH_EMAIL_ADDRESS= <email> # Web推送关联的邮件地址用于通知等场景
- NTFY_ENABLE_SIGNUP=false - NTFY_ENABLE_SIGNUP=false # 禁用用户注册功能,阻止新用户自主创建账号
- NTFY_ENABLE_METRICS=true # 启用指标收集功能,用于监控和分析服务运行状态
volumes: volumes:
- /etc/localtime:/etc/localtime:ro - /etc/localtime:/etc/localtime:ro
- /etc/timezone:/etc/timezone:ro - /etc/timezone:/etc/timezone:ro