docs/self-hosting/environment-variables/basic.zh-CN.mdx
LobeHub 在部署时提供了一些额外的配置项,你可以使用环境变量进行自定义设置。
KEY_VAULTS_SECRETKix2wcUONd4CX51E/ZPAd36BqM4wzJgKjPtz2sGztqQ=<Callout type={'warning'}> 此密钥用于加密敏感数据,一旦设置后请勿更改,否则已加密的数据将无法解密。 </Callout>
<GenerateSecret envName="KEY_VAULTS_SECRET" />API_KEY_SELECT_MODErandom 和 turnrandomrandom 或 turn使用 random 模式下,将在多个 API Keys 中随机获取一个 API Key。
使用 turn 模式下,将按照填写的顺序,轮询获取得到 API Key。
DEFAULT_AGENT_CONFIG-'model=gpt-4-1106-preview;params.max_tokens=300;plugins=search-engine,lobe-image-designer'DEFAULT_AGENT_CONFIG 用于配置 LobeHub 默认助理的默认配置。它支持多种数据类型和结构,包括键值对、嵌套字段、数组值等。下表详细说明了 DEFAULT_AGENT_CONFIG 环境变量的配置项、示例以及相应解释:
| 配置项类型 | 示例 | 解释 |
|---|---|---|
| 基本键值对 | model=gpt-4 | 设置模型为 gpt-4。 |
| 嵌套字段 | tts.sttLocale=en-US | 设置文本到语音服务的语言区域为 en-US。 |
| 数组 | plugins=search-engine,lobe-image-designer | 启用 search-engine 和 lobe-image-designer 插件。 |
| 中文逗号 | plugins=search-engine,lobe-image-designer | 同上,演示支持中文逗号分隔。 |
| 多个配置项 | model=glm-4;provider=zhipu | 设置模型为 glm-4 且模型服务商为 zhipu。 |
| 数字值 | params.max_tokens=300, chatConfig.historyCount=5 | 设置最大令牌数为 300,设置历史消息条数为 5。 |
| 布尔值 | chatConfig.enableAutoCreateTopic=true,chatConfig.enableCompressThreshold=true, chatConfig.enableHistoryCount=true | 启用自动创建主题,历史长度压缩阈值,历史记录条数。 |
| 特殊字符 | inputTemplate="Hello; I am a bot;" | 设置输入模板为 Hello; I am a bot;。 |
| 错误处理 | model=gpt-4;maxToken | 忽略无效条目 maxToken,仅解析出 model=gpt-4。 |
| 值覆盖 | model=gpt-4;model=gpt-4-1106-preview | 如果键重复,使用最后一次出现的值,此处 model 的值为 gpt-4-1106-preview。 |
相关阅读:
SYSTEM_AGENT-default=ollama/deepseek-v3 或 topic=openai/gpt-4,translation=anthropic/claude-1SYSTEM_AGENT 环境变量支持两种配置方式:
default=供应商/模型 为所有系统助手设置相同的默认配置助手名称=供应商/模型配置项说明:
| 配置项 | 格式 | 解释 |
|---|---|---|
| 默认设置 | default=ollama/deepseek-v3 | 为所有系统助手设置默认模型为 ollama 的 deepseek-v3 |
| 特定设置 | topic=openai/gpt-4 | 为主题生成设置特定的供应商和模型 |
| 混合配置 | default=ollama/deepseek-v3,topic=openai/gpt-4 | 先为所有助手设置默认值,然后针对特定助手进行覆盖 |
可配置的系统助手及其作用:
| 系统助手 | 键名 | 作用描述 |
|---|---|---|
| 主题生成 | topic | 根据聊天内容自动生成主题名称和摘要 |
| 翻译 | translation | 文本翻译使用的助手 |
| 元数据生成 | agentMeta | 为助手生成描述性信息和元数据 |
| 历史记录压缩 | historyCompress | 压缩和整理长对话的历史记录,优化上下文管理 |
| 分支对话 | thread | 自定生成分支对话的标题 |
FEATURE_FLAGS+ 增加一个功能,使用 - 来关闭一个功能,多个功能标志之间使用英文逗号 , 隔开,最外层建议添加引号 " 以避免解析错误。-"-welcome_suggest"具体的内容可以参见 特性标志 中的说明。
PROXY_URLhttp://127.0.0.1:7890 或 socks5://localhost:7891ENABLE_PROXY_DNS0 时所有 DNS 查询在本地完成,当你的网络环境无法访问 API 或访问超时,请尝试将该项配置为 1。01 or 0SSRF_ALLOW_PRIVATE_IP_ADDRESS1 时将关闭 SSRF 防护并允许所有私有 IP 地址。在可信环境(如内网部署)中,可以启用此选项以访问内部资源。01 或 0应用场景:
LobeHub 会在以下场景执行 SSRF 安全检查:
图片 / 视频 URL 转 Base64:在处理媒体消息时(例如视觉模型、多模态模型),LobeHub 会将图片和视频 URL 转换为 base64 格式。此检查可防止恶意用户通过媒体 URL 访问内网资源。
举例:
http://192.168.1.100/admin/secrets.pnghttp://10.0.0.50/internal/meeting.mp4若无 SSRF 防护,这些请求可能导致内网资源泄露。
网页爬取:使用网页爬取功能获取外部内容时。
代理请求:代理外部 API 请求时。
配置示例:
# 场景 1:公网部署(推荐)
# 阻止所有私有 IP 访问,保证安全
SSRF_ALLOW_PRIVATE_IP_ADDRESS=0
# 场景 2:内网部署
# 允许所有私有 IP,可访问内网图片服务器等资源
SSRF_ALLOW_PRIVATE_IP_ADDRESS=1
# 场景 3:混合部署(最常见)
# 默认阻止私有 IP,但允许特定可信的内网服务器
SSRF_ALLOW_PRIVATE_IP_ADDRESS=0
SSRF_ALLOW_IP_ADDRESS_LIST=192.168.1.100,10.0.0.50
SSRF_ALLOW_IP_ADDRESS_LISTSSRF_ALLOW_PRIVATE_IP_ADDRESS 为 0 时生效。使用此选项可以在保持 SSRF 防护的同时,允许访问特定的内网 IP 地址。192.168.1.100,10.0.0.50,172.16.0.10常见使用场景:
192.168.1.10010.0.0.50172.16.0.10NEXT_PUBLIC_ASSET_PREFIXhttps://cdn.example.comAI_IMAGE_DEFAULT_IMAGE_NUM461-20此环境变量允许管理员为其部署自定义默认图片生成数量。值必须在 1 到 20 之间。如果未设置,默认为 4。用户仍可在个人设置中调整此值。
PLUGINS_INDEX_URLhttps://chat-plugins.lobehub.comPLUGIN_SETTINGS插件名:设置字段=设置值 的格式来配置插件的设置,多个设置字段用英文分号 ; 隔开,多个插件设置使用英文逗号,隔开。-search-engine:SERPAPI_API_KEY=xxxxx,plugin-2:key1=value1;key2=value2上述示例表示设置 search-engine 插件的 SERPAPI_API_KEY 为 xxxxx,设置 plugin-2 的 key1 为 value1,key2 为 value2。生成的插件设置配置如下:
{
"plugin-2": {
"key1": "value1",
"key2": "value2"
},
"search-engine": {
"SERPAPI_API_KEY": "xxxxx"
}
}
AGENTS_INDEX_URLhttps://chat-agents.lobehub.com