Konfigurationsstruktur

Hinweis: Felder, die nicht ausdrücklich als erforderlich genannt werden, sind optional.

version

• erforderlich

cache

skillSync

siehe: Skill Sync Object Structure

messageFilter

siehe: Message Filter Object Structure

fileStrategy

• Optionen: "local" | "firebase" | "s3" | "azure_blob" | "cloudfront"

• Hinweise:
  • "cloudfront" speichert Dateien in S3 und gibt CloudFront-URLs für eine stabile Medienbereitstellung, signierte Cookies und signierte Downloads zurück.
  • "firebase" stellt Dateien über Firebase Storage und Firebase Hosting Edge-Standorte bereit.
  • S3 stellt Dateien über presigned URLs (temporäre signierte Token) bereit, die ablaufen. Sobald sie abgelaufen sind, wird jedes Bild oder jeder Avatar, der auf diese URL verweist, in der Benutzeroberfläche als defekt angezeigt. Dies macht S3 ungeeignet als primäre Strategie für visuelle Assets. Weitere Einzelheiten finden Sie in der zugehörigen Diskussion.
  • Für die beste Leistung von Bildern und Avataren verwenden Sie "cloudfront" oder "firebase", oder konfigurieren Sie fileStrategies, um avatar und image an eine CDN-gestützte Strategie weiterzuleiten.
  • Bitte lesen Sie die File Storage & CDN documentation für Details zur Einrichtung.

fileStrategies

Ermöglicht eine granulare Kontrolle über Dateispeicherstrategien für verschiedene Dateitypen.

• Verfügbare Strategien: "local" | "firebase" | "s3" | "azure_blob" | "cloudfront"

Untergeordnete Schlüssel:

• Hinweise:
  • Diese Einstellung hat Vorrang vor der einzelnen fileStrategy-Option
  • Wenn ein bestimmter Dateityp nicht konfiguriert ist, wird auf default zurückgegriffen, dann auf fileStrategy und schließlich auf "local".
  • Bilder und Avatare benötigen persistente, stabile URLs, um in der gesamten UI korrekt gerendert zu werden. S3-presigned URLs laufen ab (AWS-Limit: 7 Tage für IAM-Benutzer, Stunden für STS/rollenbasierte Anmeldeinformationen), was zu defekten Bildern in der Modellauswahl und der Chat-UI führt. Siehe die zugehörige Diskussion für den vollständigen Kontext. Verwenden Sie "cloudfront" oder "firebase" für avatar und image, um dies zu vermeiden.
  • S3 und Azure Blob Storage eignen sich gut für die document-Speicherung, bei der kurzlebige, vorab signierte Download-URLs angemessen sind.
  • Bitte lesen Sie die File Storage & CDN documentation für Einrichtungsdetails zu den jeweiligen Speicheranbietern.

Beispiele:

# Use a single strategy for all file types
fileStrategies:
  default: 's3'

# Route images and avatars to CDN, keep documents in object storage
fileStrategies:
  avatar: 'cloudfront' # CDN delivery for avatars
  image: 'cloudfront' # CDN delivery for generated/uploaded images
  document: 's3' # Object storage for documents

# Only configure specific types, others use default
fileStrategies:
  default: 'local'
  avatar: 'firebase' # Only avatars use Firebase CDN, everything else is local

cloudfront

Schlüssel:

Untergeordnete Schlüssel:

siehe: CloudFront Object Structure und CloudFront with S3

filteredTools

• Hinweise:
  • Wenn sowohl includedTools als auch filteredTools angegeben sind, wird nur includedTools erkannt.
  • Betrifft sowohl gptPlugins als auch assistants endpoint.
  • Sie finden die Namen der zu filternden Tools in api/app/clients/tools/manifest.json
    • Verwenden Sie den pluginKey-Wert
  • Außerdem alle, die unter dem Verzeichnis ".well-known" api/app/clients/tools/.well-known aufgeführt sind
    • Verwenden Sie den Wert name_for_model

includedTools

