Structure de la configuration

Remarque : Les champs qui ne sont pas explicitement mentionnés comme requis sont facultatifs.

version

• requis

cache

skillSync

voir : Structure de l'objet Skill Sync

messageFilter

voir : Structure de l'objet de filtrage des messages

fileStrategy

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

• Notes :
  • "cloudfront" stocke les fichiers dans S3 et renvoie des URLs CloudFront pour une diffusion stable des médias, des cookies signés et des téléchargements signés.
  • "firebase" sert des fichiers via le stockage Firebase et les emplacements de périphérie (edge locations) de Firebase Hosting.
  • S3 sert les fichiers via des presigned URLs (jetons signés temporaires) qui expirent. Une fois expirée, toute image ou avatar faisant référence à cette URL apparaîtra comme brisé dans l'interface utilisateur. Cela rend S3 inadapté comme stratégie principale pour les ressources visuelles. Voir la discussion associée pour plus de détails.
  • Pour une performance optimale des images et des avatars, utilisez "cloudfront" ou "firebase", ou configurez fileStrategies pour acheminer avatar et image vers une stratégie basée sur un CDN.
  • Veuillez vous référer à la documentation File Storage & CDN pour les détails de configuration.

fileStrategies

Permet un contrôle granulaire sur les stratégies de stockage de fichiers pour différents types de fichiers.

• Stratégies disponibles : "local" | "firebase" | "s3" | "azure_blob" | "cloudfront"

Sous-clés :

• Notes :
  • Ce paramètre prévaut sur l'option unique fileStrategy
  • Si un type de fichier spécifique n'est pas configuré, il revient à default, puis à fileStrategy, et enfin à "local".
  • Les images et les avatars ont besoin d'URLs persistantes et stables pour s'afficher correctement dans l'interface utilisateur. Les URLs présignées S3 expirent (limite AWS : 7 jours pour les utilisateurs IAM, quelques heures pour les identifiants basés sur STS/rôles), ce qui entraîne des images brisées dans le sélecteur de modèles et l'interface de chat. Consultez la discussion associée pour le contexte complet. Utilisez "cloudfront" ou "firebase" pour avatar et image afin d'éviter ce problème.
  • S3 et Azure Blob Storage sont bien adaptés au stockage de document, où les URLs de téléchargement présignées à courte durée de vie sont appropriées.
  • Veuillez vous référer à la documentation File Storage & CDN pour les détails de configuration de chaque fournisseur de stockage.

Exemples :

# 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

Clé :

Sous-clés :

voir : Structure d'objet CloudFront et CloudFront avec S3

filteredTools

• Notes :
  • Si includedTools et filteredTools sont tous deux spécifiés, seul includedTools sera reconnu.
  • Affecte à la fois les endpoints gptPlugins et assistants
  • Vous pouvez trouver les noms des outils à filtrer dans api/app/clients/tools/manifest.json
    • Utilisez la valeur pluginKey
  • De plus, tout ce qui est listé dans le répertoire ".well-known" api/app/clients/tools/.well-known
    • Utilisez la valeur name_for_model

includedTools

• Notes :
  • Si includedTools et filteredTools sont tous deux spécifiés, seul includedTools sera reconnu.
  • Affecte à la fois les endpoints gptPlugins et assistants
  • Vous pouvez trouver les noms des outils à filtrer dans api/app/clients/tools/manifest.json
    • Utilisez la valeur pluginKey
  • De plus, tout ce qui est listé dans le répertoire ".well-known" api/app/clients/tools/.well-known
    • Utilisez la valeur name_for_model

secureImageLinks

imageOutputType

• Note : Sensible à la casse. L'endpoint Google ne prend en charge que les types de sortie "jpeg" et "png".
• Options : "png" | "webp" | "jpeg"

ocr

Clé :

Sous-clés :

voir : Structure de l'objet de configuration OCR

webSearch

Clé :

Sous-clés :

voir : Structure de l'objet de recherche Web

fileConfig

Clé :

Sous-clés :

clientImageResize

Clé :

Sous-clés :

Description :

La configuration clientImageResize permet le redimensionnement automatique des images côté client avant le téléchargement. Cette fonctionnalité aide à :

• Empêcher les échecs de téléchargement dus à des fichiers image volumineux dépassant les limites du serveur
• Réduisez l'utilisation de la bande passante en compressant les images avant leur transmission
• Améliorez les performances de téléchargement avec des tailles de fichiers plus petites
• Maintenir la qualité de l'image tout en optimisant la taille du fichier

Lorsqu'elle est activée, les images qui dépassent les dimensions maxWidth ou maxHeight spécifiées sont automatiquement redimensionnées côté client avant d'être téléchargées sur le serveur. Le redimensionnement conserve le rapport hauteur/largeur d'origine tout en garantissant que l'image respecte les limites spécifiées.

Exemple :

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

Notes :

• S'applique uniquement aux fichiers image (JPEG, PNG, WebP, etc.)
• Le redimensionnement s'effectue automatiquement lorsque les images dépassent les dimensions spécifiées
• Le rapport hauteur/largeur d'origine est préservé lors du redimensionnement
• Cette fonctionnalité fonctionne avec tous les endpoints de téléchargement d'images pris en charge.
• Le paramètre de qualité s'applique uniquement aux formats JPEG et WebP
• Régler la qualité trop bas (< 0.5) peut entraîner une dégradation notable de l'image

voir : Structure de l'objet de configuration de fichier

rateLimits

Clé :

Sous-clés :

Sous-clés fileUploads :

