Struktura konfiguracji

Uwaga: Pola, które nie zostały wyraźnie określone jako wymagane, są opcjonalne.

version

• wymagane

cache

skillSync

zobacz: Struktura obiektu Skill Sync

messageFilter

zobacz: Struktura obiektu filtra wiadomości

fileStrategy

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

• Uwagi:
  • "cloudfront" przechowuje pliki w S3 i zwraca adresy URL CloudFront w celu zapewnienia stabilnego dostarczania mediów, podpisanych plików cookie oraz podpisanych pobrań.
  • "firebase" serwuje pliki za pośrednictwem Firebase Storage oraz lokalizacji brzegowych Firebase Hosting.
  • S3 udostępnia pliki za pośrednictwem presigned URLs (tymczasowych podpisanych tokenów), które wygasają. Po wygaśnięciu każdy obraz lub awatar odwołujący się do tego adresu URL będzie wyświetlany jako uszkodzony w interfejsie użytkownika. Sprawia to, że S3 nie nadaje się jako główna strategia przechowywania zasobów wizualnych. Szczegółowe informacje znajdują się w powiązanej dyskusji.
  • Aby uzyskać najlepszą wydajność obrazów i awatarów, użyj "cloudfront" lub "firebase" albo skonfiguruj fileStrategies, aby kierować avatar i image do strategii opartej na CDN.
  • Szczegółowe informacje na temat konfiguracji znajdują się w dokumentacji File Storage & CDN

fileStrategies

Umożliwia szczegółową kontrolę nad strategiami przechowywania plików dla różnych typów plików.

• Dostępne strategie: "local" | "firebase" | "s3" | "azure_blob" | "cloudfront"

Podklucze:

• Uwagi:
  • To ustawienie ma pierwszeństwo przed pojedynczą opcją fileStrategy
  • Jeśli określony typ pliku nie jest skonfigurowany, system używa wartości default, następnie fileStrategy, a na końcu "local".
  • Obrazy i awatary wymagają trwałych, stabilnych adresów URL, aby poprawnie renderować się w interfejsie użytkownika. Wstępnie podpisane adresy URL S3 wygasają (limit AWS: 7 dni dla użytkowników IAM, godziny dla poświadczeń opartych na STS/rolach), co powoduje błędy wyświetlania obrazów w selektorze modeli i interfejsie czatu. Zobacz powiązaną dyskusję, aby uzyskać pełny kontekst. Użyj "cloudfront" lub "firebase" dla avatar oraz image, aby tego uniknąć.
  • S3 oraz Azure Blob Storage świetnie sprawdzają się w przypadku przechowywania document, gdzie krótkotrwałe, wstępnie podpisane adresy URL do pobierania są odpowiednim rozwiązaniem.
  • Szczegółowe informacje na temat konfiguracji każdego dostawcy pamięci masowej znajdują się w dokumentacji File Storage & CDN

Przykłady:

# 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

Klucz:

Podklucze:

zobacz: Struktura obiektu CloudFront oraz CloudFront z S3

filteredTools

• Uwagi:
  • Jeśli określono zarówno includedTools, jak i filteredTools, rozpoznane zostanie tylko includedTools.
  • Dotyczy zarówno endpointów gptPlugins, jak i assistants
  • Nazwy narzędzi do filtrowania można znaleźć w pliku api/app/clients/tools/manifest.json
    • Użyj wartości pluginKey
  • Ponadto, wszelkie wymienione w katalogu ".well-known" api/app/clients/tools/.well-known
    • Użyj wartości name_for_model

includedTools

• Uwagi:
  • Jeśli określono zarówno includedTools, jak i filteredTools, rozpoznane zostanie tylko includedTools.
  • Dotyczy zarówno endpointów gptPlugins, jak i assistants
  • Nazwy narzędzi do filtrowania można znaleźć w pliku api/app/clients/tools/manifest.json
    • Użyj wartości pluginKey
  • Ponadto, wszelkie wymienione w katalogu ".well-known" api/app/clients/tools/.well-known
    • Użyj wartości name_for_model

secureImageLinks

imageOutputType

