自定义配置

创建、挂载并配置 librechat.yaml 文件，以实现自定义 AI endpoint 和高级 LibreChat 设置

什么是 librechat.yaml？

librechat.yaml 文件是 LibreChat 用于自定义 AI endpoint、模型设置、界面选项以及 MCP 服务器和智能体等高级功能的主要配置文件。它是可选的——如果该文件不存在，LibreChat 将使用合理的默认设置运行。

请按照以下步骤创建文件，针对您的部署类型进行挂载，并验证其是否正常工作。

如果你只能记住一件事

对于 Docker 安装，仅编辑 librechat.yaml 是不够的。该文件必须存在于项目根目录中，挂载到 API 容器内，并且必须重启 LibreChat，更改才会显示在 UI 中。

设置

找到或创建文件

在您的项目根目录（与您的 .env 文件相同的目录）中创建一个新的 librechat.yaml：

touch librechat.yaml

您也可以复制示例配置作为起点：

cp librechat.example.yaml librechat.yaml

备选文件路径

您可以使用 CONFIG_PATH 环境变量设置自定义文件路径：

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

挂载配置文件

Docker 需要一个卷挂载（volume mount）来访问容器内的 librechat.yaml 文件。

复制示例覆盖文件：

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

编辑 docker-compose.override.yml 并确保 librechat.yaml 的卷挂载（volume mount）已取消注释：

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_KEY，而不是 OPENROUTER_API_KEY。使用 OPENROUTER_API_KEY 也会覆盖 OpenAI endpoint 并将其指向 OpenRouter。

3. 将 endpoint 添加到 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"