Aangepaste configuratie

Maak, koppel en configureer het librechat.yaml bestand voor aangepaste AI endpoints en geavanceerde LibreChat instellingen

Wat is librechat.yaml?

Het librechat.yaml bestand is het belangrijkste configuratiebestand van LibreChat voor aangepaste AI-endpoints, modelinstellingen, interface-opties en geavanceerde functies zoals MCP-servers en agents. Het is optioneel -- LibreChat werkt met verstandige standaardinstellingen als het bestand niet bestaat.

Volg de onderstaande stappen om het bestand aan te maken, het te koppelen voor jouw type implementatie en te verifiëren of het werkt.

Als je maar één ding onthoudt

Voor Docker-installaties is het bewerken van librechat.yaml niet voldoende. Het bestand moet in de project-root aanwezig zijn, worden gemount in de API-container en LibreChat moet opnieuw worden opgestart voordat wijzigingen in de UI verschijnen.

Geef je de voorkeur aan een UI? Gebruik het Admin Panel

Het LibreChat Admin Panel beheert dezezelfde configuratie vanuit een browser -- inclusief overrides per rol en per groep die van kracht worden bij het inloggen zonder LibreChat opnieuw op te starten. Het wordt meegeleverd met de officiële Docker Compose stacks. Gebruik librechat.yaml voor bestandsgestuurde of bootstrap-configuratie, en het admin panel voor doorlopend beheer.

Setup

Het bestand lokaliseren of aanmaken

Maak een nieuw librechat.yaml aan in de hoofdmap van je project (dezelfde map als je .env bestand):

touch librechat.yaml

Je kunt ook de voorbeeldconfiguratie kopiëren als startpunt:

cp librechat.example.yaml librechat.yaml

Alternatief bestandspad

Je kunt een aangepast bestandspad instellen met de CONFIG_PATH omgevingsvariabele:

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

Het configuratiebestand koppelen

Docker heeft een volume mount nodig om toegang te krijgen tot je librechat.yaml bestand binnen de container.

Kopieer het voorbeeld-override-bestand:

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

Bewerk docker-compose.override.yml en zorg ervoor dat de librechat.yaml volume mount niet is uitgeschakeld (uncommented):

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

Dit gebruikt het docker-compose.override.yml patroon -- Docker Compose voegt dit automatisch samen met de hoofd docker-compose.yml, zodat je aanpassingen updates overleven.

Plaats librechat.yaml in de hoofdmap van het project (dezelfde map als je .env bestand). Voor lokale installaties is geen extra mounting nodig.

LibreChat herstarten

docker compose down && docker compose up -d

Stop het actieve proces (Ctrl+C) en start opnieuw:

npm run backend

Controleer of het werkt

Open LibreChat in je browser. Als je configuratie aangepaste endpoints bevat, zou je deze moeten zien in het dropdown-menu voor modelselectie.

Als de server niet start, controleer dan de logs op validatiefouten:

docker compose logs api

Voorbeeld: OpenRouter toevoegen

Dit voorbeeld doorloopt het toevoegen van OpenRouter als een aangepast endpoint -- een van de meest populaire configuraties.

1. Verkrijg een API-sleutel via openrouter.ai/keys.

2. Voeg de sleutel toe aan je .env bestand:

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

Omgevingsvariabele Naam

Gebruik OPENROUTER_KEY, niet OPENROUTER_API_KEY. Het gebruik van OPENROUTER_API_KEY zal het OpenAI endpoint overschrijven om ook OpenRouter te gebruiken.

3. Voeg het endpoint toe aan librechat.yaml:

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. Herstart LibreChat (zie de herstartcommando's hierboven) en selecteer OpenRouter in de modelkiezer.

Voor het volledige geannoteerde configuratiebestand met meer endpoint voorbeelden, zie de voorbeeldconfiguratie.

Referentie

Voor gedetailleerde documentatie op veldniveau, zie de referentiepagina's hieronder.

AI-endpoints

Compatibele AI-providers en voorbeeldconfiguraties voor endpoint

→

Objectstructuur

Volledige veldreferentie voor elke librechat.yaml optie

→

Probleemoplossing

Wijziging wordt niet getoond in LibreChat

Als je librechat.yaml hebt bewerkt en er is niets veranderd in de UI:

Bevestig dat het bestand zich in de hoofdmap van het LibreChat-project bevindt, tenzij je CONFIG_PATH hebt ingesteld.
Voor Docker, bevestig dat het bestand is gekoppeld in docker-compose.override.yml.
Herstart LibreChat met docker compose down && docker compose up -d.
Controleer de API-logs met docker compose logs api.
Valideer het bestand met de YAML Validator.

Aangepaste endpoints zoals OpenRouter verschijnen pas nadat alle drie de onderdelen correct zijn: .env bevat de sleutel, librechat.yaml definieert het endpoint, en Docker kan het gekoppelde configuratiebestand lezen.

Configuratievalidatie

LibreChat sluit af met een foutmelding (exit code 1) als librechat.yaml validatiefouten bevat. Dit 'fail-fast'-gedrag zorgt ervoor dat configuratieproblemen vroegtijdig worden opgemerkt.

Om je YAML-syntaxis te valideren voordat je opnieuw opstart, gebruik je de YAML Validator of yamlchecker.com.

Server sluit onmiddellijk af bij het opstarten

Als je server direct na het opstarten afsluit, is dit waarschijnlijk een configuratievalidatiefout.

Om te diagnosticeren:

Controleer serverlogs: docker compose logs api
Valideer je YAML-syntaxis met de YAML Validator
Veelvoorkomende fouten: onjuiste inspringing, ontbrekende dubbele punten, onbekende sleutels, ongeldige waarden

Tijdelijke oplossing (niet aanbevolen voor productie):

CONFIG_BYPASS_VALIDATION=true

Waarschuwing

CONFIG_BYPASS_VALIDATION=true zorgt ervoor dat de server de validatie overslaat en de standaardconfiguratie gebruikt. Los in plaats daarvan altijd de validatiefouten op.

Aangepaste configuratie

AI-endpoints

Objectstructuur

Op deze pagina