• Uwaga: Wielkość liter ma znaczenie. Endpoint Google obsługuje wyłącznie typy wyjściowe „jpeg” oraz „png”.
• Opcje: "png" | "webp" | "jpeg"

ocr

Klucz:

Podklucze:

zobacz: Struktura obiektu konfiguracji OCR

webSearch

Klucz:

Podklucze:

zobacz: Struktura obiektu wyszukiwania w sieci

fileConfig

Klucz:

Podklucze:

clientImageResize

Klucz:

Podklucze:

Opis:

Konfiguracja clientImageResize umożliwia automatyczną zmianę rozmiaru obrazów po stronie klienta przed ich przesłaniem. Ta funkcja pomaga:

• Zapobieganie błędom przesyłania spowodowanym przez duże pliki graficzne przekraczające limity serwera
• Zmniejsz zużycie pasma poprzez kompresję obrazów przed transmisją
• Popraw wydajność przesyłania dzięki mniejszym rozmiarom plików
• Zachowaj jakość obrazu przy jednoczesnej optymalizacji rozmiaru pliku

Po włączeniu tej opcji obrazy przekraczające określone wymiary maxWidth lub maxHeight są automatycznie skalowane po stronie klienta przed przesłaniem na serwer. Skalowanie zachowuje oryginalne proporcje, zapewniając jednocześnie, że obraz mieści się w określonych granicach.

Przykład:

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

Uwagi:

• Dotyczy tylko plików graficznych (JPEG, PNG, WebP itp.)
• Zmiana rozmiaru następuje automatycznie, gdy obrazy przekraczają określone wymiary
• Oryginalne proporcje obrazu są zachowywane podczas zmiany rozmiaru
• Ta funkcja działa ze wszystkimi obsługiwanymi endpointami przesyłania obrazów
• Ustawienie jakości dotyczy tylko formatów JPEG i WebP
• Ustawienie jakości na zbyt niską (< 0.5) może skutkować zauważalną degradacją obrazu

zobacz: Struktura obiektu konfiguracji pliku

rateLimits

Klucz:

Podklucze:

Podklucze fileUploads:

Podklucze conversationsImport:

Podklucze tts:

Podklucze stt:

• Przykład:

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

Klucz:

Podklucze:

zobacz także:

• socialLogins,
• alloweddomains,
• Struktura obiektu rejestracji

memory

Klucz:

Podklucze:

zobacz: Struktura obiektu Memory

summarization

Klucz:

Podklucze:

zobacz: Struktura obiektu podsumowania

actions

Klucz:

Podklucze:

zobacz także:

• allowedDomains,
• allowedAddresses,
• Struktura obiektu Actions

interface

Klucz:

Podklucze:

zobacz: Struktura obiektu interfejsu

modelSpecs

Klucz:

Podklucze:

zobacz: Struktura obiektu Model Specs

endpoints

Klucz:

Podklucze:

Uwaga: Endpointy obsługują Shared Endpoint Settings, takie jak streamRate, headers, titleModel, titleMethod, titlePrompt, titlePromptTemplate, titleEndpoint oraz maxToolResultChars. Można je skonfigurować indywidualnie dla każdego endpointu lub globalnie przy użyciu klucza all. Wartości headers są scalane, przy czym wartości na poziomie endpointu mają pierwszeństwo w przypadku kolizji kluczy. Klucz all nie akceptuje baseURL.

Uwaga: endpoints.allowedAddresses ma zastosowanie do wartości baseURL podawanych przez użytkownika (gdy administrator konfiguruje niestandardowy endpoint z apiKey: 'user_provided' oraz baseURL: 'user_provided'). Każdy dostarczony przez użytkownika baseURL jest sprawdzany pod kątem blokady SSRF w momencie żądania; wpisy wymienione tutaj są z niej wyłączone. Zobacz mcpSettings.allowedAddresses, aby poznać semantykę tego pola — obowiązują te same zasady (tylko prywatna przestrzeń adresów IP, wymagany port, brak adresów URL/ścieżek/CIDR/samych nazw hostów/publicznych literałów IP).

mcpSettings

Klucz:

