配置文件参考

本文档由 AI 编写，已经人工审核。

配置文件参考#

配置文件格式#

NextBridge 支持 JSON、YAML 和 TOML 格式的配置文件。将配置文件放在数据目录（默认为 data/）下，程序会按以下顺序查找并使用第一个存在的文件：

config.json
config.yaml / config.yml
config.toml

格式转换#

使用内置 convert 命令可以在各格式之间互转：

uv run main.py convert data/config.json data/config.yaml
uv run main.py convert data/config.yaml data/config.toml

配置验证#

使用内置 validate 命令检查配置和规则的语法正确性，无需启动桥接：

# 使用默认数据路径验证
uv run main.py validate

# 指定自定义数据目录
uv run main.py validate -d my-data/

# 仅验证指定的配置文件
uv run main.py validate -c path/to/config.yaml

# 仅验证指定的规则文件
uv run main.py validate -r path/to/rules.json

# 显式指定两者路径
uv run main.py validate --config config.yaml --rules rules.yaml

退出码：

0 — 验证通过
1 — 发现语法/格式错误
2 — 手动指定的文件未找到

结构#

无论使用哪种格式，配置文件均采用两级结构：

jsonc

{
  "global": {
    // ... 全局配置 ...
  },
  "<平台名>": {
    "<实例ID>": {
      // ... 驱动器配置 ...
    }
  }
}

层级	说明
global	全局配置选项，适用于所有驱动，除非在特定驱动配置中被覆盖
<平台名>	取值为 qq、discord、telegram、feishu、dingtalk、yunhu、kook、vocechat、matrix、signal、teams、googlechat、slack、mattermost、rocketchat、webhook 之一
<实例ID>	由你自由命名，在规则配置中用于引用此实例

全局配置#

global 部分包含适用于所有驱动的配置选项，除非在特定驱动配置中被覆盖。

键	是否必填	默认值	说明
proxy	否	—	全局代理 URL，适用于所有支持代理配置的驱动（例如：http://proxy.example.com:8080）。单个驱动的代理设置将覆盖此全局设置。
strict_echo_match	否	false	控制 NextBridge 防止 echo (回声) 到同一个频道/实例的行为。当为 false（默认）时，如果目标实例 ID 或频道与源消息相同，则跳过；当为 true 时，只有当目标实例 ID 和频道都与源消息相同时才跳过。默认为 false 以最大程度防止回声。
fuzzy_mention_match	否	false	控制在没有精确绑定映射时，是否回退使用昵称进行模糊匹配。当为 true 时，会尝试将提及用户的名称与目标平台中已知的显示名称进行匹配。当为 false（默认）时，仅精确的 ID 绑定或原生平台内的提及有效。默认为 false。
command_prefix	否	"nb"	内置桥接指令的前缀（不含前导 /）。例如将 /nb bind 改为 /<前缀> bind。
base_url	否	—	生成外部可访问链接时使用的公共基础 URL（如 QQ 合并转发页面链接）。示例：https://bridge.example.com
log	否	—	日志配置，用于控制日志输出和轮换。参见下方日志配置。
database	否	—	数据库配置，用于存储消息和用户映射。参见下方数据库配置。
http	否	—	共享 HTTP 服务器配置，用于挂载驱动器 Webhook。参见下方 HTTP 服务器配置。
plugins	否	—	插件发现与驱动器生命周期配置。参见下方插件配置。
middleware	否	—	消息中间件配置。参见下方中间件配置。

json

{
  "global": {
    "proxy": "http://proxy.example.com:8080"
  }
}

使用环境变量中的代理

如果未设置，程序会尝试从环境变量 http_proxy, https_proxy, all_proxy 中读取代理配置 (不分大小写)，此时你可以通过将 proxy 指定为特殊值 disabled 来阻止使用系统代理。

日志配置#

NextBridge 使用 loguru 进行日志记录，支持灵活的日志输出和轮换。日志配置控制控制台输出和文件日志行为。

配置选项#

键	是否必填	默认值	说明
log.level	否	INFO	控制台日志级别。
log.file_level	否	DEBUG	文件日志级别。默认为 DEBUG 以在故障排除时获取详细输出。
log.dir	否	null	日志文件目录路径。如果为 null 或未指定，则禁用文件日志。日志文件将自动以时间戳命名创建在指定目录中。
log.rotation_size	否	100 MB	单个日志文件的最大大小，超过此大小将自动轮换（例如："100 MB"、"500 MB"）。
log.retention_days	否	7	保留日志文件的天数。超过此天数的旧日志文件将被自动删除。设置为 0 可禁用自动删除。
log.compression	否	zip	轮换后日志文件的压缩格式（例如："zip"、"gz"、"tar.gz"）。设置为 null 可禁用压缩。
log.show_source	否	"auto"	控制日志中是否显示源文件位置。"auto"：仅在 DEBUG/TRACE 级别显示。"always"：始终显示。"never"：从不显示。

