Benutzerdefinierte Konfiguration

Erstellen, einbinden und konfigurieren Sie die librechat.yaml Datei für benutzerdefinierte KI-endpoints und erweiterte LibreChat-Einstellungen

Was ist librechat.yaml?

Die librechat.yaml Datei ist die Hauptkonfigurationsdatei von LibreChat für benutzerdefinierte KI-endpoints, Modelleinstellungen, Schnittstellenoptionen und erweiterte Funktionen wie MCP-Server und Agents. Sie ist optional – LibreChat funktioniert mit sinnvollen Standardeinstellungen, falls die Datei nicht existiert.

Befolgen Sie die unten stehenden Schritte, um die Datei zu erstellen, sie für Ihren Bereitstellungstyp einzubinden und zu überprüfen, ob sie funktioniert.

Wenn Sie sich nur eine Sache merken

Bei Docker-Installationen reicht es nicht aus, librechat.yaml zu bearbeiten. Die Datei muss im Projektstammverzeichnis vorhanden sein, in den API-Container eingebunden werden und LibreChat muss neu gestartet werden, bevor die Änderungen in der UI sichtbar werden.

Bevorzugen Sie eine Benutzeroberfläche? Verwenden Sie das Admin Panel

Das LibreChat Admin Panel verwaltet dieselbe Konfiguration über einen Browser – einschließlich rollen- und gruppenspezifischer Überschreibungen, die sich beim Anmelden auswirken, ohne dass LibreChat neu gestartet werden muss. Es ist in den offiziellen Docker Compose-Stacks enthalten. Verwenden Sie librechat.yaml für dateibasierte oder Bootstrap-Setups und das Admin Panel für die laufende Verwaltung.

Einrichtung

Die Datei suchen oder erstellen

Erstellen Sie eine neue librechat.yaml in Ihrem Projektstammverzeichnis (dasselbe Verzeichnis wie Ihre .env Datei):

touch librechat.yaml

Sie können auch die Beispielkonfiguration als Ausgangspunkt kopieren:

cp librechat.example.yaml librechat.yaml

Alternativer Dateipfad

Sie können einen benutzerdefinierten Dateipfad mithilfe der Umgebungsvariable CONFIG_PATH festlegen:

CONFIG_PATH="/alternative/path/to/librechat.yaml"

Konfigurationsdatei einbinden

Docker benötigt eine Volume-Einbindung, um auf Ihre librechat.yaml Datei innerhalb des Containers zuzugreifen.

Kopieren Sie die Beispiel-Override-Datei:

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

Bearbeiten Sie docker-compose.override.yml und stellen Sie sicher, dass die Volume-Einbindung für librechat.yaml nicht auskommentiert ist:

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

Dies verwendet das docker-compose.override.yml Muster -- Docker Compose führt es automatisch mit der Hauptdatei docker-compose.yml zusammen, sodass Ihre Anpassungen bei Updates erhalten bleiben.

Platzieren Sie librechat.yaml im Stammverzeichnis des Projekts (im selben Verzeichnis wie Ihre .env-Datei). Für lokale Installationen ist kein zusätzliches Mounten erforderlich.

LibreChat neu starten

docker compose down && docker compose up -d

Stoppen Sie den laufenden Prozess (Strg+C) und starten Sie ihn neu:

npm run backend

Überprüfen, ob es funktioniert

Öffnen Sie LibreChat in Ihrem Browser. Wenn Ihre Konfiguration benutzerdefinierte endpoints enthält, sollten Sie diese im Dropdown-Menü zur Modellauswahl sehen.

Wenn der Server nicht startet, überprüfen Sie die Protokolle auf Validierungsfehler:

docker compose logs api

Beispiel: Hinzufügen von OpenRouter

Dieses Beispiel führt durch das Hinzufügen von OpenRouter als benutzerdefinierten endpoint – eine der beliebtesten Konfigurationen.