• Hinweise:
  • Wenn sowohl includedTools als auch filteredTools angegeben sind, wird nur includedTools erkannt.
  • Betrifft sowohl gptPlugins als auch assistants endpoint.
  • Sie finden die Namen der zu filternden Tools in api/app/clients/tools/manifest.json
    • Verwenden Sie den pluginKey-Wert
  • Außerdem alle, die unter dem Verzeichnis ".well-known" api/app/clients/tools/.well-known aufgeführt sind
    • Verwenden Sie den Wert name_for_model

secureImageLinks

imageOutputType

• Hinweis: Groß-/Kleinschreibung beachten. Der Google endpoint unterstützt nur die Ausgabetypen "jpeg" und "png".
• Optionen: "png" | "webp" | "jpeg"

ocr

Schlüssel:

Untergeordnete Schlüssel:

siehe: OCR Config Object Structure

webSearch

Schlüssel:

Untergeordnete Schlüssel:

siehe: Web Search Object Structure

fileConfig

Schlüssel:

Untergeordnete Schlüssel:

clientImageResize

Schlüssel:

Untergeordnete Schlüssel:

Beschreibung:

Die clientImageResize-Konfiguration ermöglicht die automatische clientseitige Bildgrößenanpassung vor dem Hochladen. Diese Funktion hilft dabei:

• Verhindern Sie Upload-Fehler, die durch große Bilddateien entstehen, welche die Serverlimits überschreiten
• Bandbreitennutzung reduzieren, indem Bilder vor der Übertragung komprimiert werden
• Verbessern Sie die Upload-Leistung mit kleineren Dateigrößen
• Bildqualität beibehalten bei gleichzeitiger Optimierung der Dateigröße

Wenn aktiviert, werden Bilder, die die angegebenen maxWidth- oder maxHeight-Dimensionen überschreiten, automatisch auf der Client-Seite in der Größe angepasst, bevor sie auf den Server hochgeladen werden. Die Größenänderung behält das ursprüngliche Seitenverhältnis bei und stellt gleichzeitig sicher, dass das Bild innerhalb der angegebenen Grenzen bleibt.

Beispiel:

fileConfig:
  clientImageResize:
    enabled: true
    maxWidth: 1920
    maxHeight: 1080
    quality: 0.8
    compressFormat: 'jpeg'

Hinweise:

• Gilt nur für Bilddateien (JPEG, PNG, WebP, etc.)
• Die Größenanpassung erfolgt automatisch, wenn Bilder die angegebenen Abmessungen überschreiten.
• Das ursprüngliche Seitenverhältnis bleibt bei der Größenänderung erhalten
• Die Funktion funktioniert mit allen unterstützten Endpoints für den Bildupload.
• Die Qualitätseinstellung gilt nur für JPEG- und WebP-Formate
• Das Einstellen einer zu niedrigen Qualität (< 0,5) kann zu einer sichtbaren Verschlechterung der Bildqualität führen.

siehe: Struktur des Dateikonfigurationsobjekts

rateLimits

Schlüssel:

Untergeordnete Schlüssel:

fileUploads Unter-Keys:

conversationsImport Unter-Keys:

tts-Unterkeys:

stt-Unterkeys:

• Beispiel:

rateLimits:
  fileUploads:
    ipMax: 100
    ipWindowInMinutes: 60
    userMax: 50
    userWindowInMinutes: 60
  conversationsImport:
    ipMax: 100
    ipWindowInMinutes: 60
    userMax: 50
    userWindowInMinutes: 60
  stt:
    ipMax: 100
    ipWindowInMinutes: 1
    userMax: 50
    userWindowInMinutes: 1
  tts:
    ipMax: 100
    ipWindowInMinutes: 1
    userMax: 50
    userWindowInMinutes: 1

registration

Schlüssel:

Untergeordnete Schlüssel:

siehe auch:

• socialLogins,
• alloweddomains,
• Struktur des Registrierungsobjekts

memory

Schlüssel:

Untergeordnete Schlüssel:

siehe: Memory Object Structure

