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

カスタム設定

カスタムAI endpointおよび高度なLibreChat設定のために、librechat.yamlファイルを作成、マウント、設定する

librechat.yaml とは何ですか?

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

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

これだけは覚えておいてください

Dockerインストールの場合は、librechat.yamlを編集するだけでは不十分です。このファイルはプロジェクトのルートディレクトリに存在し、APIコンテナにマウントされている必要があり、変更をUIに反映させるにはLibreChatを再起動する必要があります。

セットアップ

ファイルの場所の特定または作成

プロジェクトのルートディレクトリ(.env ファイルと同じディレクトリ)に、新しい librechat.yaml を作成します:

touch librechat.yaml

また、example config をコピーして開始点として使用することもできます。

cp librechat.example.yaml librechat.yaml

代替ファイルパス

CONFIG_PATH 環境変数を使用して、カスタムファイルパスを設定できます:

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

設定ファイルをマウントする

Dockerがコンテナ内の librechat.yaml ファイルにアクセスするには、ボリュームマウントが必要です。

サンプルオーバーライドファイルをコピーします:

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

docker-compose.override.yml を編集し、librechat.yaml のボリュームマウントがコメントアウトされていないことを確認してください:

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

これは docker-compose.override.yml パターンを使用しています。Docker Compose はこれをメインの docker-compose.yml と自動的にマージするため、カスタマイズ内容はアップデート後も保持されます。

LibreChatを再起動する

docker compose down && docker compose up -d

動作確認

ブラウザで LibreChat を開きます。設定にカスタム endpoint が含まれている場合、モデルセレクターのドロップダウンにそれらが表示されるはずです。

サーバーが起動しない場合は、ログを確認して検証エラーがないか確認してください:

docker compose logs api

例: OpenRouter の追加

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

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

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

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

環境変数名

OPENROUTER_API_KEY ではなく OPENROUTER_KEY を使用してください。OPENROUTER_API_KEY を使用すると、OpenAI エンドポイントも OpenRouter を使用するように上書きされてしまいます。

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つの要素がすべて揃った後にのみ表示されます。

設定の検証

設定の検証

librechat.yaml に検証エラーが含まれている場合、LibreChat はエラー(終了コード 1)で終了します。このフェイルファスト(fail-fast)動作により、設定の問題を早期に発見できます。

再起動する前にYAML構文を検証するには、YAML Validator または yamlchecker.com を使用してください。

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

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

診断するには:

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

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

CONFIG_BYPASS_VALIDATION=true

警告

CONFIG_BYPASS_VALIDATION=true は、サーバーが検証をスキップしてデフォルト設定を使用するようにします。常に検証エラーを修正するようにしてください。

このガイドはいかがでしたか?