Configuratiestructuur

Let op: Velden die niet specifiek als vereist worden genoemd, zijn optioneel.

version

• vereist

cache

skillSync

zie: Skill Sync Object Structure

messageFilter

zie: Message Filter Object Structure

fileStrategy

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

• Opmerkingen:
  • "cloudfront" slaat bestanden op in S3 en retourneert CloudFront-URL's voor stabiele media-aflevering, ondertekende cookies en ondertekende downloads.
  • "firebase" serveert bestanden via Firebase Storage en Firebase Hosting edge-locaties.
  • S3 serveert bestanden via presigned URLs (tijdelijke ondertekende tokens) die verlopen. Zodra deze zijn verlopen, zal elke afbeelding of avatar die naar die URL verwijst, als defect worden weergegeven in de UI. Dit maakt S3 ongeschikt als primaire strategie voor visuele assets. Zie de gerelateerde discussie voor details.
  • Voor de beste prestaties van afbeeldingen en avatars, gebruik "cloudfront" of "firebase", of configureer fileStrategies om avatar en image naar een strategie met CDN-ondersteuning te routeren.
  • Raadpleeg de File Storage & CDN documentation voor details over de installatie.

fileStrategies

Biedt gedetailleerde controle over bestandsopslagstrategieën voor verschillende bestandstypen.

• Beschikbare strategieën: "local" | "firebase" | "s3" | "azure_blob" | "cloudfront"

Sub-keys:

• Opmerkingen:
  • Deze instelling heeft voorrang op de enkele fileStrategy optie
  • Als een specifiek bestandstype niet is geconfigureerd, valt het terug op default, daarna op fileStrategy en uiteindelijk op "local"
  • Afbeeldingen en avatars hebben persistente, stabiele URL's nodig om correct te worden weergegeven in de UI. S3 presigned URL's verlopen (AWS-limiet: 7 dagen voor IAM-gebruikers, uren voor STS/op rollen gebaseerde credentials), wat leidt tot kapotte afbeeldingen in de model selector en chat UI. Zie de gerelateerde discussie voor de volledige context. Gebruik "cloudfront" of "firebase" voor avatar en image om dit te voorkomen.
  • S3 en Azure Blob Storage zijn zeer geschikt voor document opslag, waarbij kortstondige presigned download-URL's passend zijn.
  • Raadpleeg de File Storage & CDN documentation voor installatiedetails voor elke opslagprovider.

Voorbeelden:

# 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

Sleutel:

Subkeys:

zie: CloudFront Object Structure en CloudFront with S3

filteredTools

• Opmerkingen:
  • Als zowel includedTools als filteredTools zijn opgegeven, wordt alleen includedTools herkend.
  • Is van invloed op zowel de gptPlugins als de assistants endpoint
  • Je kunt de namen van de tools om te filteren vinden in api/app/clients/tools/manifest.json
    • Gebruik de pluginKey waarde
  • Ook alle bestanden die onder de map ".well-known" staan: api/app/clients/tools/.well-known
    • Gebruik de name_for_model waarde

includedTools

• Opmerkingen:
  • Als zowel includedTools als filteredTools zijn opgegeven, wordt alleen includedTools herkend.
  • Is van invloed op zowel de gptPlugins als de assistants endpoint
  • Je kunt de namen van de tools om te filteren vinden in api/app/clients/tools/manifest.json
    • Gebruik de pluginKey waarde
  • Ook alle bestanden die onder de map ".well-known" staan: api/app/clients/tools/.well-known
    • Gebruik de name_for_model waarde

secureImageLinks

imageOutputType

• Let op: Hoofdlettergevoelig. Het Google endpoint ondersteunt alleen "jpeg" en "png" output-types.
• Opties: "png" | "webp" | "jpeg"

ocr

Sleutel:

Subkeys:

zie: OCR Config Object Structure

webSearch

Sleutel:

Subkeys:

zie: Web Search Object Structure

fileConfig

Sleutel:

Subkeys:

clientImageResize

Sleutel:

Subkeys:

Beschrijving:

De clientImageResize configuratie maakt automatische beeldvergroting aan de clientzijde mogelijk vóór het uploaden. Deze functie helpt bij:

• Voorkom uploadfouten doordat grote afbeeldingsbestanden de serverlimieten overschrijden
• Verminder bandbreedtegebruik door afbeeldingen te comprimeren vóór verzending
• Verbeter de uploadprestaties met kleinere bestandsgroottes
• Behoud de beeldkwaliteit terwijl de bestandsgrootte wordt geoptimaliseerd

Wanneer ingeschakeld, worden afbeeldingen die de opgegeven maxWidth of maxHeight dimensies overschrijden, automatisch aan de clientzijde aangepast voordat ze naar de server worden geüpload. De schaling behoudt de oorspronkelijke beeldverhouding en zorgt er tegelijkertijd voor dat de afbeelding binnen de opgegeven grenzen past.

Voorbeeld:

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

Opmerkingen:

• Alleen van toepassing op afbeeldingsbestanden (JPEG, PNG, WebP, enz.)
• Het formaat wordt automatisch aangepast wanneer afbeeldingen de opgegeven afmetingen overschrijden
• De oorspronkelijke beeldverhouding blijft behouden tijdens het wijzigen van het formaat
• Deze functie werkt met alle ondersteunde image upload endpoints
• De kwaliteitsinstelling is alleen van toepassing op JPEG- en WebP-formaten
• Het instellen van de kwaliteit op een te lage waarde (< 0,5) kan leiden tot merkbare beeldverslechtering.

zie: File Config Object Structure

rateLimits

Sleutel:

Subkeys:

