設定構造

注: 必須として明記されていないフィールドは任意です。

version

• 必須

cache

skillSync

参照: Skill Sync Object Structure

messageFilter

参照: Message Filter Object Structure

fileStrategy

• Options: "local" | "firebase" | "s3" | "azure_blob" | "cloudfront"

• 注記:
  • "cloudfront" はファイルをS3に保存し、安定したメディア配信、署名付きCookie、および署名付きダウンロードのためにCloudFront URLを返します。
  • "firebase" は、Firebase Storage および Firebase Hosting のエッジロケーションを通じてファイルを配信します。
  • S3は、有効期限のあるpresigned URLs（一時的な署名付きトークン）を介してファイルを配信します。有効期限が切れると、そのURLを参照している画像やアバターはUI上で表示されなくなります。このため、S3はビジュアルアセットの主要な保存先としては適していません。詳細については、関連するディスカッションを参照してください。
  • 画像やアバターのパフォーマンスを最適化するには、"cloudfront" または "firebase" を使用するか、fileStrategies を設定して avatar および image をCDNベースの戦略にルーティングしてください。
  • セットアップの詳細については、File Storage & CDN documentation を参照してください。

fileStrategies

ファイルタイプごとにファイルストレージ戦略をきめ細かく制御できます。

• 利用可能な戦略: "local" | "firebase" | "s3" | "azure_blob" | "cloudfront"

サブキー:

• 注記:
  • この設定は、単一の fileStrategy オプションよりも優先されます。
  • 特定のファイルタイプが設定されていない場合、default、次に fileStrategy、最後に "local" へとフォールバックされます。
  • 画像やアバターがUI全体で正しくレンダリングされるためには、永続的で安定したURLが必要です。S3の署名付きURLは期限切れになるため（AWSの制限：IAMユーザーの場合は最大7日間、STS/ロールベースの認証情報の場合は数時間）、モデルセレクターやチャットUIで画像が表示されなくなる問題が発生します。詳細については、関連するディスカッションを参照してください。これを回避するには、avatarおよびimageの設定に "cloudfront" または "firebase" を使用してください。
  • S3 および Azure Blob Storage は、短期間有効な署名付きダウンロード URL が適している document ストレージに最適です。
  • 各ストレージプロバイダーの設定詳細については、File Storage & CDN documentation を参照してください。

例:

# Use a single strategy for all file types
fileStrategies:
  default: 's3'

# Route images and avatars to CDN, keep documents in object storage
fileStrategies:
  avatar: 'cloudfront' # CDN delivery for avatars
  image: 'cloudfront' # CDN delivery for generated/uploaded images
  document: 's3' # Object storage for documents

# Only configure specific types, others use default
fileStrategies:
  default: 'local'
  avatar: 'firebase' # Only avatars use Firebase CDN, everything else is local

cloudfront

キー:

サブキー:

参照: CloudFront Object Structure および CloudFront with S3

filteredTools

• 注記:
  • includedTools と filteredTools の両方が指定されている場合、includedTools のみが認識されます。
  • gptPlugins および assistants endpoint の両方に影響します
  • フィルタリング対象のツール名は、api/app/clients/tools/manifest.json で確認できます。
    • pluginKey 値を使用してください
  • また、api/app/clients/tools/.well-known ディレクトリ配下にリストされているものも同様です。
    • name_for_model の値を使用してください

includedTools

• 注記:
  • includedTools と filteredTools の両方が指定されている場合、includedTools のみが認識されます。
  • gptPlugins および assistants endpoint の両方に影響します
  • フィルタリング対象のツール名は、api/app/clients/tools/manifest.json で確認できます。
    • pluginKey 値を使用してください
  • また、api/app/clients/tools/.well-known ディレクトリ配下にリストされているものも同様です。
    • name_for_model の値を使用してください

secureImageLinks

imageOutputType

• 注意: 大文字と小文字は区別されます。Google endpointは、"jpeg" および "png" の出力タイプのみをサポートしています。
• オプション: "png" | "webp" | "jpeg"

ocr

キー:

サブキー:

参照: OCR Config Object Structure

webSearch

キー:

サブキー:

参照: Web Search Object Structure

fileConfig

キー:

サブキー:

clientImageResize

キー:

サブキー:

説明:

clientImageResize 設定は、アップロード前にクライアント側で画像を自動的にリサイズすることを可能にします。この機能は以下に役立ちます：

