Struktur Konfigurasi

Catatan: Bidang yang tidak disebutkan secara khusus sebagai wajib bersifat opsional.

version

• wajib

cache

skillSync

lihat: Struktur Objek Skill Sync

messageFilter

lihat: Struktur Objek Filter Pesan

fileStrategy

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

• Catatan:
  • "cloudfront" menyimpan file di S3 dan mengembalikan URL CloudFront untuk pengiriman media yang stabil, cookie yang ditandatangani (signed cookies), dan unduhan yang ditandatangani (signed downloads).
  • "firebase" menyajikan file melalui lokasi edge Firebase Storage dan Firebase Hosting.
  • S3 menyajikan file melalui presigned URLs (token bertanda tangan sementara) yang memiliki masa kedaluwarsa. Setelah kedaluwarsa, gambar atau avatar apa pun yang merujuk pada URL tersebut akan tampak rusak di UI. Hal ini membuat S3 tidak cocok sebagai strategi utama untuk aset visual. Lihat diskusi terkait untuk detailnya.
  • Untuk performa terbaik gambar dan avatar, gunakan "cloudfront" atau "firebase", atau konfigurasikan fileStrategies untuk mengarahkan avatar dan image ke strategi yang didukung CDN.
  • Silakan merujuk ke dokumentasi File Storage & CDN untuk detail penyiapan.

fileStrategies

Memberikan kontrol terperinci atas strategi penyimpanan file untuk berbagai jenis file.

• Strategi yang Tersedia: "local" | "firebase" | "s3" | "azure_blob" | "cloudfront"

Sub-kunci:

• Catatan:
  • Pengaturan ini lebih diutamakan daripada opsi fileStrategy tunggal
  • Jika tipe file tertentu tidak dikonfigurasi, sistem akan kembali ke default, kemudian ke fileStrategy, dan terakhir ke "local"
  • Gambar dan avatar memerlukan URL yang persisten dan stabil agar dapat dirender dengan benar di seluruh UI. URL presigned S3 akan kedaluwarsa (batas AWS: 7 hari untuk pengguna IAM, beberapa jam untuk kredensial berbasis STS/peran), yang menyebabkan gambar rusak di pemilih model dan UI obrolan. Lihat diskusi terkait untuk konteks lengkapnya. Gunakan "cloudfront" atau "firebase" untuk avatar dan image guna menghindari masalah ini.
  • S3 dan Azure Blob Storage sangat cocok untuk penyimpanan document, di mana URL unduhan presigned yang berumur pendek adalah pilihan yang tepat.
  • Silakan merujuk ke File Storage & CDN documentation untuk detail pengaturan bagi setiap penyedia penyimpanan.

Contoh:

# 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

Kunci:

Subkey:

lihat: Struktur Objek CloudFront dan CloudFront dengan S3

filteredTools

• Catatan:
  • Jika includedTools dan filteredTools keduanya ditentukan, hanya includedTools yang akan dikenali.
  • Mempengaruhi endpoint gptPlugins maupun assistants
  • Anda dapat menemukan nama-nama alat untuk difilter di api/app/clients/tools/manifest.json
    • Gunakan nilai pluginKey
  • Selain itu, apa pun yang tercantum di bawah direktori ".well-known" api/app/clients/tools/.well-known
    • Gunakan nilai name_for_model

includedTools

• Catatan:
  • Jika includedTools dan filteredTools keduanya ditentukan, hanya includedTools yang akan dikenali.
  • Mempengaruhi endpoint gptPlugins maupun assistants
  • Anda dapat menemukan nama-nama alat untuk difilter di api/app/clients/tools/manifest.json
    • Gunakan nilai pluginKey
  • Selain itu, apa pun yang tercantum di bawah direktori ".well-known" api/app/clients/tools/.well-known
    • Gunakan nilai name_for_model

secureImageLinks

imageOutputType

• Catatan: Sensitif terhadap huruf besar-kecil (case-sensitive). Endpoint Google hanya mendukung tipe output "jpeg" dan "png".
• Opsi: "png" | "webp" | "jpeg"

ocr

Kunci:

Subkey:

lihat: Struktur Objek Konfigurasi OCR

webSearch

Kunci:

Subkey:

lihat: Struktur Objek Pencarian Web

fileConfig

Kunci:

Subkey:

clientImageResize

Kunci:

Subkey:

Deskripsi:

Konfigurasi clientImageResize memungkinkan pengubahan ukuran gambar secara otomatis di sisi klien sebelum diunggah. Fitur ini membantu:

• Cegah kegagalan unggahan akibat file gambar berukuran besar yang melebihi batas server
• Kurangi penggunaan bandwidth dengan mengompresi gambar sebelum transmisi
• Tingkatkan performa unggahan dengan ukuran file yang lebih kecil
• Pertahankan kualitas gambar sambil mengoptimalkan ukuran file

Saat diaktifkan, gambar yang melebihi dimensi maxWidth atau maxHeight yang ditentukan akan diubah ukurannya secara otomatis di sisi klien sebelum diunggah ke server. Pengubahan ukuran ini mempertahankan rasio aspek asli sekaligus memastikan gambar pas dalam batas yang ditentukan.

Contoh:

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

Catatan:

• Hanya berlaku untuk file gambar (JPEG, PNG, WebP, dll.)
• Pengubahan ukuran terjadi secara otomatis ketika gambar melebihi dimensi yang ditentukan
• Aspek rasio asli dipertahankan selama pengubahan ukuran
• Fitur ini berfungsi dengan semua endpoint unggah gambar yang didukung
• Pengaturan kualitas hanya berlaku untuk format JPEG dan WebP
• Mengatur kualitas terlalu rendah (< 0.5) dapat menyebabkan penurunan kualitas gambar yang terlihat jelas.

