Struttura della configurazione

Nota: I campi non specificati esplicitamente come obbligatori sono facoltativi.

version

• obbligatorio

cache

skillSync

vedi: Struttura dell'oggetto Skill Sync

messageFilter

vedi: Struttura dell'oggetto filtro messaggi

fileStrategy

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

• Note:
  • "cloudfront" archivia i file in S3 e restituisce URL CloudFront per una distribuzione multimediale stabile, cookie firmati e download firmati.
  • "firebase" serve i file tramite le posizioni edge di Firebase Storage e Firebase Hosting.
  • S3 serve i file tramite presigned URLs (token firmati temporanei) che scadono. Una volta scaduti, qualsiasi immagine o avatar che fa riferimento a quell'URL apparirà interrotto nell'interfaccia utente. Questo rende S3 inadatto come strategia primaria per le risorse visive. Vedi la discussione correlata per i dettagli.
  • Per ottenere le migliori prestazioni con immagini e avatar, utilizza "cloudfront" o "firebase", oppure configura fileStrategies per instradare avatar e image verso una strategia basata su CDN.
  • Si prega di fare riferimento alla documentazione su File Storage & CDN per i dettagli sulla configurazione.

fileStrategies

Consente un controllo granulare sulle strategie di archiviazione dei file per diversi tipi di file.

• Strategie disponibili: "local" | "firebase" | "s3" | "azure_blob" | "cloudfront"

Sotto-chiavi:

• Note:
  • Questa impostazione ha la precedenza sulla singola opzione fileStrategy
  • Se un tipo di file specifico non è configurato, viene utilizzato il fallback su default, poi su fileStrategy e infine su "local".
  • Le immagini e gli avatar necessitano di URL persistenti e stabili per essere visualizzati correttamente nell'interfaccia utente. Gli URL pre-firmati S3 scadono (limite AWS: 7 giorni per utenti IAM, ore per credenziali basate su STS/ruoli), causando la rottura delle immagini nel selettore del modello e nell'interfaccia di chat. Consulta la discussione correlata per il contesto completo. Utilizza "cloudfront" o "firebase" per avatar e image per evitare questo problema.
  • S3 e Azure Blob Storage sono adatti per l'archiviazione di document, dove gli URL di download pre-firmati a breve termine sono appropriati.
  • Si prega di fare riferimento alla documentazione su File Storage & CDN per i dettagli di configurazione di ciascun provider di archiviazione.

Esempi:

# 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

Chiave:

Sottochiavi:

vedi: Struttura dell'oggetto CloudFront e CloudFront con S3

filteredTools

• Note:
  • Se vengono specificati sia includedTools che filteredTools, verrà riconosciuto solo includedTools.
  • Influisce sia sugli endpoint gptPlugins che su quelli assistants
  • Puoi trovare i nomi degli strumenti da filtrare in api/app/clients/tools/manifest.json
    • Usa il valore pluginKey
  • Inoltre, qualsiasi elemento elencato nella directory ".well-known" api/app/clients/tools/.well-known
    • Utilizza il valore name_for_model

includedTools

• Note:
  • Se vengono specificati sia includedTools che filteredTools, verrà riconosciuto solo includedTools.
  • Influisce sia sugli endpoint gptPlugins che su quelli assistants
  • Puoi trovare i nomi degli strumenti da filtrare in api/app/clients/tools/manifest.json
    • Usa il valore pluginKey
  • Inoltre, qualsiasi elemento elencato nella directory ".well-known" api/app/clients/tools/.well-known
    • Utilizza il valore name_for_model

secureImageLinks

imageOutputType

• Nota: Case-sensitive. L'endpoint Google supporta solo i tipi di output "jpeg" e "png".
• Opzioni: "png" | "webp" | "jpeg"

ocr

Chiave:

Sottochiavi:

vedi: Struttura dell'oggetto di configurazione OCR

webSearch

Chiave:

Sottochiavi:

vedi: Struttura dell'oggetto Web Search

fileConfig

Chiave:

Sottochiavi:

clientImageResize

Chiave:

Sottochiavi:

Descrizione:

La configurazione clientImageResize abilita il ridimensionamento automatico delle immagini lato client prima del caricamento. Questa funzionalità aiuta a:

• Previeni errori di caricamento dovuti a file immagine di grandi dimensioni che superano i limiti del server
• Riduci l'utilizzo della larghezza di banda comprimendo le immagini prima della trasmissione
• Migliora le prestazioni di caricamento con dimensioni dei file ridotte
• Mantieni la qualità dell'immagine ottimizzando al contempo le dimensioni del file

Quando abilitato, le immagini che superano le dimensioni maxWidth o maxHeight specificate vengono ridimensionate automaticamente lato client prima di essere caricate sul server. Il ridimensionamento mantiene le proporzioni originali, assicurando che l'immagine rientri nei limiti specificati.

Esempio:

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

Note:

• Si applica solo ai file immagine (JPEG, PNG, WebP, ecc.)
• Il ridimensionamento avviene automaticamente quando le immagini superano le dimensioni specificate
• Le proporzioni originali vengono mantenute durante il ridimensionamento
• La funzionalità funziona con tutti gli endpoint di caricamento immagini supportati
• L'impostazione della qualità si applica solo ai formati JPEG e WebP
• Impostare la qualità su un valore troppo basso (< 0.5) potrebbe causare un notevole degrado dell'immagine

vedi: Struttura dell'oggetto di configurazione file

rateLimits

Chiave:

Sottochiavi:

Sottochiavi fileUploads:

Sottochiavi conversationsImport:

Sottochiavi tts:

Sottochiavi stt:

