Estructura de configuración

Nota: Los campos que no se mencionan específicamente como obligatorios son opcionales.

version

• obligatorio

cache

skillSync

ver: Estructura del objeto Skill Sync

messageFilter

ver: Estructura del objeto de filtro de mensajes

fileStrategy

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

• Notas:
  • "cloudfront" almacena archivos en S3 y devuelve URLs de CloudFront para una entrega de medios estable, cookies firmadas y descargas firmadas.
  • "firebase" sirve archivos a través de Firebase Storage y las ubicaciones perimetrales (edge locations) de Firebase Hosting.
  • S3 sirve archivos a través de presigned URLs (tokens firmados temporales) que caducan. Una vez caducados, cualquier imagen o avatar que haga referencia a esa URL aparecerá roto en la UI. Esto hace que S3 no sea adecuado como estrategia principal para activos visuales. Consulta la related discussion para más detalles.
  • Para obtener el mejor rendimiento de imágenes y avatares, utilice "cloudfront" o "firebase", o configure fileStrategies para dirigir avatar e image a una estrategia respaldada por una CDN.
  • Consulte la documentación de File Storage & CDN para obtener detalles sobre la configuración.

fileStrategies

Permite un control granular sobre las estrategias de almacenamiento de archivos para diferentes tipos de archivos.

• Estrategias disponibles: "local" | "firebase" | "s3" | "azure_blob" | "cloudfront"

Sub-claves:

• Notas:
  • Esta configuración tiene prioridad sobre la opción única fileStrategy
  • Si un tipo de archivo específico no está configurado, recurre a default, luego a fileStrategy y, finalmente, a "local".
  • Las imágenes y los avatares necesitan URLs persistentes y estables para renderizarse correctamente en toda la interfaz de usuario. Las URLs prefirmadas de S3 caducan (límite de AWS: 7 días para usuarios IAM, horas para credenciales basadas en STS/roles), lo que provoca que las imágenes se rompan en el selector de modelos y en la interfaz de chat. Consulta la discusión relacionada para obtener el contexto completo. Utiliza "cloudfront" o "firebase" para avatar e image para evitar esto.
  • S3 y Azure Blob Storage son adecuados para el almacenamiento de document, donde las URLs de descarga prefirmadas de corta duración son apropiadas.
  • Consulte la documentación de File Storage & CDN para obtener detalles de configuración para cada proveedor de almacenamiento.

Ejemplos:

# 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

Clave:

Subclaves:

ver: Estructura de objetos de CloudFront y CloudFront con S3

filteredTools

• Notas:
  • Si se especifican tanto includedTools como filteredTools, solo se reconocerá includedTools.
  • Afecta tanto a los endpoints gptPlugins como a assistants
  • Puedes encontrar los nombres de las herramientas para filtrar en api/app/clients/tools/manifest.json
    • Utilice el valor de pluginKey
  • Además, cualquiera que aparezca en el directorio ".well-known" api/app/clients/tools/.well-known
    • Utilice el valor de name_for_model

includedTools

• Notas:
  • Si se especifican tanto includedTools como filteredTools, solo se reconocerá includedTools.
  • Afecta tanto a los endpoints gptPlugins como a assistants
  • Puedes encontrar los nombres de las herramientas para filtrar en api/app/clients/tools/manifest.json
    • Utilice el valor de pluginKey
  • Además, cualquiera que aparezca en el directorio ".well-known" api/app/clients/tools/.well-known
    • Utilice el valor de name_for_model

secureImageLinks

imageOutputType

• Nota: Distingue entre mayúsculas y minúsculas. El endpoint de Google solo admite los tipos de salida "jpeg" y "png".
• Opciones: "png" | "webp" | "jpeg"

ocr

Clave:

Subclaves:

ver: Estructura del objeto de configuración OCR

webSearch

Clave:

Subclaves:

ver: Estructura del objeto de búsqueda web

fileConfig

Clave:

Subclaves:

clientImageResize

Clave:

Subclaves:

Descripción:

La configuración clientImageResize permite el cambio de tamaño automático de imágenes en el lado del cliente antes de subirlas. Esta función ayuda a:

• Evitar errores de carga debido a archivos de imagen grandes que exceden los límites del servidor
• Reduce el uso de ancho de banda comprimiendo las imágenes antes de su transmisión
• Mejora el rendimiento de carga con tamaños de archivo más pequeños
• Mantener la calidad de la imagen mientras se optimiza el tamaño del archivo

Cuando está habilitado, las imágenes que exceden las dimensiones maxWidth o maxHeight especificadas se redimensionan automáticamente en el lado del cliente antes de ser cargadas al servidor. El redimensionamiento mantiene la relación de aspecto original mientras asegura que la imagen se ajuste dentro de los límites especificados.

Ejemplo:

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

Notas:

• Solo se aplica a archivos de imagen (JPEG, PNG, WebP, etc.)
• El cambio de tamaño ocurre automáticamente cuando las imágenes exceden las dimensiones especificadas
• La relación de aspecto original se conserva durante el cambio de tamaño
• La función funciona con todos los endpoints de carga de imágenes compatibles
• El ajuste de calidad solo se aplica a los formatos JPEG y WebP
• Configurar la calidad demasiado baja (< 0.5) puede resultar en una degradación notable de la imagen

ver: Estructura del objeto de configuración de archivos

rateLimits

Clave:

Subclaves:

