Cấu hình tùy chỉnh

librechat.yaml là gì?

Tệp librechat.yaml là tệp cấu hình chính của LibreChat dành cho các endpoint AI tùy chỉnh, cài đặt mô hình, tùy chọn giao diện và các tính năng nâng cao như máy chủ MCP và các tác nhân (agents). Tệp này là tùy chọn -- LibreChat vẫn hoạt động với các thiết lập mặc định hợp lý nếu tệp không tồn tại.

Thực hiện theo các bước dưới đây để tạo tệp, gắn nó cho loại triển khai của bạn và xác minh rằng nó hoạt động.

Thiết lập

touch librechat.yaml

cp librechat.example.yaml librechat.yaml

CONFIG_PATH="/alternative/path/to/librechat.yaml"

cp docker-compose.override.yml.example docker-compose.override.yml

services:
  api:
    volumes:
      - type: bind
        source: ./librechat.yaml
        target: /app/librechat.yaml

docker compose down && docker compose up -d

npm run backend

docker compose logs api

Ví dụ: Thêm OpenRouter

Ví dụ này hướng dẫn cách thêm OpenRouter làm một endpoint tùy chỉnh -- một trong những cấu hình phổ biến nhất.

1. Lấy API key từ openrouter.ai/keys.

2. Thêm khóa vào tệp .env của bạn:

OPENROUTER_KEY=sk-or-v1-your-key-here

3. Thêm endpoint vào librechat.yaml:

version: 1.3.5
cache: true
endpoints:
  custom:
    - name: "OpenRouter"
      apiKey: "${OPENROUTER_KEY}"
      baseURL: "https://openrouter.ai/api/v1"
      models:
        default: ["meta-llama/llama-3-70b-instruct"]
        fetch: true
      titleConvo: true
      titleModel: "meta-llama/llama-3-70b-instruct"
      dropParams: ["stop"]
      modelDisplayLabel: "OpenRouter"

4. Khởi động lại LibreChat (xem các lệnh khởi động lại ở trên) và chọn OpenRouter từ trình chọn model.

Để xem tệp cấu hình có chú thích đầy đủ với nhiều ví dụ về endpoint hơn, hãy xem cấu hình mẫu.

Tham chiếu

Để biết tài liệu chi tiết ở cấp độ trường, hãy xem các trang tham khảo bên dưới.

Khắc phục sự cố

Thay đổi không hiển thị trong LibreChat

Nếu bạn đã chỉnh sửa librechat.yaml mà không có thay đổi nào trong giao diện người dùng (UI):

1. Xác nhận tệp nằm trong thư mục gốc của dự án LibreChat trừ khi bạn đã thiết lập CONFIG_PATH.
2. Đối với Docker, hãy xác nhận tệp đã được gắn trong docker-compose.override.yml.
3. Khởi động lại LibreChat bằng lệnh docker compose down && docker compose up -d.
4. Kiểm tra nhật ký API bằng docker compose logs api.
5. Xác thực tệp bằng YAML Validator.

Các endpoint tùy chỉnh như OpenRouter chỉ xuất hiện sau khi cả ba thành phần sau đây đều chính xác: .env chứa key, librechat.yaml định nghĩa endpoint và Docker có thể đọc được tệp cấu hình đã mount.

Xác thực cấu hình

Máy chủ thoát ngay lập tức khi khởi động

Nếu máy chủ của bạn thoát ngay lập tức sau khi khởi động, đây có thể là lỗi xác thực cấu hình.

Để chẩn đoán:

1. Kiểm tra nhật ký máy chủ: docker compose logs api
2. Xác thực cú pháp YAML của bạn bằng YAML Validator
3. Các lỗi phổ biến: thụt đầu dòng không chính xác, thiếu dấu hai chấm, khóa không xác định, giá trị không hợp lệ

Giải pháp tạm thời (không khuyến nghị cho môi trường production):

CONFIG_BYPASS_VALIDATION=true