配置

RelayCore 当前以 CLI 参数 + 环境变量 + 默认数据目录 为主进行配置。尚未提供统一的 config.toml 加载路径。

默认数据目录

默认目录为 ~/.relay-core(可通过 RELAY_DATA_DIR 覆盖)。HTTPS 拦截相关文件:

  • ca_cert.pem — CA 证书
  • ca_key.pem — CA 私钥
  • ca_cert.json — CA 元数据(持久化加载所需)

使用 relay-core-cli ca generate 生成证书后,relay-core-cli run 会从上述路径读取。证书不存在时 run 会直接失败并提示先生成 CA。

环境变量

变量说明
RELAY_DATA_DIR数据目录(默认 ~/.relay-core
RELAY_CA_CERTCA 证书路径(须与 RELAY_CA_KEY 成对);同时作用于 relay-core-clirelay-core-probe
RELAY_CA_KEYCA 私钥路径(须与 RELAY_CA_CERT 成对)
RELAY_LOG日志过滤级别(如 infodebugtrace
RELAY_CORE_TUI_THEME--theme 缺省时的 TUI 配色(relayslatehigh-contrast)。见 TUI 主题
RELAYCORE_UPSTREAM_PASSWORD上游代理 HTTP Basic 认证密码,与 --upstream-auth-user 配合。绝不要通过命令行参数传入密码(会进入 shell 历史)。见 代理模式 § 上游
RELAY_PORTrelay-core-probe 代理端口(默认 8080)
RELAY_PROBE_TRANSPORTMCP 传输方式:stdio(默认)或 sse
RELAY_PROBE_PORTSSE 模式下 MCP 监听端口(默认 3000)
RELAY_PROBE_BINDSSE 模式下 MCP 绑定地址(默认 127.0.0.1)

路径优先级:CLI 参数 > 环境变量 > 默认数据目录

TUI 配置文件

TUI 读取 ~/.relay-core/config.toml 以持久化偏好设置。目前仅消费 TUI 主题一项:

# ~/.relay-core/config.toml
[tui]
theme = "high-contrast"   # relay | slate | high-contrast

TUI 主题解析顺序:--theme 参数 > RELAY_CORE_TUI_THEME 环境变量 > 本文件 [tui].theme > 默认(relay)。

CLI 常用参数(run)

relay-core-cli run [options]

  --listen <ADDR>        代理监听地址(默认 127.0.0.1:8080)
  --ca-cert <PATH>       CA 证书路径(可选,覆盖默认)
  --ca-key <PATH>        CA 私钥路径(须与 --ca-cert 成对)
  --api-port <PORT>      启用 REST + SSE HTTP API
  --api-token <TOKEN>    HTTP API Bearer 认证
  --rules <PATH>         加载规则文件(JSON/YAML)
  --script <PATH>        加载 Deno 脚本
  --script-env-allow      脚本可读取的环境变量名(逗号分隔)
  --ui                   启用 TUI
  --theme <NAME>         TUI 配色
  --upstream <URL>       将所有流量路由到上级代理
  --save-stream <PATH>   将每条流量以 JSONL 追加到磁盘

生产环境建议

  • 仅本机使用时绑定 127.0.0.1,避免暴露到局域网
  • 启用 --api-port 时配合 --api-token 限制访问
  • 团队共享 CA 时统一 RELAY_DATA_DIR 或显式指定 --ca-cert / --ca-key