1. Holen Sie sich einen API-Schlüssel von openrouter.ai/keys.

2. Fügen Sie den Schlüssel zu Ihrer .env Datei hinzu:

OPENROUTER_KEY=sk-or-v1-your-key-here

Name der Umgebungsvariablen

Verwenden Sie OPENROUTER_KEY, nicht OPENROUTER_API_KEY. Die Verwendung von OPENROUTER_API_KEY führt dazu, dass der OpenAI endpoint ebenfalls überschrieben wird, um OpenRouter zu nutzen.

3. Fügen Sie den endpoint zu librechat.yaml hinzu:

version: 1.3.5
cache: true
endpoints:
  custom:
    - name: "OpenRouter"
      apiKey: "${OPENROUTER_KEY}"
      baseURL: "https://openrouter.ai/api/v1"
      models:
        default: ["meta-llama/llama-3-70b-instruct"]
        fetch: true
      titleConvo: true
      titleModel: "meta-llama/llama-3-70b-instruct"
      dropParams: ["stop"]
      modelDisplayLabel: "OpenRouter"

4. Starten Sie LibreChat neu (siehe Neustart-Befehle oben) und wählen Sie OpenRouter aus der Modellauswahl aus.

Für die vollständige kommentierte Konfigurationsdatei mit weiteren endpoint-Beispielen siehe die Beispielkonfiguration.

Referenz

Für eine detaillierte Dokumentation auf Feldebene siehe die untenstehenden Referenzseiten.

KI-Endpoints

Kompatible KI-Anbieter und Beispielkonfigurationen für endpoints

→

Objektstruktur

Vollständige Feldreferenz für jede librechat.yaml-Option

→

Fehlerbehebung

Änderungen werden in LibreChat nicht angezeigt

Wenn du librechat.yaml bearbeitet hast und sich in der UI nichts geändert hat:

Stellen Sie sicher, dass sich die Datei im LibreChat-Projektstammverzeichnis befindet, es sei denn, Sie haben CONFIG_PATH festgelegt.
Stellen Sie für Docker sicher, dass die Datei in docker-compose.override.yml gemountet ist.
Starten Sie LibreChat mit docker compose down && docker compose up -d neu.
Überprüfen Sie die API-Logs mit docker compose logs api.
Validieren Sie die Datei mit dem YAML Validator.

Benutzerdefinierte endpoints wie OpenRouter erscheinen erst, wenn alle drei Voraussetzungen erfüllt sind: .env enthält den Schlüssel, librechat.yaml definiert den endpoint und Docker kann die eingebundene Konfigurationsdatei lesen.

Konfigurationsvalidierung

LibreChat wird mit einem Fehler (Exit-Code 1) beendet, wenn librechat.yaml Validierungsfehler enthält. Dieses Fail-Fast-Verhalten erkennt Konfigurationsprobleme frühzeitig.

Um Ihre YAML-Syntax vor dem Neustart zu validieren, verwenden Sie den YAML Validator oder yamlchecker.com.

Server beendet sich sofort beim Start

Wenn Ihr Server unmittelbar nach dem Start beendet wird, liegt dies wahrscheinlich an einem Fehler bei der Konfigurationsvalidierung.

Zur Diagnose:

Überprüfen Sie die Server-Logs: docker compose logs api
Überprüfen Sie Ihre YAML-Syntax mit dem YAML Validator
Häufige Fehler: falsche Einrückung, fehlende Doppelpunkte, unbekannte Schlüssel, ungültige Werte

Temporärer Workaround (nicht für die Produktion empfohlen):

CONFIG_BYPASS_VALIDATION=true

Warnung

CONFIG_BYPASS_VALIDATION=true bewirkt, dass der Server die Validierung überspringt und die Standardkonfiguration verwendet. Beheben Sie stattdessen immer die Validierungsfehler.

Benutzerdefinierte Konfiguration

KI-Endpoints

Objektstruktur

Auf dieser Seite