lihat: Struktur Objek Konfigurasi File

rateLimits

Kunci:

Subkey:

Subkey fileUploads:

Subkey conversationsImport:

Subkey tts:

Subkey stt:

• Contoh:

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

Kunci:

Subkey:

lihat juga:

• socialLogins,
• alloweddomains,
• Struktur Objek Registrasi

memory

Kunci:

Subkey:

lihat: Struktur Objek Memory

summarization

Kunci:

Subkey:

lihat: Struktur Objek Summarization

actions

Kunci:

Subkey:

lihat juga:

• allowedDomains,
• allowedAddresses,
• Struktur Objek Actions

interface

Kunci:

Subkey:

lihat: Struktur Objek Antarmuka

modelSpecs

Kunci:

Subkey:

lihat: Struktur Objek Model Specs

endpoints

Kunci:

Subkey:

Catatan: Endpoint mendukung Shared Endpoint Settings seperti streamRate, headers, titleModel, titleMethod, titlePrompt, titlePromptTemplate, titleEndpoint, dan maxToolResultChars. Pengaturan ini dapat dikonfigurasi secara individual per endpoint atau secara global menggunakan kunci all. headers akan digabungkan dengan nilai tingkat endpoint yang lebih diutamakan jika terjadi tabrakan kunci. Kunci all tidak menerima baseURL.

Catatan: endpoints.allowedAddresses berlaku untuk nilai baseURL yang disediakan pengguna (saat admin mengonfigurasi endpoint kustom dengan apiKey: 'user_provided' dan baseURL: 'user_provided'). Setiap baseURL yang disediakan pengguna divalidasi terhadap blok SSRF pada saat permintaan; entri yang tercantum di sini dikecualikan. Lihat mcpSettings.allowedAddresses untuk semantik bidang — aturan yang sama berlaku (hanya ruang IP privat, port diperlukan, tanpa URL/path/CIDR/host telanjang/literal IP publik).

mcpSettings

Kunci:

Subkey:

• Catatan:
  • Ini adalah fitur keamanan untuk melindungi dari penyalahgunaan / penggunaan yang tidak semestinya terhadap alamat internal melalui server MCP
  • Secara default, LibreChat membatasi server MCP agar tidak terhubung ke alamat jaringan internal, lokal, atau pribadi.
  • Server MCP yang menggunakan alamat IP lokal atau domain dapat ditambahkan ke daftar putih allowedDomains yang ketat (yang kemudian menjadi satu-satunya set yang dapat dijangkau), atau — agar tujuan publik tetap dapat dijangkau — dikecualikan sebagai layanan host:port yang tepat melalui allowedAddresses
  • Seperti halnya semua perubahan konfigurasi yaml, LibreChat perlu dimulai ulang agar perubahan tersebut diterapkan.
  • Mendukung domain, wildcard subdomain (*.example.com), domain Docker, dan alamat IP

Contoh:

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

lihat: Struktur Objek Pengaturan MCP

mcpServers

Kunci:

Subkey:

• Catatan:
  • Inisialisasi terjadi saat startup, dan aplikasi harus dimulai ulang agar perubahan dapat diterapkan.
  • <serverName> adalah pengidentifikasi unik untuk setiap konfigurasi server MCP.
  • Setiap server MCP dapat dikonfigurasi menggunakan salah satu dari empat tipe koneksi:
    • stdio
    • websocket
    • sse
    • streamable-http
  • Kolom type menentukan tipe koneksi ke server MCP.
  • Jika type dihilangkan, nilainya akan ditentukan secara default berdasarkan keberadaan dan format url atau command:
    • Jika url ditentukan dan diawali dengan http atau https, type akan menggunakan sse secara default.
    • Jika url ditentukan dan diawali dengan ws atau wss, maka type secara default akan menjadi websocket.
    • Jika command ditentukan, type secara default akan menjadi stdio.
  • Opsi konfigurasi tambahan meliputi:
    • timeout: Batas waktu dalam milidetik untuk permintaan server MCP. Menentukan berapa lama waktu tunggu untuk respons permintaan alat.
    • initTimeout: Timeout dalam milidetik untuk inisialisasi server MCP. Menentukan berapa lama waktu tunggu untuk inisialisasi server.
    • serverInstructions: Mengontrol apakah instruksi server disertakan dalam konteks agen. Dapat berupa true (menggunakan yang disediakan server), false (dinonaktifkan), atau string kustom (menggantikan yang disediakan server).
    • customUserVars: (Opsional) Mendefinisikan variabel kustom (misalnya, kunci API, URL) yang dapat diatur oleh masing-masing pengguna untuk server MCP. Nilai per-pengguna ini, yang disediakan melalui UI, kemudian dapat direferensikan dalam konfigurasi headers atau env server menggunakan sintaks {{VARIABLE_NAME}}. Hal ini memungkinkan autentikasi atau kustomisasi per-pengguna untuk alat MCP.
  • lihat: Struktur Objek MCP Servers

Contoh:

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

lihat: Struktur Objek MCP Servers

speech

Kunci:

Subkey:

lihat: Struktur Objek Speech

turnstile

Kunci:

Subkey:

lihat: Struktur Objek Turnstile

transactions

Kunci:

Subkey:

lihat: Struktur Objek Transaksi

Tautan tambahan

• Struktur Objek Summarization
• Struktur Objek AWS Bedrock
• Struktur Objek Endpoint Kustom
• Struktur Objek Endpoint Azure OpenAI
• Struktur Objek Endpoint Assistants
• Agen
• Struktur Objek Konfigurasi OCR
• Struktur Objek Speech
• Struktur Objek Turnstile
• Struktur Objek Transactions
• Struktur Objek Saldo
• Struktur Objek Pencarian Web
• Struktur Objek Memory