カスタム設定

librechat.yaml とは何ですか？

librechat.yaml ファイルは、カスタムAI endpoint、モデル設定、インターフェースオプション、およびMCPサーバーやエージェントといった高度な機能のためのLibreChatのメイン設定ファイルです。これはオプションであり、ファイルが存在しない場合でもLibreChatは適切なデフォルト設定で動作します。

以下の手順に従ってファイルを作成し、デプロイタイプに合わせてマウントし、動作を確認してください。

セットアップ

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

例: OpenRouterの追加

この例では、最も人気のある設定の一つである OpenRouter をカスタム endpoint として追加する手順を説明します。

1. APIキーを取得する: openrouter.ai/keys から取得してください。

2. .env ファイルにキーを追加します:

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

3. librechat.yaml に endpoint を追加します:

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 を再起動（上記の再起動コマンドを参照）し、モデルセレクターから OpenRouter を選択します。

より多くのendpointの例を含む完全な注釈付き設定ファイルについては、example configuration を参照してください。

リファレンス

フィールドレベルの詳細なドキュメントについては、以下のリファレンスページを参照してください。

トラブルシューティング

LibreChatに変更が反映されない場合

librechat.yaml を編集したにもかかわらず、UI に変更が反映されない場合：

1. CONFIG_PATH を設定していない限り、ファイルが LibreChat プロジェクトのルートにあることを確認してください。
2. Dockerの場合、ファイルが docker-compose.override.yml にマウントされていることを確認してください。
3. docker compose down && docker compose up -d を実行して LibreChat を再起動します。
4. docker compose logs api で API ログを確認してください。
5. YAML Validator を使用してファイルを検証してください。

OpenRouter などのカスタム endpoint は、.env にキーが含まれていること、librechat.yaml で endpoint が定義されていること、そして Docker がマウントされた設定ファイルを読み込めること、という3つの要素がすべて正しく揃った後にのみ表示されます。

設定の検証

起動時にサーバーが即座に終了する

サーバーが起動直後に終了してしまう場合、それは設定の検証エラーである可能性が高いです。

診断するには:

1. サーバーログを確認する: docker compose logs api
2. YAML Validator を使用して、YAML構文を検証してください。
3. 一般的なエラー：インデントの誤り、コロンの欠落、不明なキー、無効な値

一時的な回避策 (本番環境では推奨されません):

CONFIG_BYPASS_VALIDATION=true