跳转到内容

Bonjour 设备发现

CoderClaw 使用 Bonjour(mDNS / DNS‑SD)作为仅限局域网的便捷方式来发现 活跃的 Gateway 网关(WebSocket 端点)。这是尽力而为的,不能替代 SSH 或 基于 Tailnet 的连接。

通过 Tailscale 的广域 Bonjour(单播 DNS‑SD)

Section titled “通过 Tailscale 的广域 Bonjour(单播 DNS‑SD)”

如果节点和 Gateway 网关在不同的网络上,多播 mDNS 无法跨越 边界。你可以通过切换到基于 Tailscale 的单播 DNS‑SD (“广域 Bonjour”)来保持相同的设备发现用户体验。

概要步骤:

  1. 在 Gateway 网关主机上运行 DNS 服务器(可通过 Tailnet 访问)。
  2. 在专用区域下发布 _coderclaw-gw._tcp 的 DNS‑SD 记录 (示例:coderclaw.internal.)。
  3. 配置 Tailscale 分割 DNS,使你选择的域名通过该 DNS 服务器为客户端(包括 iOS)解析。

CoderClaw 支持任何发现域名;coderclaw.internal. 只是一个示例。 iOS/Android 节点同时浏览 local. 和你配置的广域域名。

{
gateway: { bind: "tailnet" }, // 仅 tailnet(推荐)
discovery: { wideArea: { enabled: true } }, // 启用广域 DNS-SD 发布
}

一次性 DNS 服务器设置(Gateway 网关主机)

Section titled “一次性 DNS 服务器设置(Gateway 网关主机)”
Terminal window
coderclaw dns setup --apply

这会安装 CoreDNS 并配置它:

  • 仅在 Gateway 网关的 Tailscale 接口上监听 53 端口
  • ~/.coderclaw/dns/<domain>.db 提供你选择的域名服务(示例:coderclaw.internal.

从 Tailnet 连接的机器上验证:

Terminal window
dns-sd -B _coderclaw-gw._tcp coderclaw.internal.
dig @<TAILNET_IPV4> -p 53 _coderclaw-gw._tcp.coderclaw.internal PTR +short

在 Tailscale 管理控制台中:

  • 添加指向 Gateway 网关 Tailnet IP 的名称服务器(UDP/TCP 53)。
  • 添加分割 DNS,使你的发现域名使用该名称服务器。

一旦客户端接受 Tailnet DNS,iOS 节点就可以在 你的发现域名中浏览 _coderclaw-gw._tcp,无需多播。

Gateway 网关 WS 端口(默认 18789)默认绑定到 loopback。对于局域网/Tailnet 访问,请明确绑定并保持认证启用。

对于仅 Tailnet 的设置:

  • ~/.coderclaw/coderclaw.json 中设置 gateway.bind: "tailnet"
  • 重启 Gateway 网关(或重启 macOS 菜单栏应用)。

只有 Gateway 网关广播 _coderclaw-gw._tcp

  • _coderclaw-gw._tcp — Gateway 网关传输信标(被 macOS/iOS/Android 节点使用)。

Gateway 网关广播小型非机密提示以方便 UI 流程:

  • role=gateway
  • displayName=<友好名称>
  • lanHost=<hostname>.local
  • gatewayPort=<port>(Gateway 网关 WS + HTTP)
  • gatewayTls=1(仅当 TLS 启用时)
  • gatewayTlsSha256=<sha256>(仅当 TLS 启用且指纹可用时)
  • canvasPort=<port>(仅当画布主机启用时;默认 18793
  • sshPort=<port>(未覆盖时默认为 22)
  • transport=gateway
  • cliPath=<path>(可选;可运行的 coderclaw 入口点的绝对路径)
  • tailnetDns=<magicdns>(当 Tailnet 可用时的可选提示)

有用的内置工具:

  • 浏览实例:
    Terminal window
    dns-sd -B _coderclaw-gw._tcp local.
  • 解析单个实例(替换 <instance>):
    Terminal window
    dns-sd -L "<instance>" _coderclaw-gw._tcp local.

如果浏览有效但解析失败,你通常遇到的是局域网策略或 mDNS 解析器问题。

Gateway 网关会写入滚动日志文件(启动时打印为 gateway log file: ...)。查找 bonjour: 行,特别是:

  • bonjour: advertise failed ...
  • bonjour: ... name conflict resolved / hostname conflict resolved
  • bonjour: watchdog detected non-announced service ...

iOS 节点使用 NWBrowser 来发现 _coderclaw-gw._tcp

要捕获日志:

  • 设置 → Gateway 网关 → 高级 → Discovery Debug Logs
  • 设置 → Gateway 网关 → 高级 → Discovery Logs → 复现 → Copy

日志包括浏览器状态转换和结果集变化。

  • Bonjour 不能跨网络:使用 Tailnet 或 SSH。
  • 多播被阻止:某些 Wi‑Fi 网络禁用 mDNS。
  • 休眠 / 接口变动:macOS 可能暂时丢弃 mDNS 结果;重试。
  • 浏览有效但解析失败:保持机器名称简单(避免表情符号或 标点符号),然后重启 Gateway 网关。服务实例名称源自 主机名,因此过于复杂的名称可能会混淆某些解析器。

Bonjour/DNS‑SD 经常将服务实例名称中的字节转义为十进制 \DDD 序列(例如空格变成 \032)。

  • 这在协议级别是正常的。
  • UI 应该解码以进行显示(iOS 使用 BonjourEscapes.decode)。
  • CODERCLAW_DISABLE_BONJOUR=1 禁用广播(旧版:CODERCLAW_DISABLE_BONJOUR)。
  • ~/.coderclaw/coderclaw.json 中的 gateway.bind 控制 Gateway 网关绑定模式。
  • CODERCLAW_SSH_PORT 覆盖 TXT 中广播的 SSH 端口(旧版:CODERCLAW_SSH_PORT)。
  • CODERCLAW_TAILNET_DNS 在 TXT 中发布 MagicDNS 提示(旧版:CODERCLAW_TAILNET_DNS)。
  • CODERCLAW_CLI_PATH 覆盖广播的 CLI 路径(旧版:CODERCLAW_CLI_PATH)。