• Esempio:

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

Chiave:

Sottochiavi:

vedi anche:

• socialLogins,
• alloweddomains,
• Struttura dell'oggetto di registrazione

memory

Chiave:

Sottochiavi:

vedi: Struttura dell'oggetto Memory

summarization

Chiave:

Sottochiavi:

vedi: Struttura dell'oggetto di riepilogo

actions

Chiave:

Sottochiavi:

vedi anche:

• allowedDomains,
• allowedAddresses,
• Struttura dell'oggetto Actions

interface

Chiave:

Sottochiavi:

vedi: Struttura dell'oggetto interfaccia

modelSpecs

Chiave:

Sottochiavi:

vedi: Struttura dell'oggetto Model Specs

endpoints

Chiave:

Sottochiavi:

Nota: Gli endpoint supportano Shared Endpoint Settings come streamRate, headers, titleModel, titleMethod, titlePrompt, titlePromptTemplate, titleEndpoint e maxToolResultChars. Questi possono essere configurati singolarmente per ogni endpoint o globalmente utilizzando la chiave all. Gli headers vengono uniti, con i valori a livello di endpoint che prevalgono in caso di collisione delle chiavi. La chiave all non accetta baseURL.

Nota: endpoints.allowedAddresses si applica ai valori baseURL forniti dall'utente (quando un amministratore configura un endpoint personalizzato con apiKey: 'user_provided' e baseURL: 'user_provided'). Ogni baseURL fornita dall'utente viene convalidata rispetto al blocco SSRF al momento della richiesta; le voci elencate qui sono esentate. Vedi mcpSettings.allowedAddresses per la semantica del campo: si applicano le stesse regole (solo spazio IP privato, porta richiesta, niente URL/percorsi/CIDR/host semplici/letterali IP pubblici).

mcpSettings

Chiave:

Sottochiavi:

• Note:
  • Questa è una funzionalità di sicurezza per proteggere da abusi / utilizzi impropri di indirizzi interni tramite server MCP
  • Per impostazione predefinita, LibreChat impedisce ai server MCP di connettersi a indirizzi di rete interni, locali o privati.
  • I server MCP che utilizzano indirizzi IP locali o domini possono essere aggiunti alla whitelist rigorosa allowedDomains (che diventa quindi l'unico insieme raggiungibile), oppure, per mantenere raggiungibili le destinazioni pubbliche, possono essere esentati come servizi host:porta esatti tramite allowedAddresses
  • Come per tutte le modifiche alla configurazione yaml, è necessario riavviare LibreChat affinché abbiano effetto.
  • Supporta domini, sottodomini wildcard (*.example.com), domini Docker e indirizzi IP

Esempio:

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

vedi: Struttura dell'oggetto MCP Settings

mcpServers

Chiave:

Sottochiavi:

• Note:
  • L'inizializzazione avviene all'avvio e l'app deve essere riavviata affinché le modifiche abbiano effetto.
  • <serverName> è un identificatore univoco per ogni configurazione del server MCP.
  • Ogni server MCP può essere configurato utilizzando uno dei quattro tipi di connessione:
    • stdio
    • websocket
    • sse
    • streamable-http
  • Il campo type specifica il tipo di connessione al server MCP.
  • Se type viene omesso, viene impostato come predefinito in base alla presenza e al formato di url o command:
    • Se url è specificato e inizia con http o https, type è impostato come sse per impostazione predefinita.
    • Se url è specificato e inizia con ws o wss, type è impostato per impostazione predefinita su websocket.
    • Se command è specificato, type è impostato come stdio per impostazione predefinita.
  • Ulteriori opzioni di configurazione includono:
    • timeout: Timeout in millisecondi per le richieste al server MCP. Determina quanto tempo attendere una risposta per le richieste di strumenti (tool).
    • initTimeout: Timeout in millisecondi per l'inizializzazione del server MCP. Determina quanto tempo attendere affinché il server si inizializzi.
    • serverInstructions: Controlla se le istruzioni del server sono incluse nel contesto dell'agente. Può essere true (usa quelle fornite dal server), false (disabilitato) o una stringa personalizzata (sovrascrive quelle fornite dal server).
    • customUserVars: (Opzionale) Definisce variabili personalizzate (ad esempio, chiavi API, URL) che i singoli utenti possono impostare per un server MCP. Questi valori per utente, forniti tramite l'interfaccia utente, possono quindi essere referenziati nelle configurazioni headers o env del server utilizzando la sintassi {{VARIABLE_NAME}}. Ciò consente l'autenticazione o la personalizzazione per utente per gli strumenti MCP.
  • vedi: Struttura dell'oggetto MCP Servers

Esempio:

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

vedi: Struttura dell'oggetto MCP Servers

speech

Chiave:

Sottochiavi:

vedi: Struttura dell'oggetto Speech

turnstile

Chiave:

Sottochiavi:

vedi: Struttura dell'oggetto Turnstile

transactions

Chiave:

Sottochiavi:

vedi: Struttura dell'oggetto Transactions

Link aggiuntivi

• Struttura dell'oggetto di riepilogo
• Struttura dell'oggetto AWS Bedrock
• Struttura dell'oggetto endpoint personalizzato
• Struttura dell'oggetto endpoint Azure OpenAI
• Struttura dell'oggetto dell'endpoint Assistants
• Agenti
• Struttura dell'oggetto di configurazione OCR
• Struttura dell'oggetto Speech
• Struttura dell'oggetto Turnstile
• Struttura dell'oggetto Transactions
• Struttura dell'oggetto Balance
• Struttura dell'oggetto Ricerca Web
• Struttura dell'oggetto Memory