Docs · Agent

Agent

Agent 是运行在你数据库服务器上的轻量程序。它向控制平面注册、拉取隧道配置、 刷新临时凭证并管理 frpc,使数据库无需开放公网端口即可被云端应用访问。

系统要求

  • Node.js 18 或更高版本(Agent 仅依赖标准库,无需额外 npm 安装)。
  • 可访问目标数据库,并能向 Relay 发起出站连接。
  • Linux 上如需自启动,需要 systemd 与 root 权限。

安装

推荐使用一键脚本(Token 来自控制台 Agent 页面):

curl -fsSL https://www.dbveil.com/install.sh | DBVEIL_TOKEN=agt_live_xxx bash

脚本会把 Agent 安装到 ~/.dbveil-agent,并在 PATH 中创建 dbveil 命令。 非 root 用户会自动跳过 systemd 安装;如需校验 frpc,可在命令前加 FRPC_SHA256=<sha256>

常用命令

  • dbveil login <token> --api-url <url> — 注册 / 重新登录 Agent。
  • dbveil expose postgres --host 127.0.0.1 --port 5432 — 暴露本地服务。
  • dbveil status — 查看 Agent 与隧道状态。
  • dbveil start / stop / restart — 控制 frpc 运行。
  • dbveil logs — 查看运行日志。
  • dbveil uninstall — 卸载 Agent 与服务。

配置位置

  • ~/.dbveil-agent/config.json — API 地址、Agent ID、访问令牌(权限 600)。
  • ~/.dbveil-agent/frpc.toml — 由 Agent 生成的 frpc 配置。
  • ~/.dbveil-agent/bin/frpc — 下载的 frpc 可执行文件。

作为系统服务运行

在 Linux 上,安装时会写入 /etc/systemd/system/dbveil-agent.service 并启用开机自启。 可用 systemctl status dbveil-agent 查看,或用 dbveil restart 重启。

排错

  • 注册失败:确认 Token 未过期、API 地址正确、服务器可出站访问控制平面。
  • frpc 未启动:检查临时凭证是否过期,用 dbveil logs 查看详情。
  • 隧道连不上:核对隧道在控制台为「在线」,应用使用的是 Relay 公网地址。