Konfigurasi Kustom

Buat, pasang, dan konfigurasikan file librechat.yaml untuk endpoint AI kustom dan pengaturan lanjutan LibreChat

Apa itu librechat.yaml?

File librechat.yaml adalah file konfigurasi utama LibreChat untuk endpoint AI kustom, pengaturan model, opsi antarmuka, dan fitur lanjutan seperti server MCP dan agen. File ini bersifat opsional -- LibreChat tetap berfungsi dengan pengaturan default yang wajar jika file tersebut tidak ada.

Ikuti langkah-langkah di bawah ini untuk membuat file, memasangnya (mount) untuk jenis deployment Anda, dan memverifikasi bahwa file tersebut berfungsi.

Jika Anda hanya mengingat satu hal

Untuk instalasi Docker, menyunting librechat.yaml saja tidak cukup. File tersebut harus ada di root proyek, dipasang (mounted) ke dalam container API, dan LibreChat harus dimulai ulang agar perubahan muncul di UI.

Lebih suka menggunakan UI? Gunakan Admin Panel

Panel Admin LibreChat mengelola konfigurasi yang sama ini dari browser -- termasuk penggantian (override) per-peran dan per-grup yang mulai berlaku saat login tanpa perlu memulai ulang LibreChat. Panel ini disertakan dalam stack Docker Compose resmi. Gunakan librechat.yaml untuk pengaturan berbasis file atau bootstrap, dan gunakan panel admin untuk manajemen berkelanjutan.

Pengaturan

Temukan atau Buat File Tersebut

Buat librechat.yaml baru di root proyek Anda (direktori yang sama dengan file .env Anda):

touch librechat.yaml

Anda juga dapat menyalin contoh konfigurasi sebagai titik awal:

cp librechat.example.yaml librechat.yaml

Jalur File Alternatif

Anda dapat mengatur jalur file kustom menggunakan variabel lingkungan CONFIG_PATH:

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

Mount File Konfigurasi

Docker memerlukan volume mount untuk mengakses file librechat.yaml Anda di dalam container.

Salin file pengganti (override) contoh:

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

Edit docker-compose.override.yml dan pastikan mount volume librechat.yaml tidak dikomentari:

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

Ini menggunakan pola docker-compose.override.yml -- Docker Compose secara otomatis menggabungkannya dengan docker-compose.yml utama, sehingga kustomisasi Anda tetap ada setelah pembaruan.

Letakkan librechat.yaml di direktori root proyek (direktori yang sama dengan file .env Anda). Tidak diperlukan mounting tambahan untuk instalasi lokal.

Restart LibreChat

docker compose down && docker compose up -d

Hentikan proses yang sedang berjalan (Ctrl+C) dan mulai ulang:

npm run backend

Verifikasi Berhasil

Buka LibreChat di browser Anda. Jika konfigurasi Anda menyertakan endpoint kustom, Anda seharusnya melihatnya di menu dropdown pemilih model.

Jika server gagal dimulai, periksa log untuk melihat kesalahan validasi:

docker compose logs api

Contoh: Menambahkan OpenRouter

Contoh ini memandu Anda dalam menambahkan OpenRouter sebagai endpoint kustom -- salah satu konfigurasi yang paling populer.

1. Dapatkan API key dari openrouter.ai/keys.

2. Tambahkan kunci tersebut ke file .env Anda:

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

Nama Variabel Lingkungan

Gunakan OPENROUTER_KEY, bukan OPENROUTER_API_KEY. Menggunakan OPENROUTER_API_KEY juga akan menimpa endpoint OpenAI untuk menggunakan OpenRouter.

3. Tambahkan endpoint ke 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. Restart LibreChat (lihat perintah restart di atas) dan pilih OpenRouter dari pemilih model.

Untuk file konfigurasi beranotasi lengkap dengan contoh endpoint lainnya, lihat contoh konfigurasi.

Referensi

Untuk dokumentasi tingkat bidang yang terperinci, lihat halaman referensi di bawah ini.

Endpoint AI

Penyedia AI yang kompatibel dan contoh konfigurasi endpoint

→

Struktur Objek

Referensi bidang lengkap untuk setiap opsi librechat.yaml

→

Pemecahan Masalah

Perubahan Tidak Muncul di LibreChat

Jika Anda telah mengedit librechat.yaml dan tidak ada perubahan pada UI:

Pastikan file tersebut berada di root proyek LibreChat kecuali Anda mengatur CONFIG_PATH.
Untuk Docker, pastikan file tersebut di-mount di docker-compose.override.yml.
Mulai ulang LibreChat dengan docker compose down && docker compose up -d.
Periksa log API dengan docker compose logs api.
Validasi file tersebut dengan YAML Validator.

Endpoint kustom seperti OpenRouter hanya akan muncul setelah ketiga bagian berikut benar: .env berisi kunci tersebut, librechat.yaml mendefinisikan endpoint tersebut, dan Docker dapat membaca file konfigurasi yang di-mount.

Validasi Konfigurasi

LibreChat akan keluar dengan error (exit code 1) jika librechat.yaml mengandung kesalahan validasi. Perilaku fail-fast ini mendeteksi masalah konfigurasi sejak dini.

Untuk memvalidasi sintaks YAML Anda sebelum memulai ulang, gunakan YAML Validator atau yamlchecker.com.

Server Keluar Segera Saat Startup

Jika server Anda langsung keluar setelah dimulai, kemungkinan besar ini adalah kesalahan validasi konfigurasi.

Untuk mendiagnosis:

Periksa log server: docker compose logs api
Validasi sintaks YAML Anda dengan YAML Validator
Kesalahan umum: indentasi tidak tepat, titik dua hilang, kunci tidak dikenal, nilai tidak valid

Solusi sementara (tidak disarankan untuk produksi):

CONFIG_BYPASS_VALIDATION=true

Peringatan

CONFIG_BYPASS_VALIDATION=true menyebabkan server melewati validasi dan menggunakan konfigurasi default. Selalu perbaiki kesalahan validasi sebagai gantinya.

Konfigurasi Kustom

Endpoint AI

Struktur Objek

Di halaman ini