• アップロードの失敗を防ぐ（サーバーの制限を超える大きな画像ファイルが原因の場合）
• 帯域幅の使用量を削減するために、送信前に画像を圧縮します
• アップロードパフォーマンスを向上させる（ファイルサイズを小さくする）
• ファイルサイズを最適化しつつ、画質を維持する

有効にすると、指定された maxWidth または maxHeight の寸法を超える画像は、サーバーにアップロードされる前にクライアント側で自動的にリサイズされます。リサイズは元の縦横比を維持しながら、画像が指定された境界内に収まるように行われます。

例:

fileConfig:
  clientImageResize:
    enabled: true
    maxWidth: 1920
    maxHeight: 1080
    quality: 0.8
    compressFormat: 'jpeg'

注記:

• 画像ファイル（JPEG、PNG、WebPなど）にのみ適用されます。
• 画像が指定された寸法を超えると、自動的にリサイズが行われます。
• リサイズ中も元の縦横比が維持されます
• この機能は、サポートされているすべての画像アップロード endpoint で動作します。
• Quality設定は、JPEGおよびWebP形式にのみ適用されます。
• 品質を低く設定しすぎると（< 0.5）、目に見える画質の低下が生じる可能性があります。

参照: File Config Object Structure

rateLimits

キー:

サブキー:

fileUploads サブキー:

conversationsImport サブキー:

tts サブキー:

stt サブキー:

• 例:

rateLimits:
  fileUploads:
    ipMax: 100
    ipWindowInMinutes: 60
    userMax: 50
    userWindowInMinutes: 60
  conversationsImport:
    ipMax: 100
    ipWindowInMinutes: 60
    userMax: 50
    userWindowInMinutes: 60
  stt:
    ipMax: 100
    ipWindowInMinutes: 1
    userMax: 50
    userWindowInMinutes: 1
  tts:
    ipMax: 100
    ipWindowInMinutes: 1
    userMax: 50
    userWindowInMinutes: 1

registration

キー:

サブキー:

参照:

• socialLogins,
• alloweddomains,
• 登録オブジェクト構造

memory

キー:

サブキー:

参照: Memory Object Structure

summarization

キー:

サブキー:

参照: Summarization Object Structure

actions

キー:

サブキー:

参照:

• allowedDomains,
• allowedAddresses,
• Actions オブジェクト構造

interface

キー:

サブキー:

参照: Interface Object Structure

modelSpecs

キー:

サブキー:

参照: Model Specs Object Structure

endpoints

キー:

サブキー:

注: エンドポイントは、streamRate、headers、titleModel、titleMethod、titlePrompt、titlePromptTemplate、titleEndpoint、maxToolResultChars といった Shared Endpoint Settings をサポートしています。これらは、各エンドポイントごとに個別に設定することも、all キーを使用してグローバルに設定することも可能です。headers はマージされ、キーが重複した場合はエンドポイントレベルの値が優先されます。all キーは baseURL を受け付けません。

注: endpoints.allowedAddresses は、ユーザーが指定する baseURL 値に適用されます（管理者が apiKey: 'user_provided' および baseURL: 'user_provided' を設定してカスタム endpoint を構成した場合）。ユーザーが指定した各 baseURL は、リクエスト時に SSRF ブロックに対して検証されますが、ここにリストされているエントリは除外されます。フィールドのセマンティクスについては mcpSettings.allowedAddresses を参照してください。同じルールが適用されます（プライベート IP 空間のみ、ポート番号必須、URL/パス/CIDR/ベアホスト/パブリック IP リテラルは不可）。

mcpSettings

キー:

サブキー:

• 注記:
  • これは、MCPサーバーを介した内部アドレスの悪用や不正利用を防ぐためのセキュリティ機能です。
  • デフォルトでは、LibreChatはMCPサーバーが内部、ローカル、またはプライベートネットワークアドレスに接続することを制限しています。
  • ローカルIPアドレスやドメインを使用するMCPサーバーは、厳格な allowedDomains ホワイトリストに追加する（その場合、そのリストのみが到達可能になります）か、あるいはパブリックな宛先への到達を維持するために、allowedAddresses を介して正確な host:port サービスとして除外設定することができます。
  • すべての yaml 設定変更と同様に、変更を反映させるには LibreChat の再起動が必要です。
  • ドメイン、ワイルドカードサブドメイン（*.example.com）、Dockerドメイン、およびIPアドレスをサポートしています。

例:

