lobehub/docs/Environment-Variable.zh-CN.md
2023-10-12 21:21:47 +08:00

4 KiB
Raw Blame History

LobeChat 环境变量

LobeChat 在部署时提供了一些额外的配置项,使用环境变量进行设置

TOC

通用变量

ACCESS_CODE

  • 类型:可选
  • 描述:添加访问 LobeChat 服务的密码,密码应为 6 位数字或字母
  • 默认值:-
  • 示例:awCT74e3@09!

OpenAI

OPENAI_API_KEY

  • 类型:必选
  • 描述:这是你在 OpenAI 账户页面申请的 API 密钥,可以前往这里查看
  • 默认值:-
  • 示例:sk-xxxxxx...xxxxxx

OPENAI_PROXY_URL

  • 类型:可选
  • 描述:如果你手动配置了 OpenAI 接口代理,可以使用此配置项来覆盖默认的 OpenAI API 请求基础 URL
  • 默认值:https://api.openai.com
  • 示例:https://api.chatanywhere.cn

Azure OpenAI

如果你需要使用 Azure OpenAI 来提供模型服务,可以查阅 使用 Azure OpenAI 部署 章节查看详细步骤,这里将列举和 Azure OpenAI 相关的环境变量。

USE_AZURE_OPENAI

  • 类型:可选
  • 描述:设置该值为 1 开启 Azure OpenAI 配置
  • 默认值:-
  • 示例:1

AZURE_API_KEY

  • 类型:可选
  • 描述:这是你在 Azure OpenAI 账户页面申请的 API 密钥
  • 默认值:-
  • 示例:c55168be3874490ef0565d9779ecd5a6

AZURE_API_VERSION

  • 类型:可选
  • 描述Azure 的 API 版本,遵循 YYYY-MM-DD 格式
  • 默认值:2023-08-01-preview
  • 示例:2023-05-15,查阅最新版本

插件服务

PLUGINS_INDEX_URL

  • 类型:可选
  • 描述LobeChat 插件市场的索引地址,如果你自行部署了插件市场的服务,可以使用该变量来覆盖默认的插件市场地址
  • 默认值:https://chat-plugins.lobehub.com

角色服务

AGENTS_INDEX_URL

  • 类型:可选
  • 描述LobeChat 角色市场的索引地址,如果你自行部署了角色市场的服务,可以使用该变量来覆盖默认的插件市场地址
  • 默认值:https://chat-agents.lobehub.com

数据统计

Vercel Analytics

NEXT_PUBLIC_ANALYTICS_VERCEL

  • 类型:可选
  • 描述:用于配置 Vercel Analytics 的环境变量,当设为 0 则关闭 Vercel Analytics
  • 默认值: -
  • 示例:0

NEXT_PUBLIC_VERCEL_DEBUG

  • 类型:可选
  • 描述:用于开启 Vercel Analytics 的调试模式
  • 默认值: -
  • 示例:1

Posthog Analytics

NEXT_PUBLIC_ANALYTICS_POSTHOG

  • 类型:可选
  • 描述:用于开启 PostHog Analytics 的环境变量,设为 1 时开启 PostHog Analytics
  • 默认值: -
  • 示例:1

NEXT_PUBLIC_POSTHOG_KEY

  • 类型:可选
  • 描述:设置 PostHog 项目 Key
  • 默认值: -
  • 示例:phc_xxxxxxxx

NEXT_PUBLIC_POSTHOG_HOST

  • 类型:可选
  • 描述:设置 PostHog 服务的部署地址,默认为官方的 SAAS 地址
  • 默认值:https://app.posthog.com
  • 示例:https://example.com

NEXT_PUBLIC_POSTHOG_DEBUG

  • 类型:可选
  • 描述:开启 PostHog 的调试模式
  • 默认值: -
  • 示例:1