Cấu trúc cấu hình

Lưu ý: Các trường không được đề cập cụ thể là bắt buộc thì đều là tùy chọn.

version

• bắt buộc

cache

skillSync

xem: Cấu trúc đối tượng Skill Sync

messageFilter

xem: Cấu trúc đối tượng bộ lọc tin nhắn

fileStrategy

• Các tùy chọn: "local" | "firebase" | "s3" | "azure_blob" | "cloudfront"

• Ghi chú:
  • "cloudfront" lưu trữ các tệp trong S3 và trả về các URL CloudFront để phân phối phương tiện ổn định, cookie đã ký và tải xuống đã ký.
  • "firebase" phục vụ các tệp tin thông qua Firebase Storage và các vị trí biên (edge locations) của Firebase Hosting.
  • S3 phục vụ các tệp tin thông qua presigned URLs (các token được ký tạm thời) có thời hạn sử dụng. Sau khi hết hạn, bất kỳ hình ảnh hoặc ảnh đại diện nào tham chiếu đến URL đó sẽ hiển thị lỗi trong giao diện người dùng. Điều này khiến S3 không phù hợp làm chiến lược chính cho các tài nguyên hình ảnh. Xem thảo luận liên quan để biết thêm chi tiết.
  • Để có hiệu suất tốt nhất cho hình ảnh và ảnh đại diện, hãy sử dụng "cloudfront" hoặc "firebase", hoặc cấu hình fileStrategies để định tuyến avatar và image đến một chiến lược hỗ trợ CDN.
  • Vui lòng tham khảo tài liệu về File Storage & CDN để biết chi tiết về cách thiết lập

fileStrategies

Cho phép kiểm soát chi tiết các chiến lược lưu trữ tệp cho các loại tệp khác nhau.

• Các chiến lược khả dụng: "local" | "firebase" | "s3" | "azure_blob" | "cloudfront"

Các khóa phụ:

• Ghi chú:
  • Cài đặt này được ưu tiên hơn tùy chọn fileStrategy đơn lẻ
  • Nếu một loại tệp cụ thể không được cấu hình, nó sẽ quay lại default, sau đó đến fileStrategy, và cuối cùng là "local"
  • Hình ảnh và ảnh đại diện cần các URL ổn định, lâu dài để hiển thị chính xác trên giao diện người dùng. Các URL được ký trước (presigned URLs) của S3 sẽ hết hạn (giới hạn của AWS: 7 ngày đối với người dùng IAM, vài giờ đối với thông tin xác thực dựa trên vai trò/STS), dẫn đến lỗi hiển thị hình ảnh trong bộ chọn model và giao diện trò chuyện. Xem thảo luận liên quan để biết ngữ cảnh đầy đủ. Hãy sử dụng "cloudfront" hoặc "firebase" cho avatar và image để tránh vấn đề này.
  • S3 và Azure Blob Storage rất phù hợp cho việc lưu trữ document, nơi mà các URL tải xuống được ký trước (presigned download URLs) có thời hạn ngắn là lựa chọn thích hợp.
  • Vui lòng tham khảo tài liệu File Storage & CDN để biết chi tiết thiết lập cho từng nhà cung cấp lưu trữ.

Các ví dụ:

# 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

Khóa:

Các khóa con:

xem: Cấu trúc đối tượng CloudFront và CloudFront với S3

filteredTools

• Ghi chú:
  • Nếu cả includedTools và filteredTools đều được chỉ định, chỉ includedTools mới được nhận diện.
  • Ảnh hưởng đến cả hai endpoint gptPlugins và assistants
  • Bạn có thể tìm thấy tên của các công cụ để lọc trong api/app/clients/tools/manifest.json
    • Sử dụng giá trị pluginKey
  • Ngoài ra, bất kỳ mục nào được liệt kê trong thư mục ".well-known" api/app/clients/tools/.well-known
    • Sử dụng giá trị name_for_model

includedTools

• Ghi chú:
  • Nếu cả includedTools và filteredTools đều được chỉ định, chỉ includedTools mới được nhận diện.
  • Ảnh hưởng đến cả hai endpoint gptPlugins và assistants
  • Bạn có thể tìm thấy tên của các công cụ để lọc trong api/app/clients/tools/manifest.json
    • Sử dụng giá trị pluginKey
  • Ngoài ra, bất kỳ mục nào được liệt kê trong thư mục ".well-known" api/app/clients/tools/.well-known
    • Sử dụng giá trị name_for_model

secureImageLinks

imageOutputType

