docs/settings-help.md
设置页配置帮助用于把配置项的关键说明放到 WebUI 内部,减少用户在设置页和文档之间反复切换。页面上仍保留短描述,详细说明通过配置项标题旁的 help icon 打开。
本文只说明帮助系统的维护规则,不替代完整配置文档。配置语义、默认值、运行时优先级和排障细节仍以 .env.example、docs/full-guide.md 及对应专题文档为事实源。
后端配置注册表在 src/core/config_registry.py 中为字段追加帮助元数据:
help_key:前端多语言帮助文案的稳定 key。examples:可直接展示的配置样例。敏感字段只能使用占位符,例如 sk-xxxx、your_token。docs:相关文档链接,优先指向仓库内已有专题文档或完整指南。warning_codes:面向前端或后续校验扩展的稳定提示 code。前端长文案维护在 apps/dsa-web/src/locales/settingsHelp.ts:
PR1 覆盖基础设施与首批代表性配置项:
STOCK_LISTLITELLM_MODELLLM_CHANNELSFEISHU_WEBHOOK_URLWEBUI_HOSTPR2 继续覆盖高频、易填错配置项:
后续 PR 可以继续覆盖 Agent、回测、报告高级字段、日志、数据库、桌面端和更细分部署配置。
settingsHelp.ts 中的 settings.llm_channel.* 系列为 LLM 渠道编辑器内部字段说明,仅用于前端渲染,不对应 .env 的单独配置项;这是 PR2 中刻意的“内置扩展”设计,用于提升编辑器可用性。src/core/config_registry.py 中某个字段的 help_key 映射到后端注册元数据,便于与文档源、warning_codes 一起统一维护。新增或修改帮助文案时,优先从以下位置核对:
.env.example:配置键名、默认值、样例格式和敏感占位符。docs/full-guide.md:主要配置说明、运行入口和部署上下文。docs/LLM_CONFIG_GUIDE.md、docs/llm-providers.md:LLM 优先级、Channels、provider/model、兼容边界和排障说明。docs/bot/feishu-bot-config.md、docs/deploy-webui-cloud.md、docs/desktop-package.md。.env 写回或环境变量覆盖语义。设置页保存通常只写入 .env 并触发可运行时重载的配置刷新。帮助文案和 warning_codes 必须显式区分以下情况:
WEBUI_HOST、WEBUI_PORT:监听地址和端口只在进程启动时绑定,保存后必须重启当前进程、Docker 容器或服务管理器才会生效。RUN_IMMEDIATELY:非 schedule 模式启动期单次运行配置,保存后不会让已运行的 WebUI/API 进程立即触发分析。SCHEDULE_ENABLED、SCHEDULE_RUN_IMMEDIATELY:schedule 模式启动行为,保存后不会启动、停止或重建当前 scheduler,需要以 schedule 模式重启后生效。SCHEDULE_TIME:不是重启必需项。已运行的 schedule 模式会在下一轮调度检查中读取新时间并重建 daily job;但如果当前进程未以 schedule 模式启动,保存该字段不会自动创建 scheduler。