配置示例#

基础日志（仅控制台）：

json

{
  "global": {
    "log": {
      "level": "INFO"
    }
  }
}

带轮换的文件日志：

json

{
  "global": {
    "log": {
      "level": "INFO",
      "dir": "logs",
      "rotation_size": "100 MB",
      "retention_days": 7,
      "compression": "zip"
    }
  }
}

调试用的详细日志：

json

{
  "global": {
    "log": {
      "level": "DEBUG",
      "dir": "logs",
      "rotation_size": "50 MB",
      "retention_days": 3,
      "compression": null
    }
  }
}

日志轮换

当设置了 log.dir 时，日志文件在超过 log.rotation_size 大小时会自动轮换。超过 log.retention_days 天数的旧日志文件会被自动删除。可以使用 log.compression 压缩轮换后的文件以节省磁盘空间。

数据库配置#

NextBridge 使用 SQLAlchemy 进行数据库操作，支持多种数据库后端，包括 SQLite、MySQL、PostgreSQL 等。数据库用于存储：

不同平台之间的消息 ID 映射
用于跨平台用户识别的用户绑定
用户显示名称映射
临时绑定码

配置选项#

键	是否必填	默认值	说明
database.url	否	sqlite:///data.db	SQLAlchemy 数据库 URL。SQLite 相对路径会按 data/ 目录解析。
database.echo	否	false	启用 SQLAlchemy 查询日志用于调试。
database.pool_size	否	—	非 SQLite 数据库的连接池大小。未指定时使用 SQLAlchemy 默认值。
database.max_overflow	否	—	非 SQLite 数据库的连接池最大溢出大小。未指定时使用 SQLAlchemy 默认值。
database.pool_recycle	否	3600	连接回收时间（秒），默认为 1 小时。
database.sslmode	否	—	PostgreSQL SSL 模式（如 require、prefer、disable）。仅适用于 PostgreSQL。
database.connect_timeout	否	—	PostgreSQL 连接超时（秒）。仅适用于 PostgreSQL。
database.application_name	否	—	PostgreSQL 应用名称，用于连接标识。仅适用于 PostgreSQL。

数据库 URL 示例#

SQLite（默认）：

json

{
  "global": {
    "database": {
      "url": "sqlite:///data.db"
    }
  }
}

MySQL：

json

{
  "global": {
    "database": {
      "url": "mysql+pymysql://user:password@localhost:3306/nextbridge",
      "pool_size": 10,
      "max_overflow": 20,
      "pool_recycle": 3600
    }
  }
}

PostgreSQL：

json

{
  "global": {
    "database": {
      "url": "postgresql://user:password@localhost:5432/nextbridge",
      "pool_size": 10,
      "max_overflow": 20,
      "pool_recycle": 3600,
      "sslmode": "require",
      "connect_timeout": 10,
      "application_name": "nextbridge"
    }
  }
}

SQLite 路径处理

使用 SQLite 的相对路径（如 sqlite:///data.db）时，路径将相对于数据目录（data/）解析。绝对路径（如 sqlite:////var/lib/nextbridge/data.db）将按原样使用。

连接池

连接池设置（pool_size、max_overflow、pool_recycle）仅适用于非 SQLite 数据库。SQLite 使用基于文件的存储，不支持同样的连接池机制。

HTTP 服务器配置#

部分驱动器（钉钉、飞书、VoceChat、云湖等）通过 HTTP Webhook 接收消息。NextBridge 运行一个共享的 HTTP 服务器（FastAPI/uvicorn），挂载所有 Webhook 端点。

键	是否必填	默认值	说明
http.host	否	"0.0.0.0"	共享 HTTP 服务器绑定的主机/IP
http.port	否	9080	共享 HTTP 服务器端口
http.root_path	否	""	ASGI root_path，在带路径前缀的反向代理后使用
http.log_level	否	"info"	Uvicorn 日志级别（critical、error、warning、info、debug）
http.enable	否	"unset"	HTTP 服务器启动模式。"unset"：当有驱动器挂载子应用时自动启动。"true"：始终启动。"false"：从不启动。

