Skip to main content
LibreChat is joining ClickHouse to power the open-source Agentic Data Stack 🎉 Learn more
LibreChat

Helm Chart

使用 Helm 在 Kubernetes 上部署 LibreChat 的说明

请遵循本指南使用 Helm 在 Kubernetes 上部署 LibreChat,并根据您的具体用例进行调整。社区贡献的其他 Helm chart 列在下方的 Community Helm Charts 部分。

先决条件

  • 一个正在运行的 Kubernetes 集群
  • 本地 安装的 kubectl 和 Helm

配置

  1. 使用 Credentials GeneratorCREDS_KEYJWT_SECRETJWT_REFRESH_SECRETMEILI_MASTER_KEY 生成安全值。

将它们放入 Kubernetes Secret 中,如下所示(如果您更改了 secret 名称,请记得更新您的 Helm values):

apiVersion: v1
kind: Secret
metadata:
  name: librechat-credentials-env
  namespace: <librechat-chart-namespace>
type: Opaque
stringData:
  CREDS_KEY: <generated value>
  JWT_SECRET: <generated value>
  JWT_REFRESH_SECRET: <generated value>
  MEILI_MASTER_KEY: <generated value>
  1. 将任何所需的 LLM 提供商 API 密钥添加到此相同的 secret 中:
apiVersion: v1
kind: Secret
metadata:
  name: librechat-credentials-env
  namespace: <librechat-chart-namespace>
. . . .
 
  OPENAI_API_KEY: <your secret value>
  1. 将 Secret 应用到集群:

安装 Helm Chart

要安装 helm chart,请运行:

helm install <deployment-name> oci://ghcr.io/danny-avila/librechat-chart/librechat

开发版本

在仓库的根目录下,运行:

helm install <deployment-name> ./helm/librechat

与其他 Helm chart 类似,这里存在一个 values file,它概述了默认设置并指出了可以修改的配置选项。

创建一个 values.yaml 文件,并填入你想要从默认配置中修改的值。

安装 Helm chart:helm install librechat oci://ghcr.io/danny-avila/librechat-chart/librechat --values <values-override-filel>

卸载 Helm Chart

要卸载 Helm Chart,请运行:helm uninstall <deployment-name>

示例:helm uninstall librechat

迁移 1.x -> 2.x

如果您在 2.x 版本之前使用过该 chart,您可能需要更新 value 结构。

  1. 将配置移动到 librechat.configEnv:
- env:
-     ALLOW_EMAIL_LOGIN: "true"
-     ALLOW_REGISTRATION: "true"
+ librechat:
+   configEnv:
+     ALLOW_REGISTRATION: "true"
+     ALLOW_EMAIL_LOGIN: "true"
  1. 将所有 Secret 值合并为一个 Secret,如 Configuration Step 1 所述。
  2. 若要使用外部 MongoDB 实例,请参考该 Chart 的 values file,相应地停用组件并更改 Mongodb 实例的 FQDN。如果该外部管理的 MongoDB 实例中已存在数据,则建议采用此方法。

社区 Helm Charts

这篇指南怎么样?