Podklucze:

• Uwagi:
  • Jest to funkcja bezpieczeństwa chroniąca przed nadużyciami / niewłaściwym wykorzystaniem adresów wewnętrznych za pośrednictwem serwerów MCP
  • Domyślnie LibreChat ogranicza serwerom MCP możliwość łączenia się z wewnętrznymi, lokalnymi lub prywatnymi adresami sieciowymi.
  • Serwery MCP korzystające z lokalnych adresów IP lub domen można dodać do ścisłej białej listy allowedDomains (która stanie się wówczas jedynym dostępnym zestawem), lub — aby zachować dostępność publicznych miejsc docelowych — wykluczyć je jako dokładne usługi host:port za pomocą allowedAddresses.
  • Jak w przypadku wszystkich zmian w konfiguracji yaml, wymagany jest restart LibreChat, aby weszły one w życie.
  • Obsługuje domeny, wieloznaczne subdomeny (*.example.com), domeny Docker oraz adresy IP

Przykład:

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

zobacz: Struktura obiektu ustawień MCP

mcpServers

Klucz:

Podklucze:

• Uwagi:
  • Inicjalizacja następuje podczas uruchamiania, a aplikacja musi zostać zrestartowana, aby zmiany weszły w życie.
  • <serverName> to unikalny identyfikator dla każdej konfiguracji serwera MCP.
  • Każdy serwer MCP można skonfigurować przy użyciu jednego z czterech typów połączeń:
    • stdio
    • websocket
    • sse
    • streamable-http
  • Pole type określa typ połączenia z serwerem MCP.
  • Jeśli type zostanie pominięty, jego wartość domyślna zostanie ustalona na podstawie obecności i formatu url lub command:
    • Jeśli określono url i zaczyna się on od http lub https, type domyślnie przyjmuje wartość sse.
    • Jeśli określono url i zaczyna się on od ws lub wss, type domyślnie przyjmuje wartość websocket.
    • Jeśli określono command, type domyślnie przyjmuje wartość stdio.
  • Dodatkowe opcje konfiguracji obejmują:
    • timeout: Limit czasu w milisekundach dla żądań serwera MCP. Określa, jak długo czekać na odpowiedź w przypadku żądań narzędzi.
    • initTimeout: Limit czasu w milisekundach dla inicjalizacji serwera MCP. Określa, jak długo czekać na zainicjowanie serwera.
    • serverInstructions: Określa, czy instrukcje serwera są uwzględniane w kontekście agenta. Może przyjmować wartość true (użyj dostarczonych przez serwer), false (wyłączone) lub niestandardowy ciąg znaków (nadpisuje te dostarczone przez serwer).
    • customUserVars: (Opcjonalne) Definiuje niestandardowe zmienne (np. klucze API, adresy URL), które poszczególni użytkownicy mogą ustawić dla serwera MCP. Te wartości dla poszczególnych użytkowników, dostarczane przez interfejs użytkownika, mogą być następnie przywoływane w konfiguracjach headers lub env serwera przy użyciu składni {{VARIABLE_NAME}}. Pozwala to na uwierzytelnianie lub dostosowywanie narzędzi MCP dla każdego użytkownika z osobna.
  • zobacz: Struktura obiektu MCP Servers

Przykład:

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

zobacz: Struktura obiektu MCP Servers

speech

Klucz:

Podklucze:

zobacz: Struktura obiektu mowy

turnstile

Klucz:

Podklucze:

zobacz: Turnstile Object Structure

transactions

Klucz:

Podklucze:

zobacz: Struktura obiektu Transactions

Dodatkowe linki

• Struktura obiektu podsumowania
• Struktura obiektu AWS Bedrock
• Struktura obiektu niestandardowego endpointu
• Struktura obiektu endpointu Azure OpenAI
• Struktura obiektu endpointu Assistants
• Agenci
• Struktura obiektu konfiguracji OCR
• Struktura obiektu mowy
• Struktura obiektu Turnstile
• Struktura obiektu Transactions
• Struktura obiektu Balance
• Struktura obiektu wyszukiwania w sieci
• Struktura obiektu Memory