• Lưu ý: Phân biệt chữ hoa chữ thường. Endpoint Google chỉ hỗ trợ các loại đầu ra "jpeg" và "png".
• Các tùy chọn: "png" | "webp" | "jpeg"

ocr

Khóa:

Các khóa con:

xem: Cấu trúc Đối tượng Cấu hình OCR

webSearch

Khóa:

Các khóa con:

xem: Cấu trúc đối tượng tìm kiếm web

fileConfig

Khóa:

Các khóa con:

clientImageResize

Khóa:

Các khóa con:

Mô tả:

Cấu hình clientImageResize cho phép tự động thay đổi kích thước hình ảnh ở phía máy khách trước khi tải lên. Tính năng này giúp:

• Ngăn chặn lỗi tải lên do các tệp hình ảnh lớn vượt quá giới hạn của máy chủ
• Giảm mức sử dụng băng thông bằng cách nén hình ảnh trước khi truyền tải
• Cải thiện hiệu suất tải lên với kích thước tệp nhỏ hơn
• Duy trì chất lượng hình ảnh trong khi tối ưu hóa kích thước tệp

Khi được bật, các hình ảnh vượt quá kích thước maxWidth hoặc maxHeight được chỉ định sẽ tự động thay đổi kích thước ở phía máy khách (client side) trước khi được tải lên máy chủ. Việc thay đổi kích thước này duy trì tỷ lệ khung hình gốc trong khi đảm bảo hình ảnh khớp với các giới hạn đã chỉ định.

Ví dụ:

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

Ghi chú:

• Chỉ áp dụng cho các tệp hình ảnh (JPEG, PNG, WebP, v.v.)
• Việc thay đổi kích thước sẽ tự động diễn ra khi hình ảnh vượt quá các kích thước đã chỉ định
• Tỷ lệ khung hình gốc được giữ nguyên trong quá trình thay đổi kích thước
• Tính năng này hoạt động với tất cả các endpoint tải lên hình ảnh được hỗ trợ
• Cài đặt chất lượng chỉ áp dụng cho các định dạng JPEG và WebP
• Đặt chất lượng quá thấp (< 0.5) có thể dẫn đến hiện tượng suy giảm chất lượng hình ảnh đáng kể

xem: Cấu trúc đối tượng cấu hình tệp

rateLimits

Khóa:

Các khóa con:

Các subkey của fileUploads:

conversationsImport Subkeys:

Các khóa con tts:

Các khóa con stt:

• Ví dụ:

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

Khóa:

Các khóa con:

xem thêm:

• socialLogins,
• alloweddomains,
• Cấu trúc đối tượng đăng ký

memory

Khóa:

Các khóa con:

xem: Cấu trúc đối tượng Memory

summarization

Khóa:

Các khóa con:

xem: Cấu trúc đối tượng tóm tắt

actions

Khóa:

Các khóa con:

xem thêm:

• allowedDomains,
• allowedAddresses,
• Cấu trúc đối tượng Actions

interface

Khóa:

Các khóa con:

xem: Cấu trúc đối tượng giao diện

modelSpecs

Khóa:

Các khóa con:

xem: Cấu trúc đối tượng Model Specs

endpoints

Khóa:

Các khóa con:

Lưu ý: Các endpoint hỗ trợ Shared Endpoint Settings như streamRate, headers, titleModel, titleMethod, titlePrompt, titlePromptTemplate, titleEndpoint và maxToolResultChars. Các cài đặt này có thể được cấu hình riêng lẻ cho từng endpoint hoặc cấu hình chung bằng cách sử dụng khóa all. headers sẽ được hợp nhất, trong đó các giá trị ở cấp độ endpoint sẽ được ưu tiên nếu xảy ra xung đột khóa. Khóa all không chấp nhận baseURL.

Lưu ý: endpoints.allowedAddresses áp dụng cho các giá trị baseURL do người dùng cung cấp (khi quản trị viên cấu hình một endpoint tùy chỉnh với apiKey: 'user_provided' và baseURL: 'user_provided'). Mỗi baseURL do người dùng cung cấp sẽ được xác thực dựa trên khối SSRF tại thời điểm yêu cầu; các mục được liệt kê ở đây sẽ được miễn trừ. Xem mcpSettings.allowedAddresses để biết ngữ nghĩa của trường — các quy tắc tương tự được áp dụng (chỉ áp dụng cho không gian IP riêng, bắt buộc có cổng, không chấp nhận URL/đường dẫn/CIDR/máy chủ trần/IP công cộng cụ thể).

mcpSettings

Khóa:

Các khóa con:

