Skip to content

API 参考 ​

WebSocket 端点 ​

连接地址 ​

wss://<your-domain>/ws?room=<room_id>

连接参数 ​

参数类型必填说明
roomstring否房间 ID,默认 "default"。同一房间内的节点可互相发现

子协议 ​

连接使用 WebSocket 二进制消息,协议为 EasyTier Binary Protocol。详见协议说明。

HTTP 端点 ​

健康检查 ​

GET /healthz

响应:

200 OK
ok

主页 (Landing Page) ​

GET /

响应:

  • 200 OK — 返回精美的 HTML 主页,包含中继地址、使用指南等信息
  • 支持暗色/亮色主题切换
  • 支持中英文语言切换

WebSocket 端点 (浏览器访问) ​

GET /ws

当通过浏览器直接访问 WebSocket 端点(不带 Upgrade: websocket 头)时,返回主页 HTML。

服务器常量 ​

常量值说明
MY_PEER_ID10000001服务器 Peer ID
MAGIC0xd1e1a5e1协议魔数
VERSION1协议版本
HEADER_SIZE16二进制包头大小 (字节)

环境变量 ​

Cloudflare Workers ​

变量默认值说明
WS_PATHwsWebSocket 路径
EASYTIER_DISABLE_RELAY0是否禁用 Relay 模式
EASYTIER_COMPRESS_RPC1是否压缩 RPC 消息

EdgeOne Pages ​

变量默认值说明
WS_PATHwsWebSocket 路径
PORT9000Go 服务监听端口

示例:EasyTier 客户端配置 ​

命令行(去中心化组网) ​

bash
# DHCP 模式(自动分配 IP)
easytier-core -d -p ws://your-relay.workers.dev?room=my-network

# 固定 IP 模式
easytier-core --ipv4 10.0.0.1 -p ws://your-relay.workers.dev?room=my-network

# 指定网络名和密钥
easytier-core -d \
  -p ws://your-relay.workers.dev?room=my-network \
  --network-name my-network \
  --network-secret my-secret-key

多对端 (主备中继) ​

bash
easytier-core -d \
  -p ws://relay1.workers.dev?room=my-network \
  -p ws://relay2.workers.dev?room=my-network

配置文件 (config.toml) ​

toml
instance_name = "default"
dhcp = true

# 对端列表
[[peers]]
uri = "ws://relay1.workers.dev?room=my-network"

[[peers]]
uri = "ws://relay2.workers.dev?room=my-network"

[network_identity]
network_name = "my-network"
network_secret = "my-secret-key"

基于 MIT 许可证发布