summarization

Schlüssel:

Untergeordnete Schlüssel:

siehe: Struktur des Zusammenfassungs-Objekts

actions

Schlüssel:

Untergeordnete Schlüssel:

siehe auch:

• allowedDomains,
• allowedAddresses,
• Struktur des Actions-Objekts

interface

Schlüssel:

Untergeordnete Schlüssel:

siehe: Interface Object Structure

modelSpecs

Schlüssel:

Untergeordnete Schlüssel:

siehe: Model Specs Object Structure

endpoints

Schlüssel:

Untergeordnete Schlüssel:

Hinweis: Endpoints unterstützen Shared Endpoint Settings wie streamRate, headers, titleModel, titleMethod, titlePrompt, titlePromptTemplate, titleEndpoint und maxToolResultChars. Diese können individuell pro Endpoint oder global über den all-Schlüssel konfiguriert werden. headers werden zusammengeführt, wobei die Werte auf Endpoint-Ebene bei Schlüsselkollisionen Vorrang haben. Der all-Schlüssel akzeptiert kein baseURL.

Hinweis: endpoints.allowedAddresses gilt für vom Benutzer bereitgestellte baseURL-Werte (wenn ein Administrator einen benutzerdefinierten endpoint mit apiKey: 'user_provided' und baseURL: 'user_provided' konfiguriert). Jede vom Benutzer bereitgestellte baseURL wird zum Zeitpunkt der Anfrage gegen den SSRF-Block validiert; die hier aufgeführten Einträge sind davon ausgenommen. Siehe mcpSettings.allowedAddresses für die Semantik des Feldes — es gelten dieselben Regeln (nur privater IP-Adressraum, Port erforderlich, keine URLs/Pfade/CIDR/nackte Hosts/öffentliche IP-Literale).

mcpSettings

Schlüssel:

Untergeordnete Schlüssel:

• Hinweise:
  • Dies ist ein Sicherheitsfeature zum Schutz vor Missbrauch / Zweckentfremdung interner Adressen über MCP Server
  • Standardmäßig schränkt LibreChat die Verbindung von MCP-Servern zu internen, lokalen oder privaten Netzwerkadressen ein.
  • MCP-Server, die lokale IP-Adressen oder Domains verwenden, können entweder zur strikten allowedDomains-Whitelist hinzugefügt werden (welche dann die einzige erreichbare Menge darstellt) oder – um öffentliche Ziele weiterhin erreichbar zu halten – als exakte host:port-Dienste über allowedAddresses ausgenommen werden.
  • Wie bei allen yaml-Konfigurationsänderungen ist ein Neustart von LibreChat erforderlich, damit diese wirksam werden.
  • Unterstützt Domains, Wildcard-Subdomains (*.example.com), Docker-Domains und IP-Adressen

Beispiel:

mcpSettings:
  # Strict whitelist mode:
  # allowedDomains:
  #   - "example.com"           # Specific domain
  #   - "*.example.com"         # All subdomains
  #   - "http://mcp-server:3000" # Internal service, explicitly whitelisted

  # Default SSRF mode with private service exemptions:
  allowedAddresses:
    - 'host.docker.internal:8080' # Permit one private host on one port
    - '10.0.0.5:8000' # Permit one private IP on one port

siehe: MCP Settings Object Structure

mcpServers

Schlüssel:

Untergeordnete Schlüssel:

