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

Chart Helm

Instructions pour déployer LibreChat sur Kubernetes avec Helm

Veuillez suivre ces instructions pour déployer LibreChat sur Kubernetes en utilisant Helm, en les adaptant selon vos besoins spécifiques. D'autres charts Helm fournis par la communauté sont listés ci-dessous dans la section Community Helm Charts.

Prérequis

  • Un cluster Kubernetes en cours d'exécution
  • Installations locales de kubectl et Helm

Configuration

  1. Utilisez le Credentials Generator pour générer des valeurs sécurisées pour CREDS_KEY, JWT_SECRET, JWT_REFRESH_SECRET et MEILI_MASTER_KEY. Placez-les dans un Kubernetes Secret comme ceci (si vous modifiez le nom du secret, n'oubliez pas de mettre à jour vos valeurs Helm) :
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. Ajoutez à ce même secret toutes les clés API requises pour les fournisseurs de LLM :
apiVersion: v1
kind: Secret
metadata:
  name: librechat-credentials-env
  namespace: <librechat-chart-namespace>
. . . .
 
  OPENAI_API_KEY: <your secret value>
  1. Appliquer le Secret au Cluster :

Installer le Helm Chart

Pour installer le helm chart, exécutez :

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

Version de développement

Dans le répertoire racine du dépôt, exécutez :

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

Tout comme pour les autres charts Helm, il existe un values file qui décrit les paramètres par défaut et indique quelles options de configuration peuvent être modifiées.

Créez un fichier values.yaml rempli avec les valeurs que vous souhaitez modifier par rapport à celles par défaut.

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

Désinstaller le Helm Chart

Pour désinstaller le Helm Chart : helm uninstall <deployment-name>

Exemple : helm uninstall librechat

Migrer de 1.x vers 2.x

Si vous avez utilisé le chart avant la version 2.x, vous devrez peut-être mettre à jour la structure value.

  1. Déplacer la configuration vers librechat.configEnv :
- env:
-     ALLOW_EMAIL_LOGIN: "true"
-     ALLOW_REGISTRATION: "true"
+ librechat:
+   configEnv:
+     ALLOW_REGISTRATION: "true"
+     ALLOW_EMAIL_LOGIN: "true"
  1. Consolidez toutes les valeurs de Secret en un seul Secret comme décrit dans Configuration Step 1.
  2. Pour utiliser une instance MongoDB externe, référez-vous au values file du Chart, désactivez les composants en conséquence et modifiez le FQDN de l'instance MongoDB. Ceci est recommandé si des données existent déjà dans cette instance MongoDB gérée de manière externe.

Helm Charts de la communauté

Que pensez-vous de ce guide ?