Files
WebAI2API/docs/config/overview.md
T
2025-12-29 04:09:04 +08:00

3.2 KiB

配置文件概览、

WebAI2API 使用 YAML 格式的配置文件 config.yaml 进行配置。

::: warning 注意 项目的配置问价已可以完全使用 WebUI 进行配置,若您不了解 YAML 文件,请直接略过该板块访问 WebUI 修改配置! :::

配置文件结构

# 日志等级
logLevel: info

# 服务器配置
server:
  port: 3000
  auth: sk-your-key
  keepalive:
    mode: "comment"

# 后端配置
backend:
  pool:
    strategy: least_busy
    failover:
      enabled: true
      maxRetries: 2
    instances:
      - name: "browser_default"
        workers:
          - name: "default"
            type: lmarena
  adapter:
    gemini_biz:
      entryUrl: ""

# 队列配置
queue:
  queueBuffer: 2
  imageLimit: 5

# 浏览器配置
browser:
  path: ""
  headless: false
  proxy:
    enable: false

配置项说明

日志配置

配置项 类型 默认值 说明
logLevel string info 日志等级:debuginfowarnerror

服务器配置 (server)

配置项 类型 默认值 说明
port number 3000 HTTP 服务监听端口
auth string - API 鉴权 Token (Bearer Token)
keepalive.mode string comment 心跳模式:commentcontent

::: tip 心跳模式说明

  • comment: 发送 :keepalive 注释,不污染数据(推荐)
  • content: 发送空 delta,用于必须收到 JSON 才重置超时的客户端 :::

队列配置 (queue)

配置项 类型 默认值 说明
queueBuffer number 2 非流式请求的额外排队数,0 表示不限制
imageLimit number 5 单次请求最大图片数量 (最大 10)

浏览器配置 (browser)

配置项 类型 默认值 说明
path string "" Camoufox 可执行文件路径,留空使用默认
headless boolean false 是否启用无头模式
proxy object - 全局代理配置

适配器配置 (backend.adapter)

每个适配器都可以配置专属的模型黑白名单,用于控制该适配器可以使用的模型列表。

配置项 类型 默认值 说明
modelFilter.mode string - 过滤模式:whitelist (白名单) 或 blacklist (黑名单)
modelFilter.list array - 模型列表(根据 mode 决定是启用列表还是禁用列表)

::: tip 模型过滤说明

  • whitelist (白名单模式):仅允许列表中的模型
  • blacklist (黑名单模式):禁用列表中的模型,其他模型可用
  • 推荐使用 WebUI 进行配置 :::

配置示例:

backend:
  adapter:
    lmarena:
      returnUrl: false
      modelFilter:
        mode: whitelist                        # 白名单模式
        list:                                  # 仅启用以下模型
          - gemini-3-pro-image-preview
          - gemini-3-pro-image-preview-2k
          - gemini-2.5-flash-image-preview

相关文档