用户设置环境变量配置
指导开发者在服务端定义环境变量以作为用户配置的默认值,并完成类型声明、全局配置组装与文档同步。
功能与用途
该指南针对 LobeHub/LobeChat 架构规范,指导开发者为用户端设置项新增对应的服务端环境变量。当用户未自定义配置时,系统将回退使用环境变量配置,最后回退至硬编码默认值。流程覆盖在 packages/env 中通过 Zod 校验定义变量、在 types 中扩展 ServerConfig 接口、在 apps/server 中合并全局配置、在客户端 store 中下发状态,以及同步更新 .env.example 和中英文部署文档。
适用场景
- 新增用户设置默认环境变量:为生图数量或接口配置等设置项编写Zod验证,使服务端变量可无缝兜底用户未配置项。
- 私有化部署全局策略下发:通过在服务端定义默认环境变量,让自建实例在启动时自动向客户端注入预设配置。
- 配置类型与部署文档同步:扩展ServerConfig全局接口并更新.env.example,保持中英文部署文档与代码规范一致。
适用人群
- LobeChat 开源贡献者
- 二次开发全栈工程师
- 私有化部署运维人员
使用步骤
- 在 packages/env/src/<domain>.ts 中使用 createEnv 和 Zod 定义服务端环境变量及其校验规则
- 在 packages/types/src/serverConfig.ts 中将对应领域配置扩充到 GlobalServerConfig 接口
- 在 apps/server/src/globalConfig/index.ts 中将环境变量组装至全局配置对象
- 在客户端状态切片 src/store/user/slices/common/action.ts 中合并服务端下发的默认配置
- 在 .env.example 及 docs/self-hosting 目录下同步更新中英文环境变量说明文档
开始使用
将需求和 Skill 名称发送给已连接 SkillPX MCP 的 AI 助手,核对适用工具和安装要求。
技术信息
- 分类
- 编程
- 适用工具
- Codex、Claude Code、OpenClaw、Hermes、国内 Agent
- 使用难度
- 进阶
- 版本
- main
- 最近更新
- 2026-09-23
- 文件数
- 3
- 安装包大小
- 自动生成 ZIP
- 安全检查
- 基础检查通过
Add server-side environment variables that control default values for user settings.
依赖与权限
- 读取用户主动提供的内容