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

Docker

Comment installer LibreChat localement avec Docker, vérifier votre configuration et configurer des endpoints personnalisés

Pour la plupart des scénarios, Docker Compose est la méthode d'installation recommandée en raison de sa simplicité, de sa facilité d'utilisation et de sa fiabilité.

Prérequis

Docker Desktop est recommandé pour la plupart des utilisateurs. Pour les installations sur serveur distant, consultez le Guide de déploiement Docker sur Ubuntu.

Macs avec Apple Silicon (série M)

Les ordinateurs Mac équipés de processeurs Apple Silicon (M1, M2, M3, M4) ne prennent pas en charge les instructions AVX, qui sont requises par l'image MongoDB par défaut utilisée dans la configuration Docker Compose de LibreChat. Si vous utilisez un Mac de la série M, MongoDB plantera au démarrage.

Correction : Créez un docker-compose.override.yml pour utiliser une image MongoDB plus ancienne et compatible :

services:
  mongodb:
    image: mongo:4.4.18

Consultez le guide de remplacement Docker pour plus de détails.

Installation

Cloner le dépôt

git clone https://github.com/danny-avila/LibreChat.git
cd LibreChat

Créer votre fichier d'environnement

cp .env.example .env

Le fichier .env par défaut fonctionne immédiatement pour une configuration de base. Pour une configuration approfondie, consultez la référence .env.

Windows

On Windows, use copy .env.example .env if cp is not available.

Démarrer LibreChat

docker compose up -d

Le premier lancement télécharge les images Docker et peut prendre quelques minutes. Les démarrages suivants sont beaucoup plus rapides.

Vérifier et se connecter

Ouvrez votre navigateur et visitez http://localhost:3080. Vous devriez voir la page de connexion de LibreChat.

Premier compte = Admin

Le premier compte que vous enregistrez devient le compte administrateur. Il n'y a pas d'identifiants par défaut -- vous créez votre propre nom d'utilisateur et mot de passe lors de l'inscription.

Cliquez sur Register pour créer votre compte et commencer à utiliser LibreChat.

Montage de librechat.yaml

Pour utiliser un fichier de configuration librechat.yaml personnalisé avec Docker, vous devez le monter en tant que volume afin que le conteneur puisse y accéder.

Copiez l'exemple de fichier de remplacement et modifiez-le :

cp docker-compose.override.yml.example docker-compose.override.yml

Assurez-vous que le montage de volume librechat.yaml est décommenté dans docker-compose.override.yml :

services:
  api:
    volumes:
      - type: bind
        source: ./librechat.yaml
        target: /app/librechat.yaml

Redémarrez pour que les modifications prennent effet :

docker compose down && docker compose up -d

Pour des instructions de configuration complètes, y compris la création du fichier à partir de zéro, consultez le guide librechat.yaml. Pour plus d'options de remplacement, consultez le guide de remplacement Docker.

Mise à jour de LibreChat

Les commandes suivantes récupéreront les dernières modifications du projet LibreChat, y compris tous les changements nécessaires aux fichiers docker compose, ainsi que les dernières images pré-construites.

Autorisations

Il se peut que vous deviez faire précéder les commandes de sudo en fonction des permissions de votre environnement.

docker compose down
# Linux/Mac
docker images -a | grep "librechat" | awk '{print $3}' | xargs docker rmi

# Windows (PowerShell)
docker images -a --filter "reference=registry.librechat.ai/danny-avila/librechat*" --format "{{.ID}}" | ForEach-Object { docker rmi $_ }
docker images -a --filter "reference=ghcr.io/danny-avila/librechat*" --format "{{.ID}}" | ForEach-Object { docker rmi $_ }
git pull
docker compose pull
docker compose up

Dépannage

Port déjà utilisé

Si vous voyez une erreur telle que bind: address already in use pour le port 3080, une autre application utilise ce port.

Arrêtez l'application en conflit ou modifiez le port dans docker-compose.override.yml :

services:
  api:
    ports:
      - "3081:3080"

Ensuite, visitez http://localhost:3081 à la place.

Le conteneur plante au démarrage

Si les conteneurs s'arrêtent immédiatement après le démarrage, vérifiez les journaux :

docker compose logs api

Causes courantes :

  • Syntaxe librechat.yaml invalide -- validez-la avec le YAML Validator
  • Fichier .env manquant -- assurez-vous que .env existe à la racine du projet
  • Docker n'est pas en cours d'exécution -- assurez-vous que Docker Desktop est ouvert et en cours d'exécution

Variables d'environnement manquantes

Si les fonctionnalités ne fonctionnent pas comme prévu, vérifiez que les variables d'environnement requises sont définies dans votre fichier .env.

docker compose exec api env | grep -i "your_variable"

Consultez la référence .env pour toutes les variables disponibles et leurs valeurs par défaut.

Étapes suivantes

Que pensez-vous de ce guide ?