Subclaves de fileUploads:

Subclaves de conversationsImport:

Subclaves de tts:

Subclaves de stt:

• Ejemplo:

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

Clave:

Subclaves:

ver también:

• socialLogins,
• alloweddomains,
• Estructura del objeto de registro

memory

Clave:

Subclaves:

ver: Estructura del objeto Memory

summarization

Clave:

Subclaves:

ver: Estructura del objeto de resumen

actions

Clave:

Subclaves:

ver también:

• allowedDomains,
• allowedAddresses,
• Estructura del objeto Actions

interface

Clave:

Subclaves:

ver: Estructura del objeto de interfaz

modelSpecs

Clave:

Subclaves:

ver: Estructura del objeto Model Specs

endpoints

Clave:

Subclaves:

Nota: Los endpoints admiten Shared Endpoint Settings tales como streamRate, headers, titleModel, titleMethod, titlePrompt, titlePromptTemplate, titleEndpoint y maxToolResultChars. Estos pueden configurarse individualmente por endpoint o globalmente utilizando la clave all. Los headers se combinan, prevaleciendo los valores a nivel de endpoint en caso de colisión de claves. La clave all no acepta baseURL.

Nota: endpoints.allowedAddresses se aplica a los valores de baseURL proporcionados por el usuario (cuando un administrador configura un endpoint personalizado con apiKey: 'user_provided' y baseURL: 'user_provided'). Cada baseURL suministrada por el usuario se valida contra el bloqueo SSRF en el momento de la solicitud; las entradas listadas aquí están exentas. Consulta mcpSettings.allowedAddresses para conocer la semántica del campo; se aplican las mismas reglas (solo espacio de IP privada, puerto requerido, sin URLs/rutas/CIDR/hosts simples/literales de IP pública).

mcpSettings

Clave:

Subclaves:

• Notas:
  • Esta es una función de seguridad para proteger contra el abuso / uso indebido de direcciones internas a través de servidores MCP
  • De forma predeterminada, LibreChat restringe que los servidores MCP se conecten a direcciones de red internas, locales o privadas.
  • Los servidores MCP que utilizan direcciones IP locales o dominios pueden añadirse a la lista blanca estricta allowedDomains (que se convierte entonces en el único conjunto accesible), o bien, para mantener accesibles los destinos públicos, pueden excluirse como servicios exactos de host:puerto mediante allowedAddresses.
  • Como ocurre con todos los cambios de configuración en yaml, es necesario reiniciar LibreChat para que surtan efecto.
  • Admite dominios, subdominios comodín (*.example.com), dominios Docker y direcciones IP

Ejemplo:

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

ver: Estructura del objeto de configuración de MCP

mcpServers

Clave:

Subclaves:

• Notas:
  • La inicialización ocurre al iniciar, y la aplicación debe reiniciarse para que los cambios surtan efecto.
  • El <serverName> es un identificador único para cada configuración de servidor MCP.
  • Cada servidor MCP puede configurarse utilizando uno de los cuatro tipos de conexión:
    • stdio
    • websocket
    • sse
    • streamable-http
  • El campo type especifica el tipo de conexión al servidor MCP.
  • Si se omite type, se establece de forma predeterminada según la presencia y el formato de url o command:
    • Si se especifica url y comienza con http o https, type se establece de forma predeterminada en sse.
    • Si se especifica url y comienza con ws o wss, type se establece de forma predeterminada en websocket.
    • Si se especifica command, type toma stdio como valor predeterminado.
  • Las opciones de configuración adicionales incluyen:
    • timeout: Tiempo de espera en milisegundos para las solicitudes al servidor MCP. Determina cuánto tiempo esperar una respuesta para las solicitudes de herramientas.
    • initTimeout: Tiempo de espera en milisegundos para la inicialización del servidor MCP. Determina cuánto tiempo esperar a que el servidor se inicialice.
    • serverInstructions: Controla si las instrucciones del servidor se incluyen en el contexto del agente. Puede ser true (usar las proporcionadas por el servidor), false (deshabilitado) o una cadena personalizada (anula las proporcionadas por el servidor).
    • customUserVars: (Opcional) Define variables personalizadas (por ejemplo, claves de API, URLs) que los usuarios individuales pueden configurar para un servidor MCP. Estos valores por usuario, proporcionados a través de la interfaz de usuario, pueden ser referenciados en las configuraciones de headers o env del servidor utilizando la sintaxis {{VARIABLE_NAME}}. Esto permite la autenticación o personalización por usuario para las herramientas MCP.
  • ver: Estructura del objeto MCP Servers

Ejemplo:

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

ver: Estructura del objeto MCP Servers

speech

Clave:

Subclaves:

ver: Estructura del objeto Speech

turnstile

Clave:

Subclaves:

ver: Estructura del objeto Turnstile

transactions

Clave:

Subclaves:

ver: Estructura del objeto Transactions

Enlaces adicionales

• Estructura del objeto de resumen
• Estructura de objeto de AWS Bedrock
• Estructura del objeto de endpoint personalizado
• Estructura del objeto del endpoint de Azure OpenAI
• Estructura del objeto del endpoint Assistants
• Agentes
• Estructura del objeto de configuración OCR
• Estructura del objeto Speech
• Estructura del objeto Turnstile
• Estructura del objeto Transactions
• Estructura del objeto Balance
• Estructura del objeto de búsqueda web
• Estructura del objeto de memoria