mcpSettings:
  # Strict whitelist mode:
  # allowedDomains:
  #   - "example.com"           # Specific domain
  #   - "*.example.com"         # All subdomains
  #   - "http://mcp-server:3000" # Internal service, explicitly whitelisted

  # Default SSRF mode with private service exemptions:
  allowedAddresses:
    - 'host.docker.internal:8080' # Permit one private host on one port
    - '10.0.0.5:8000' # Permit one private IP on one port

参照: MCP Settings Object Structure

mcpServers

キー:

サブキー:

• 注記:
  • 初期化は起動時に行われるため、変更を反映させるにはアプリを再起動する必要があります。
  • <serverName> は、各 MCP サーバー設定の一意の識別子です。
  • 各MCPサーバーは、4つの接続タイプのいずれかを使用して設定できます：
    • stdio
    • websocket
    • sse
    • streamable-http
  • type フィールドは、MCP サーバーへの接続タイプを指定します。
  • type が省略された場合、url または command の有無と形式に基づいてデフォルト値が設定されます。
    • url が指定されており、かつ http または https で始まる場合、type はデフォルトで sse になります。
    • url が指定されており、かつ ws または wss で始まる場合、type はデフォルトで websocket になります。
    • command が指定されている場合、type はデフォルトで stdio になります。
  • その他の設定オプションには以下が含まれます：
    • timeout: MCPサーバーリクエストのタイムアウト時間（ミリ秒）。ツールリクエストに対する応答を待機する時間を決定します。
    • initTimeout: MCPサーバーの初期化に対するミリ秒単位のタイムアウト。サーバーの初期化を待機する時間を決定します。
    • serverInstructions: エージェントのコンテキストにサーバーの指示を含めるかどうかを制御します。true（サーバー提供のものを使用）、false（無効）、またはカスタム文字列（サーバー提供のものを上書き）を指定できます。
    • customUserVars: (オプション) 個々のユーザーがMCPサーバーに対して設定できるカスタム変数（APIキーやURLなど）を定義します。UIを通じて提供されるこれらのユーザーごとの値は、サーバーの headers または env 設定内で {{VARIABLE_NAME}} 構文を使用して参照できます。これにより、MCPツールに対してユーザーごとの認証やカスタマイズが可能になります。
  • 参照: MCP Servers Object Structure

例:

mcpServers:
  everything:
    # type: sse # type can optionally be omitted
    url: http://localhost:3001/sse
    timeout: 30000
    initTimeout: 10000
    serverInstructions: true # Use server-provided instructions
  puppeteer:
    type: stdio
    command: npx
    args:
      - -y
      - '@modelcontextprotocol/server-puppeteer'
    timeout: 30000
    initTimeout: 10000
    serverInstructions: 'Do not access any local files or local/internal IP addresses'
  filesystem:
    # type: stdio
    command: npx
    args:
      - -y
      - '@modelcontextprotocol/server-filesystem'
      - /home/user/LibreChat/
    iconPath: /home/user/LibreChat/client/public/assets/logo.svg
  mcp-obsidian:
    command: npx
    args:
      - -y
      - 'mcp-obsidian'
      - /path/to/obsidian/vault
  streamable-http-example:
    type: streamable-http
    url: https://example.com/mcp
    headers:
      Authorization: 'Bearer ${API_TOKEN}'
    timeout: 30000
  per-user-crendentials-example:
    type: sse
    url: 'https//some.mcp/sse'
    headers:
      X-Custom-Auth-Token: '{{USER_API_KEY}}' # Placeholder for the user-provided API key, defined in `customUserVars` below.
    customUserVars:
      USER_API_KEY:
        title: 'Service API Key'
        description: "Your personal API key for this service. You can get it <a href='https://example.com/api-keys' target='_blank'>here</a>."
    serverInstructions: true

参照: MCP Servers Object Structure

speech

キー:

サブキー:

参照: Speech Object Structure

turnstile

キー:

サブキー:

参照: Turnstile Object Structure

transactions

キー:

サブキー:

参照: Transactions Object Structure

その他のリンク

• 要約オブジェクト構造
• AWS Bedrock オブジェクト構造
• カスタムエンドポイントオブジェクト構造
• Azure OpenAI エンドポイントオブジェクト構造
• Assistants エンドポイントオブジェクト構造
• エージェント
• OCR設定オブジェクト構造
• 音声オブジェクト構造
• Turnstile オブジェクト構造
• Transactions オブジェクト構造
• Balance オブジェクト構造
• Web Search オブジェクト構造
• メモリ・オブジェクト構造