Skip to main content
LibreChat is joining ClickHouse to power the open-source Agentic Data Stack 🎉 Learn more
LibreChat

Özel Yapılandırma

Özel AI endpoint'leri ve gelişmiş LibreChat ayarları için librechat.yaml dosyasını oluşturun, bağlayın ve yapılandırın

librechat.yaml nedir?

librechat.yaml dosyası, özel AI endpoint'leri, model ayarları, arayüz seçenekleri ve MCP sunucuları ile ajanlar gibi gelişmiş özellikler için LibreChat'in ana yapılandırma dosyasıdır. İsteğe bağlıdır; dosya mevcut değilse LibreChat mantıklı varsayılan ayarlarla çalışır.

Dosyayı oluşturmak, dağıtım türünüz için bağlamak ve çalıştığını doğrulamak için aşağıdaki adımları izleyin.

Sadece tek bir şeyi hatırlayacaksanız

Docker kurulumları için librechat.yaml dosyasını düzenlemek yeterli değildir. Dosyanın proje kök dizininde bulunması, API konteynerine bağlanması (mount edilmesi) ve değişikliklerin arayüzde görünmesi için LibreChat'in yeniden başlatılması gerekir.

Arayüz mü tercih edersiniz? Yönetim Panelini kullanın

LibreChat Yönetim Paneli, aynı yapılandırmayı bir tarayıcı üzerinden yönetir; buna, LibreChat'i yeniden başlatmaya gerek kalmadan giriş sırasında devreye giren rol bazlı ve grup bazlı geçersiz kılmalar da dahildir. Resmi Docker Compose yığınları ile birlikte gelir. Dosya tabanlı veya başlangıç kurulumu için librechat.yaml dosyasını, devam eden yönetim işlemleri için ise yönetim panelini kullanın.

Kurulum

Dosyayı Bulun veya Oluşturun

Proje kök dizininizde (.env dosyanızla aynı dizinde) yeni bir librechat.yaml oluşturun:

touch librechat.yaml

Ayrıca başlangıç noktası olarak örnek yapılandırmayı kopyalayabilirsiniz:

cp librechat.example.yaml librechat.yaml

Alternatif Dosya Yolu

CONFIG_PATH ortam değişkenini kullanarak özel bir dosya yolu belirleyebilirsiniz:

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

Yapılandırma Dosyasını Bağlayın (Mount)

Docker'ın konteyner içindeki librechat.yaml dosyanıza erişebilmesi için bir volume mount işlemine ihtiyacı vardır.

Örnek geçersiz kılma (override) dosyasını kopyalayın:

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

docker-compose.override.yml dosyasını düzenleyin ve librechat.yaml birim (volume) bağlamasının yorum satırı olmadığından emin olun:

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

Bu, docker-compose.override.yml modelini kullanır -- Docker Compose bunu otomatik olarak ana docker-compose.yml ile birleştirir, böylece özelleştirmeleriniz güncellemelerden sonra da korunur.

librechat.yaml dosyasını proje kök dizinine (.env dosyanızla aynı dizine) yerleştirin. Yerel kurulumlar için ek bir bağlama (mounting) işlemine gerek yoktur.

LibreChat'i Yeniden Başlatın

docker compose down && docker compose up -d

Çalışan işlemi durdurun (Ctrl+C) ve yeniden başlatın:

npm run backend

Çalıştığını Doğrulayın

LibreChat'i tarayıcınızda açın. Yapılandırmanız özel endpoint'ler içeriyorsa, bunları model seçici açılır menüsünde görmelisiniz.

Sunucu başlatılamazsa, doğrulama hataları için günlükleri kontrol edin:

docker compose logs api

Örnek: OpenRouter Ekleme

Bu örnek, en popüler yapılandırmalardan biri olan OpenRouter hizmetini özel bir endpoint olarak ekleme sürecini adım adım açıklamaktadır.

1. Bir API anahtarı alın openrouter.ai/keys adresinden.

2. Anahtarı .env dosyanıza ekleyin:

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

Ortam Değişkeni Adı

OPENROUTER_API_KEY yerine OPENROUTER_KEY kullanın. OPENROUTER_API_KEY kullanmak, OpenAI endpoint'ini de OpenRouter kullanacak şekilde geçersiz kılacaktır.

3. librechat.yaml dosyasına endpoint'i ekleyin:

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. LibreChat'i yeniden başlatın (yukarıdaki yeniden başlatma komutlarına bakın) ve model seçiciden OpenRouter'ı seçin.

Daha fazla endpoint örneği içeren tam açıklamalı yapılandırma dosyası için örnek yapılandırmaya bakın.

Referans

Alan düzeyinde ayrıntılı dokümantasyon için aşağıdaki referans sayfalarına bakın.

Sorun Giderme

Değişiklik LibreChat'te Görünmüyor

librechat.yaml dosyasını düzenlediyseniz ve arayüzde (UI) hiçbir değişiklik olmadıysa:

  1. CONFIG_PATH değişkenini ayarlamadığınız sürece dosyanın LibreChat proje kök dizininde olduğundan emin olun.
  2. Docker için, dosyanın docker-compose.override.yml içinde bağlandığını doğrulayın.
  3. docker compose down && docker compose up -d komutuyla LibreChat'i yeniden başlatın.
  4. docker compose logs api komutu ile API günlüklerini kontrol edin.
  5. Dosyayı YAML Validator ile doğrulayın.

OpenRouter gibi özel endpoint'ler, yalnızca şu üç parçanın tamamı doğru olduğunda görünür: .env dosyası anahtarı içeriyorsa, librechat.yaml dosyası endpoint'i tanımlıyorsa ve Docker bağlanan yapılandırma dosyasını okuyabiliyorsa.

Yapılandırma Doğrulama

Yapılandırma Doğrulama

LibreChat, librechat.yaml dosyasında doğrulama hataları bulunması durumunda bir hata ile (çıkış kodu 1) kapanır. Bu hızlı hata (fail-fast) davranışı, yapılandırma sorunlarını erkenden yakalar.

Yeniden başlatmadan önce YAML sözdiziminizi doğrulamak için YAML Validator veya yamlchecker.com kullanın.

Sunucu Başlatma Sırasında Hemen Kapanıyor

Sunucunuz başlatıldıktan hemen sonra kapanıyorsa, bu büyük olasılıkla bir yapılandırma doğrulama hatasıdır.

Tanı koymak için:

  1. Sunucu günlüklerini kontrol edin: docker compose logs api
  2. YAML Validator ile YAML sözdiziminizi doğrulayın
  3. Yaygın hatalar: yanlış girintileme, eksik iki nokta üst üste, bilinmeyen anahtarlar, geçersiz değerler

Geçici çözüm (prodüksiyon ortamı için önerilmez):

CONFIG_BYPASS_VALIDATION=true

Uyarı

CONFIG_BYPASS_VALIDATION=true, sunucunun doğrulamayı atlamasına ve varsayılan yapılandırmayı kullanmasına neden olur. Bunun yerine her zaman doğrulama hatalarını düzeltin.

Bu rehber nasıl?