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

Vue d'ensemble

Comment les fichiers de configuration de LibreChat fonctionnent ensemble et comment appliquer les changements

LibreChat utilise quatre fichiers de configuration principaux. Chacun contrôle un aspect différent de l'application -- des variables d'environnement aux endpoint d'IA personnalisés en passant par les remplacements de service Docker.

Flux de travail de modification courant

La plupart des modifications de configuration suivent le même modèle :

  1. Modifiez .env pour les secrets, les clés API et les indicateurs de fonctionnalité au niveau du serveur.
  2. Modifiez librechat.yaml pour les endpoints personnalisés, les Model Specs, les paramètres d'interface, les serveurs MCP, les agents et le comportement avancé de l'application.
  3. Pour Docker, assurez-vous que librechat.yaml est monté via docker-compose.override.yml avant de vous attendre à ce que LibreChat le lise.
  4. Redémarrez LibreChat après chaque modification de configuration.
  5. Vérifiez les journaux de l'API si le changement n'apparaît pas dans l'interface utilisateur.

Par exemple, pour activer OpenRouter, vous ajoutez OPENROUTER_KEY au fichier .env, vous ajoutez un endpoint OpenRouter dans librechat.yaml, vous vous assurez que Docker monte librechat.yaml, vous redémarrez, puis vous sélectionnez OpenRouter depuis le sélecteur d'endpoint.

Fichiers de configuration

.env
librechat.yaml
docker-compose.yml
docker-compose.override.yml

.env -- Paramètres au niveau du serveur : clés API, chaînes de connexion à la base de données, indicateurs de fonctionnalités et secrets d'authentification. Il s'agit du fichier de configuration principal pour la plupart des déploiements. Voir la référence .env pour toutes les variables disponibles.

librechat.yaml -- Points de terminaison IA personnalisés, paramètres de modèle, options d'interface et fonctionnalités avancées telles que les serveurs MCP et les agents. Ce fichier est facultatif -- LibreChat fonctionne avec les paramètres par défaut s'il n'existe pas. Consultez le guide librechat.yaml pour les instructions de configuration.

docker-compose.yml -- Définit les services Docker (serveur API, base de données, recherche). Ne modifiez pas ce fichier directement -- utilisez plutôt un fichier de remplacement (override) afin que vos modifications survivent aux mises à jour.

docker-compose.override.yml -- Vos personnalisations locales pour les services Docker : montages de volumes, mappages de ports, substitutions de variables d'environnement. Docker Compose fusionne automatiquement ce fichier avec le fichier principal. Consultez le guide de substitution Docker.

Application des changements

Redémarrage requis

Après avoir modifié un fichier de configuration, vous devez redémarrer LibreChat pour que les changements prennent effet.

docker compose down && docker compose up -d

Étapes suivantes

Que pensez-vous de ce guide ?