fileUploads Subkeys:

conversationsImport Subkeys:

tts Subkeys:

stt Subkeys:

• Voorbeeld:

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

Sleutel:

Subkeys:

zie ook:

• socialLogins,
• alloweddomains,
• Structuur van het registratie-object

memory

Sleutel:

Subkeys:

zie: Memory Object Structure

summarization

Sleutel:

Subkeys:

zie: Summarization Object Structure

actions

Sleutel:

Subkeys:

zie ook:

• allowedDomains,
• allowedAddresses,
• Structuur van het Actions-object

interface

Sleutel:

Subkeys:

zie: Interface Object Structure

modelSpecs

Sleutel:

Subkeys:

zie: Model Specs Object Structure

endpoints

Sleutel:

Subkeys:

Let op: Endpoints ondersteunen Shared Endpoint Settings zoals streamRate, headers, titleModel, titleMethod, titlePrompt, titlePromptTemplate, titleEndpoint en maxToolResultChars. Deze kunnen individueel per endpoint worden geconfigureerd of globaal met behulp van de all sleutel. headers worden samengevoegd, waarbij waarden op endpoint-niveau voorrang krijgen bij sleutelconflicten. De all sleutel accepteert geen baseURL.

Let op: endpoints.allowedAddresses is van toepassing op door de gebruiker opgegeven baseURL-waarden (wanneer een beheerder een aangepast endpoint configureert met apiKey: 'user_provided' en baseURL: 'user_provided'). Elke door de gebruiker opgegeven baseURL wordt op het moment van het verzoek gevalideerd tegen de SSRF-blokkering; de hier vermelde items zijn hiervan vrijgesteld. Zie mcpSettings.allowedAddresses voor de semantiek van het veld — dezelfde regels zijn van toepassing (alleen privé IP-bereik, poort vereist, geen URL's/paden/CIDR/kale hosts/openbare IP-literals).

mcpSettings

Sleutel:

Subkeys:

• Opmerkingen:
  • Dit is een beveiligingsfunctie ter bescherming tegen misbruik van interne adressen via MCP servers
  • Standaard beperkt LibreChat MCP-servers in het verbinden met interne, lokale of privénetwerkadressen.
  • MCP-servers die lokale IP-adressen of domeinen gebruiken, kunnen ofwel worden toegevoegd aan de strikte allowedDomains whitelist (die dan de enige bereikbare set wordt), of — om publieke bestemmingen bereikbaar te houden — worden vrijgesteld als exacte host:port-services via allowedAddresses.
  • Zoals bij alle yaml-configuratiewijzigingen, is een herstart van LibreChat vereist om deze van kracht te laten worden.
  • Ondersteunt domeinen, wildcard-subdomeinen (*.example.com), Docker-domeinen en IP-adressen

Voorbeeld:

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

zie: MCP Settings Object Structure

mcpServers

Sleutel:

Subkeys:

• Opmerkingen:
  • Initialisatie vindt plaats bij het opstarten en de app moet opnieuw worden opgestart om wijzigingen door te voeren.
  • De <serverName> is een unieke identificatie voor elke MCP serverconfiguratie.
  • Elke MCP server kan worden geconfigureerd met behulp van een van de vier verbindingstypen:
    • stdio
    • websocket
    • sse
    • streamable-http
  • Het type veld specificeert het verbindingstype naar de MCP server.
  • Als type wordt weggelaten, wordt de standaardwaarde bepaald op basis van de aanwezigheid en het formaat van url of command:
    • Als url is opgegeven en begint met http of https, dan is de standaardwaarde voor type sse.
    • Als url is opgegeven en begint met ws of wss, dan is de standaardwaarde voor type websocket.
    • Als command is opgegeven, is de standaardwaarde voor type stdio.
  • Aanvullende configuratieopties zijn onder andere:
    • timeout: Time-out in milliseconden voor MCP server-verzoeken. Bepaalt hoe lang er gewacht moet worden op een antwoord voor tool-verzoeken.
    • initTimeout: Timeout in milliseconden voor MCP server-initialisatie. Bepaalt hoe lang er gewacht moet worden tot de server is geïnitialiseerd.
    • serverInstructions: Bepaalt of serverinstructies worden opgenomen in de context van de agent. Kan true (gebruik door de server verstrekte), false (uitgeschakeld) of een aangepaste string (overschrijft door de server verstrekte) zijn.
    • customUserVars: (Optioneel) Definieert aangepaste variabelen (bijv. API-sleutels, URL's) die individuele gebruikers kunnen instellen voor een MCP-server. Deze waarden per gebruiker, die via de UI worden verstrekt, kunnen vervolgens worden verwezen in de headers of env configuraties van de server met behulp van de {{VARIABLE_NAME}} syntaxis. Dit maakt authenticatie of aanpassing per gebruiker voor MCP-tools mogelijk.
  • zie: MCP Servers Object Structure

Voorbeeld:

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

zie: MCP Servers Object Structure

speech

Sleutel:

Subkeys:

zie: Speech Object Structure

turnstile

Sleutel:

Subkeys:

zie: Turnstile Object Structure

transactions

Sleutel:

Subkeys:

zie: Transactions Object Structure

Aanvullende links

• Summarization Object Structure
• AWS Bedrock Objectstructuur
• Custom Endpoint Object Structure
• Azure OpenAI Endpoint Object Structure
• Structuur van het Assistants Endpoint-object
• Agents
• OCR Config Object Structure
• Speech Object Structure
• Turnstile Object Structure
• Structuur van het Transactions-object
• Balance Object Structure
• Structuur van het Web Search-object
• Memory Object Structure