• Ghi chú:
  • Đây là một tính năng bảo mật nhằm bảo vệ khỏi việc lạm dụng / sử dụng sai mục đích các địa chỉ nội bộ thông qua các máy chủ MCP
  • Theo mặc định, LibreChat hạn chế các máy chủ MCP kết nối với các địa chỉ mạng nội bộ, cục bộ hoặc riêng tư.
  • Các MCP server sử dụng địa chỉ IP hoặc tên miền cục bộ có thể được thêm vào danh sách trắng allowedDomains nghiêm ngặt (khi đó danh sách này sẽ trở thành tập hợp duy nhất có thể truy cập được), hoặc — để giữ cho các đích đến công khai có thể truy cập được — được miễn trừ dưới dạng các dịch vụ host:port chính xác thông qua allowedAddresses
  • Như với tất cả các thay đổi cấu hình yaml, cần phải khởi động lại LibreChat để các thay đổi có hiệu lực.
  • Hỗ trợ các tên miền, tên miền phụ đại diện (*.example.com), tên miền Docker và địa chỉ IP

Ví dụ:

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

xem: Cấu trúc đối tượng cài đặt MCP

mcpServers

Khóa:

Các khóa con:

• Ghi chú:
  • Quá trình khởi tạo diễn ra khi khởi động và ứng dụng phải được khởi động lại để các thay đổi có hiệu lực.
  • <serverName> là một định danh duy nhất cho mỗi cấu hình MCP server.
  • Mỗi MCP server có thể được cấu hình bằng cách sử dụng một trong bốn loại kết nối:
    • stdio
    • websocket
    • sse
    • streamable-http
  • Trường type chỉ định loại kết nối tới máy chủ MCP.
  • Nếu type bị bỏ qua, nó sẽ mặc định dựa trên sự hiện diện và định dạng của url hoặc command:
    • Nếu url được chỉ định và bắt đầu bằng http hoặc https, type sẽ mặc định là sse.
    • Nếu url được chỉ định và bắt đầu bằng ws hoặc wss, type sẽ mặc định là websocket.
    • Nếu command được chỉ định, type sẽ mặc định là stdio.
  • Các tùy chọn cấu hình bổ sung bao gồm:
    • timeout: Thời gian chờ tính bằng mili giây cho các yêu cầu máy chủ MCP. Xác định thời gian chờ phản hồi cho các yêu cầu công cụ.
    • initTimeout: Thời gian chờ tính bằng mili giây để khởi tạo máy chủ MCP. Xác định khoảng thời gian chờ đợi để máy chủ khởi tạo.
    • serverInstructions: Kiểm soát việc liệu các hướng dẫn từ máy chủ có được bao gồm trong ngữ cảnh của tác nhân (agent) hay không. Có thể là true (sử dụng hướng dẫn do máy chủ cung cấp), false (đã tắt), hoặc một chuỗi tùy chỉnh (ghi đè lên hướng dẫn do máy chủ cung cấp).
    • customUserVars: (Tùy chọn) Xác định các biến tùy chỉnh (ví dụ: khóa API, URL) mà từng người dùng có thể thiết lập cho một máy chủ MCP. Các giá trị theo từng người dùng này, được cung cấp thông qua giao diện người dùng, sau đó có thể được tham chiếu trong cấu hình headers hoặc env của máy chủ bằng cú pháp {{VARIABLE_NAME}}. Điều này cho phép xác thực hoặc tùy chỉnh theo từng người dùng cho các công cụ MCP.
  • xem: Cấu trúc đối tượng MCP Servers

Ví dụ:

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

xem: Cấu trúc đối tượng MCP Servers

speech

Khóa:

Các khóa con:

xem: Cấu trúc đối tượng Speech

turnstile

Khóa:

Các khóa con:

xem: Cấu trúc đối tượng Turnstile

transactions

Khóa:

Các khóa con:

xem: Cấu trúc đối tượng Transactions

Các liên kết bổ sung

• Cấu trúc đối tượng tóm tắt
• Cấu trúc đối tượng AWS Bedrock
• Cấu trúc đối tượng endpoint tùy chỉnh
• Cấu trúc đối tượng endpoint Azure OpenAI
• Cấu trúc đối tượng Assistants endpoint
• Agents
• Cấu trúc đối tượng cấu hình OCR
• Cấu trúc đối tượng Speech
• Cấu trúc đối tượng Turnstile
• Cấu trúc đối tượng Transactions
• Cấu trúc đối tượng Balance
• Cấu trúc đối tượng Tìm kiếm Web
• Cấu trúc đối tượng Memory