• Hinweise:
  • Die Initialisierung erfolgt beim Start, und die App muss neu gestartet werden, damit Änderungen wirksam werden.
  • Der <serverName> ist ein eindeutiger Bezeichner für jede MCP Server-Konfiguration.
  • Jeder MCP server kann über einen von vier Verbindungstypen konfiguriert werden:
    • stdio
    • websocket
    • sse
    • streamable-http
  • Das Feld type gibt den Verbindungstyp zum MCP Server an.
  • Wenn type weggelassen wird, erfolgt die Standardeinstellung basierend auf dem Vorhandensein und dem Format von url oder command:
    • Wenn url angegeben ist und mit http oder https beginnt, ist der Standardwert für type sse.
    • Wenn url angegeben ist und mit ws oder wss beginnt, wird type standardmäßig auf websocket gesetzt.
    • Wenn command angegeben ist, ist der Standardwert für type stdio.
  • Zusätzliche Konfigurationsoptionen umfassen:
    • timeout: Timeout in Millisekunden für MCP-Server-Anfragen. Bestimmt, wie lange auf eine Antwort für Tool-Anfragen gewartet werden soll.
    • initTimeout: Timeout in Millisekunden für die MCP-Server-Initialisierung. Bestimmt, wie lange auf die Initialisierung des Servers gewartet werden soll.
    • serverInstructions: Steuert, ob Server-Anweisungen in den Agenten-Kontext einbezogen werden. Kann true (vom Server bereitgestellt verwenden), false (deaktiviert) oder eine benutzerdefinierte Zeichenfolge (überschreibt die vom Server bereitgestellten) sein.
    • customUserVars: (Optional) Definiert benutzerdefinierte Variablen (z. B. API-Schlüssel, URLs), die einzelne Benutzer für einen MCP-Server festlegen können. Diese benutzerspezifischen Werte, die über die Benutzeroberfläche bereitgestellt werden, können dann in den headers- oder env-Konfigurationen des Servers unter Verwendung der {{VARIABLE_NAME}}-Syntax referenziert werden. Dies ermöglicht eine benutzerspezifische Authentifizierung oder Anpassung für MCP-Tools.
  • siehe: MCP Servers Object Structure

Beispiel:

mcpServers:
  everything:
    # type: sse # type can optionally be omitted
    url: http://localhost:3001/sse
    timeout: 30000
    initTimeout: 10000
    serverInstructions: true # Use server-provided instructions
  puppeteer:
    type: stdio
    command: npx
    args:
      - -y
      - '@modelcontextprotocol/server-puppeteer'
    timeout: 30000
    initTimeout: 10000
    serverInstructions: 'Do not access any local files or local/internal IP addresses'
  filesystem:
    # type: stdio
    command: npx
    args:
      - -y
      - '@modelcontextprotocol/server-filesystem'
      - /home/user/LibreChat/
    iconPath: /home/user/LibreChat/client/public/assets/logo.svg
  mcp-obsidian:
    command: npx
    args:
      - -y
      - 'mcp-obsidian'
      - /path/to/obsidian/vault
  streamable-http-example:
    type: streamable-http
    url: https://example.com/mcp
    headers:
      Authorization: 'Bearer ${API_TOKEN}'
    timeout: 30000
  per-user-crendentials-example:
    type: sse
    url: 'https//some.mcp/sse'
    headers:
      X-Custom-Auth-Token: '{{USER_API_KEY}}' # Placeholder for the user-provided API key, defined in `customUserVars` below.
    customUserVars:
      USER_API_KEY:
        title: 'Service API Key'
        description: "Your personal API key for this service. You can get it <a href='https://example.com/api-keys' target='_blank'>here</a>."
    serverInstructions: true

siehe: MCP Servers Object Structure

speech

Schlüssel:

Untergeordnete Schlüssel:

siehe: Speech Object Structure

turnstile

Schlüssel:

Untergeordnete Schlüssel:

siehe: Turnstile Object Structure

transactions

Schlüssel:

Untergeordnete Schlüssel:

siehe: Struktur des Transaktionsobjekts

Zusätzliche Links

• Struktur des Zusammenfassungs-Objekts
• AWS Bedrock Objektstruktur
• Struktur des benutzerdefinierten Endpoint-Objekts
• Struktur des Azure OpenAI Endpoint-Objekts
• Struktur des Assistants Endpoint-Objekts
• Agents
• OCR-Konfigurationsobjektstruktur
• Struktur des Speech-Objekts
• Turnstile-Objektstruktur
• Struktur des Transaktionsobjekts
• Struktur des Balance-Objekts
• Struktur des Web-Suchobjekts
• Speicherobjektstruktur