json

{
  "global": {
    "http": {
      "host": "0.0.0.0",
      "port": 9080
    }
  }
}

插件配置#

控制驱动器与通用插件的发现、生命周期管理和每个插件的独立设置。

驱动器选择#

键	是否必填	默认值	说明
plugins.drivers.enabled	否	[]	要加载的驱动器名称。空列表 = 从配置文件键自动发现
plugins.drivers.external	dict	{}	外部驱动器导入，按名称键值

通用插件#

键	是否必填	默认值	说明
plugins.general.enabled	否	[]	要启用的插件名称
plugins.general.external	否	{}	外部插件模块，按名称键值
plugins.config	否	{}	按插件名称键值的配置

路径与生命周期#

键	是否必填	默认值	说明
plugins.paths	否	[]	扫描驱动器/插件 .py 文件的本地目录列表
plugins.auto_restart	否	true	崩溃的驱动器自动重启（指数退避）
plugins.max_restart_attempts	否	5	崩溃驱动器放弃重启前的最大重试次数
plugins.health_check_interval	否	60	定期驱动器健康检查间隔（秒）。设为 0 禁用
plugins.admin.enable	否	false	启用管理 API 端点（/_nextbridge/drivers、/_nextbridge/plugins、/_nextbridge/admin/reload/{id}）。需同时设置 password
plugins.admin.password	否	""	管理 API 访问密码（HTTP Basic Auth）。admin.enable 为 true 时必填

json

{
  "global": {
    "plugins": {
      "general": {
        "enabled": ["stats"]
      },
      "config": {
        "stats": {
          "interval": 300
        }
      },
      "auto_restart": true,
      "max_restart_attempts": 5,
      "admin": {
        "enable": true,
        "password": "your-secret-password"
      }
    }
  }
}

中间件配置#

消息中间件允许在消息发送前进行转换或过滤。中间件按列表顺序依次执行。

键	是否必填	默认值	说明
middleware.enabled	否	[]	要启用的中间件名称列表（按列表顺序执行）

json

{
  "global": {
    "middleware": {
      "enabled": ["example-middleware"]
    }
  }
}

同一平台可以运行多个实例，只需在平台名下添加多个键：

json

{
  "discord": {
    "服务器A": { "bot_token": "...", "webhook_url": "..." },
    "服务器B": { "bot_token": "...", "webhook_url": "..." }
  }
}

完整示例（JSON）#

json

{
  "qq": {
    "qq_main": {
      "ws_url": "ws://127.0.0.1:3001",
      "ws_token": "secret"
    }
  },
  "discord": {
    "dc_main": {
      "send_method": "webhook",
      "webhook_url": "https://discord.com/api/webhooks/ID/TOKEN",
      "bot_token": "BOT_TOKEN",
      "max_file_size": 8388608
    }
  },
  "telegram": {
    "tg_main": {
      "bot_token": "123456:ABC-DEF",
      "max_file_size": 52428800
    }
  },
  "feishu": {
    "fs_main": {
      "app_id": "cli_xxxx",
      "app_secret": "xxxx",
      "verification_token": "xxxx",
      "encrypt_key": "",
      "listen_port": 8080,
      "listen_path": "/event"
    }
  },
  "dingtalk": {
    "dt_main": {
      "app_key": "dingxxxx",
      "app_secret": "xxxx",
      "robot_code": "xxxx",
      "signing_secret": "xxxx",
      "listen_port": 8082,
      "listen_path": "/dingtalk/event"
    }
  },
  "matrix": {
    "mx_main": {
      "homeserver": "https://matrix.org",
      "user_id": "@mybot:matrix.org",
      "password": "your_password"
    }
  },
  "signal": {
    "sg_main": {
      "api_url": "http://localhost:8080",
      "number": "+12025551234"
    }
  },
  "slack": {
    "sl_main": {
      "bot_token": "xoxb-...",
      "app_token": "xapp-..."
    }
  }
}

完整示例（YAML）#

yaml

qq:
  qq_main:
    ws_url: ws://127.0.0.1:3001
    ws_token: secret

discord:
  dc_main:
    send_method: webhook
    webhook_url: https://discord.com/api/webhooks/ID/TOKEN
    bot_token: BOT_TOKEN
    max_file_size: 8388608

matrix:
  mx_main:
    homeserver: https://matrix.org
    user_id: "@mybot:matrix.org"
    password: your_password

各平台的详细配置项，请参阅驱动器章节中对应的驱动器页面。