Back to Lobehub

LobeHub 特性标志环境变量配置指南

docs/self-hosting/advanced/feature-flags.zh-CN.mdx

2.1.565.0 KB
Original Source

特性标志

除了基础的环境变量配置外,LobeHub 还提供了一些特性标志(Feature Flags),用于控制是否全局启用某个功能,或者根据需要对特定用户群体或环境启用或禁用功能。

特性标志环境变量 FEATURE_FLAGS

  • 类型:可选
  • 描述:用于控制 LobeHub 的特性功能,支持多个功能标志,使用 + 增加一个功能,使用 - 来关闭一个功能,多个功能标志之间使用英文逗号 , 隔开,最外层建议添加引号 " 以避免解析错误。
  • 默认值:-
  • 示例:"-welcome_suggest"

所有的功能统一以特性标志 FEATURE_FLAGS 作为唯一的配置变量。

你可以通过上述配置语法来实现更多的功能组合。所有的功能配置项都是布尔类型,通过 + 来启用,通过 - 来关闭。

<Callout type={'tip'}> 注意:与 OPENAI_MODEL_LIST 变量不同,FEATURE_FLAGS 变量不支持 all 关键字,你需要手动控制所有的功能标志(否则它们会采用对应的默认值)。 </Callout>

配置项解释默认值
check_updates允许检查更新。开启
pin_list控制侧边栏中置顶助手列表的显示。关闭
language_model_settings启用语言模型设置。开启
provider_settings控制模型供应商设置的显示。开启
openai_api_key允许用户自定义 OpenAI API Key。开启
openai_proxy_url允许用户自定义 OpenAI 代理 URL。开启
api_key_manage控制 API 密钥管理页面 (/profile/apikey) 的访问。关闭
create_session允许用户创建会话。开启
edit_agent允许用户编辑助手。开启
plugins控制聊天和助手设置中的插件功能。开启
dalle启用 DALL-E 功能。开启
ai_image控制 AI 图像生成功能和页面 (/image)。开启
speech_to_text启用语音转文本功能。开启
token_counter保留用于令牌计数器显示。开启
welcome_suggest显示欢迎建议。开启
changelog控制更新日志弹窗 / 页面的显示。开启
market启用助手市场功能。开启
knowledge_base启用知识库功能。开启
rag_eval控制 RAG 评估功能 (/repos/[id]/evals)。关闭
cloud_promotion控制用户菜单中云服务推广链接的显示。关闭
commercial_hide_github隐藏设置页面底部的 GitHub 相关链接(需要商业授权)。关闭
commercial_hide_docs隐藏文档和帮助菜单,包括更新日志、文档和反馈(需要商业授权)。关闭

你可以随时检查 featureFlags 以获取最新的特性标志列表。

独立功能启用 / 禁用变量

除了上述 FEATURE_FLAGS 体系外,LobeHub 还提供了一批独立的环境变量,用于控制依赖外部基础设施的特定功能。这些是独立变量(不属于 FEATURE_FLAGS):

环境变量默认值说明依赖
ENABLED_ARTIFACTS1启用 Artifacts 面板(Claude 风格的代码 / SVG/React 预览)
ENABLED_MCP1启用模型上下文协议(MCP)插件系统
ENABLED_UPLOAD1启用文件上传功能S3 兼容存储
ENABLED_KNOWLEDGE_BASE1启用知识库和 RAG 功能S3 存储 + PostgreSQL
ENABLED_WEB_SEARCH1启用网络搜索集成(在线搜索)Searxng 或搜索插件

设置为 0 可禁用对应功能。例如,若未配置 S3 存储,可禁用文件上传:

bash
ENABLED_UPLOAD=0
ENABLED_KNOWLEDGE_BASE=0

<Callout type={'info'}> 如果未配置 S3 兼容存储,应将 ENABLED_UPLOADENABLED_KNOWLEDGE_BASE 设为禁用状态,否则文件相关操作将会失败。 </Callout>