Sous-clés conversationsImport :

Sous-clés tts :

Sous-clés stt :

• Exemple :

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

Clé :

Sous-clés :

voir aussi :

• socialLogins,
• alloweddomains,
• Structure de l'objet d'enregistrement

memory

Clé :

Sous-clés :

voir : Structure de l'objet Memory

summarization

Clé :

Sous-clés :

voir : Structure de l'objet de résumé

actions

Clé :

Sous-clés :

voir aussi :

• allowedDomains,
• allowedAddresses,
• Structure de l'objet Actions

interface

Clé :

Sous-clés :

voir : Structure de l'objet Interface

modelSpecs

Clé :

Sous-clés :

voir : Structure de l'objet Model Specs

endpoints

Clé :

Sous-clés :

Note : Les endpoints prennent en charge les Shared Endpoint Settings tels que streamRate, headers, titleModel, titleMethod, titlePrompt, titlePromptTemplate, titleEndpoint et maxToolResultChars. Ceux-ci peuvent être configurés individuellement par endpoint ou globalement en utilisant la clé all. Les headers sont fusionnés, les valeurs au niveau de l'endpoint étant prioritaires en cas de conflit de clés. La clé all n'accepte pas baseURL.

Remarque : endpoints.allowedAddresses s'applique aux valeurs baseURL fournies par l'utilisateur (lorsqu'un administrateur configure un endpoint personnalisé avec apiKey: 'user_provided' et baseURL: 'user_provided'). Chaque baseURL fournie par l'utilisateur est validée par rapport au blocage SSRF au moment de la requête ; les entrées listées ici en sont exemptées. Voir mcpSettings.allowedAddresses pour la sémantique du champ — les mêmes règles s'appliquent (espace IP privé uniquement, port requis, pas d'URL/chemins/CIDR/hôtes nus/littéraux IP publics).

mcpSettings

Clé :

Sous-clés :

• Notes :
  • Il s'agit d'une fonctionnalité de sécurité visant à protéger contre les abus / utilisations détournées d'adresses internes via les serveurs MCP.
  • Par défaut, LibreChat restreint la connexion des serveurs MCP aux adresses réseau internes, locales ou privées.
  • Les serveurs MCP utilisant des adresses IP locales ou des domaines peuvent soit être ajoutés à la liste blanche stricte allowedDomains (qui devient alors le seul ensemble accessible), soit — pour conserver l'accessibilité des destinations publiques — être exemptés en tant que services host:port exacts via allowedAddresses.
  • Comme pour toutes les modifications de configuration yaml, un redémarrage de LibreChat est nécessaire pour qu'elles prennent effet.
  • Prend en charge les domaines, les sous-domaines génériques (*.example.com), les domaines Docker et les adresses IP

Exemple :

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

voir : Structure de l'objet MCP Settings

mcpServers

Clé :

Sous-clés :

• Notes :
  • L'initialisation se produit au démarrage, et l'application doit être redémarrée pour que les modifications prennent effet.
  • Le <serverName> est un identifiant unique pour chaque configuration de serveur MCP.
  • Chaque serveur MCP peut être configuré en utilisant l'un des quatre types de connexion :
    • stdio
    • websocket
    • sse
    • streamable-http
  • Le champ type spécifie le type de connexion au serveur MCP.
  • Si type est omis, il est défini par défaut en fonction de la présence et du format de url ou command :
    • Si url est spécifié et commence par http ou https, type est défini par défaut sur sse.
    • Si url est spécifié et commence par ws ou wss, type prend websocket par défaut.
    • Si command est spécifié, type prend stdio comme valeur par défaut.
  • Les options de configuration supplémentaires incluent :
    • timeout : Délai d'attente en millisecondes pour les requêtes du serveur MCP. Détermine combien de temps attendre une réponse pour les requêtes d'outils.
    • initTimeout : Délai d'attente en millisecondes pour l'initialisation du serveur MCP. Détermine combien de temps attendre pour que le serveur s'initialise.
    • serverInstructions: Contrôle si les instructions du serveur sont incluses dans le contexte de l'agent. Peut être true (utiliser celles fournies par le serveur), false (désactivé), ou une chaîne personnalisée (remplace celles fournies par le serveur).
    • customUserVars: (Optionnel) Définit des variables personnalisées (par exemple, des clés API, des URL) que les utilisateurs individuels peuvent définir pour un serveur MCP. Ces valeurs par utilisateur, fournies via l'interface utilisateur, peuvent ensuite être référencées dans les configurations headers ou env du serveur en utilisant la syntaxe {{VARIABLE_NAME}}. Cela permet une authentification ou une personnalisation par utilisateur pour les outils MCP.
  • voir : Structure de l'objet MCP Servers

Exemple :

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

voir : Structure de l'objet MCP Servers

speech

Clé :

Sous-clés :

voir : Structure de l'objet Speech

turnstile

Clé :

Sous-clés :

voir : Structure de l'objet Turnstile

transactions

Clé :

Sous-clés :

voir : Structure de l'objet Transactions

Liens supplémentaires

• Structure de l'objet de résumé
• Structure de l'objet AWS Bedrock
• Structure de l'objet de point de terminaison personnalisé
• Structure de l'objet endpoint Azure OpenAI
• Structure de l'objet endpoint Assistants
• Agents
• Structure de l'objet de configuration OCR
• Structure de l'objet Speech
• Structure de l'objet Turnstile
• Structure de l'objet Transactions
• Structure de l'objet Balance
• Structure de l'objet de recherche Web
• Structure de l'objet Memory