SuperAPI AI 工具集

dify-docs-env-vars

部署与运维

查看项目

更新于 10-15 23:48

技能介绍

用途:这是 Dify 文档仓库中针对自托管环境变量参考页(en/self-host/deploy/configuration/environments.mdx)的规则包,不是独立入口,需在 dify-docs-write 流程下运行,实现其各阶段。

主要能力:规定变量追踪流程(S2→S6),按变量类型区分追踪深度:Python 配置变量(api/configs/)做完整追踪;前端变量追踪 web/docker/entrypoint.sh 的 Docker 到 NEXT_PUBLIC_* 映射;Docker/容器服务变量从 .env.example 注释记录;插件守护进程变量(PLUGIN_*)同样从注释记录。要求为每个变量写通俗解释与面向用户的描述,描述以实际影响开头、点名依赖功能、说明配置错误后果与回退行为,并遵守 references/style-overrides.md 的风格规则。

使用方式:编辑文档后运行校验脚本,规范命令同时扫描两个环境变量来源: python3 .claude/skills/dify-docs-env-vars/verify-env-docs.py
--env-example <path-to-dify-repo>/docker/.env.example
--env-example <path-to-dify-repo>/docker/envs
--compose <path-to-dify-repo>/docker
--docs en/self-host/deploy/configuration/environments.mdx --env-example 可重复,目录参数会递归匹配 **/*.env.example。输出契约:完全干净时最后一行是 ALL CHECKS PASSED 并退出 0,否则打印 TOTAL ISSUES: <n> 并退出 1。

适用场景:面向部署 Dify 的 DevOps 工程师与系统管理员,按子系统分组变量,使用表格、独立标题、标签页与折叠面板组织内容。

限制:变量来源以 docker/.env.example 与 docker/envs/**/*.env.example 为准;仅存在于 api/configs/ Pydantic 而未出现在 .env.example 的变量不记录;已弃用但仍在解析的变量保留并标注替代项;代码不再读取的变量从文档移除。忽略列表位于私有 registry 的 guides/env-ignored-vars.md,可通过 $DIFY_DOCS_REGISTRY 或 --ignored PATH 指定。其余细节暂未提供。