Commit 92c0ea303cea3bff9bbee1ed4d268a2897e89ca4
1 parent
3235b4e7
feat(im):增加 livekit poc 启动脚本
Showing
4 changed files
with
187 additions
and
0 deletions
script/livekit-poc/README.md
0 → 100644
| 1 | +# LiveKit Server PoC | ||
| 2 | + | ||
| 3 | +最小可用的 LiveKit Server 自部署验证环境,用于零期 PoC。 | ||
| 4 | + | ||
| 5 | +## 启动 | ||
| 6 | + | ||
| 7 | +```bash | ||
| 8 | +cd tools/livekit-poc | ||
| 9 | +docker compose up -d | ||
| 10 | +bash verify.sh | ||
| 11 | +``` | ||
| 12 | + | ||
| 13 | +## 端口 | ||
| 14 | + | ||
| 15 | +- 7880:HTTP / WebSocket 信令; | ||
| 16 | +- 7881:WebRTC TCP fallback; | ||
| 17 | +- 7882/UDP:WebRTC 媒体; | ||
| 18 | +- macOS / Windows:当前 `docker-compose.yml` 走端口映射模式,webhook URL 用 `host.docker.internal:48080` 让容器访问到宿主机 yudao 后端; | ||
| 19 | +- macOS 上 host network(`network_mode: host`)需要 Docker Desktop 4.34+ 并在 Settings → Resources → Network 勾选「Enable host networking」,老版本静默失败(容器跑得起来但端口完全不通); | ||
| 20 | +- Linux:可以把 `docker-compose.yml` 改成 `network_mode: host` + 删 `ports:` 段,并把 `livekit.yaml` 的 webhook URL 改为 `http://127.0.0.1:48080/admin-api/im/livekit/webhook`。 | ||
| 21 | + | ||
| 22 | +## 凭据 (仅 PoC,勿用于生产) | ||
| 23 | + | ||
| 24 | +- `LIVEKIT_KEYS=devkey: secret-poc-key-min-32-chars-required-here` | ||
| 25 | +- API Key:`devkey` | ||
| 26 | +- API Secret:`secret-poc-key-min-32-chars-required-here` | ||
| 27 | + | ||
| 28 | +生产环境必须改用强随机 secret,并通过 `--config /etc/livekit.yaml` 加载。 | ||
| 29 | + | ||
| 30 | +## 浏览器联调 | ||
| 31 | + | ||
| 32 | +`verify.sh` 跑完会输出一个 `meet.livekit.io` 链接,用两个浏览器(或两台机器)打开同一链接即可看到对方画面。 |
script/livekit-poc/docker-compose.yml
0 → 100644
| 1 | +services: | ||
| 2 | + livekit: | ||
| 3 | + image: docker.m.daocloud.io/livekit/livekit-server:latest | ||
| 4 | + container_name: yudao-livekit-dev | ||
| 5 | + restart: unless-stopped | ||
| 6 | + # 端口映射模式 | ||
| 7 | + # macOS / Windows 必走这种方式:Docker Desktop 4.34 以下没有 host network | ||
| 8 | + # Linux 可以改 network_mode: host 省去映射,并把 livekit.yaml 的 webhook url 换成 127.0.0.1 | ||
| 9 | + ports: | ||
| 10 | + - "7880:7880" # HTTP / WebSocket 信令 | ||
| 11 | + - "7881:7881" # WebRTC TCP fallback | ||
| 12 | + - "7882:7882/udp" # WebRTC UDP (dev 模式 UDP mux 单端口) | ||
| 13 | + volumes: | ||
| 14 | + # 挂载 config 文件;webhook 配置在 livekit.yaml 里 | ||
| 15 | + - ./livekit.yaml:/etc/livekit.yaml:ro | ||
| 16 | + command: | ||
| 17 | + - --config | ||
| 18 | + - /etc/livekit.yaml | ||
| 19 | + - --bind | ||
| 20 | + - 0.0.0.0 |
script/livekit-poc/livekit.yaml
0 → 100644
| 1 | +# LiveKit Server 本地开发配置(PoC 用,勿用于生产) | ||
| 2 | +# 替代 docker --dev 模式;为支持 webhook 必须用 config 文件而非 env | ||
| 3 | + | ||
| 4 | +keys: | ||
| 5 | + devkey: secret-poc-key-min-32-chars-required-here | ||
| 6 | + | ||
| 7 | +# 端口 | ||
| 8 | +port: 7880 | ||
| 9 | +rtc: | ||
| 10 | + tcp_port: 7881 | ||
| 11 | + udp_port: 7882 | ||
| 12 | + use_external_ip: false | ||
| 13 | + | ||
| 14 | +# Webhook:成员离开 / 房间结束等事件回调到 yudao 后端做业务态兜底清理 | ||
| 15 | +# host.docker.internal 让容器访问宿主机 macOS / Windows 上的 yudao 后端 | ||
| 16 | +# Linux 上 docker compose 可改 network_mode: host,这里同步改成 127.0.0.1 | ||
| 17 | +# api_key 用于签发 JWT,yudao 后端用相同 secret 验证签名 | ||
| 18 | +webhook: | ||
| 19 | + api_key: devkey | ||
| 20 | + urls: | ||
| 21 | + - http://host.docker.internal:48080/admin-api/im/livekit/webhook | ||
| 22 | + | ||
| 23 | +# 房间无人时多久销毁;秒;之前 PoC 默认 300,给低些方便排查 | ||
| 24 | +room: | ||
| 25 | + empty_timeout: 300 | ||
| 26 | + departure_timeout: 20 | ||
| 27 | + | ||
| 28 | +# 开发模式:放宽 secret 长度限制 + 内置 TURN 服务 | ||
| 29 | +development: true | ||
| 30 | +log_level: info |
script/livekit-poc/verify.sh
0 → 100755
| 1 | +#!/usr/bin/env bash | ||
| 2 | +# LiveKit Server PoC 验证脚本; | ||
| 3 | +# 用法: bash verify.sh | ||
| 4 | +set -e | ||
| 5 | + | ||
| 6 | +API_KEY="${LIVEKIT_API_KEY:-devkey}" | ||
| 7 | +API_SECRET="${LIVEKIT_API_SECRET:-secret-poc-key-min-32-chars-required-here}" | ||
| 8 | +HOST="${LIVEKIT_HOST:-localhost:7880}" | ||
| 9 | +ROOM="${LIVEKIT_ROOM:-poc-room}" | ||
| 10 | + | ||
| 11 | +ok() { printf "[OK] %s\n" "$1"; } | ||
| 12 | +fail() { printf "[FAIL] %s\n" "$1"; exit 1; } | ||
| 13 | + | ||
| 14 | +echo "==> 1/5 等待 HTTP 端点就绪 (http://${HOST}/)" | ||
| 15 | +for i in $(seq 1 20); do | ||
| 16 | + code=$(curl -s -o /dev/null -w "%{http_code}" "http://${HOST}/" || echo "000") | ||
| 17 | + [ "$code" = "200" ] && { ok "HTTP 200"; break; } | ||
| 18 | + [ $i -eq 20 ] && fail "20 秒内未就绪 (last code=${code})" | ||
| 19 | + sleep 1 | ||
| 20 | +done | ||
| 21 | + | ||
| 22 | +echo "==> 2/5 签发管理 + 客户端权限 Token" | ||
| 23 | +TOKEN=$(API_KEY="$API_KEY" API_SECRET="$API_SECRET" ROOM="$ROOM" python3 - <<'PY' | ||
| 24 | +import json, time, hmac, hashlib, base64, os | ||
| 25 | +def b64u(b): return base64.urlsafe_b64encode(b).rstrip(b'=').decode() | ||
| 26 | +header = b64u(json.dumps({"alg":"HS256","typ":"JWT"}, separators=(',',':')).encode()) | ||
| 27 | +payload = b64u(json.dumps({ | ||
| 28 | + "iss": os.environ["API_KEY"], | ||
| 29 | + "sub": "poc-tester", | ||
| 30 | + "name": "PoC Tester", | ||
| 31 | + "video": { | ||
| 32 | + "roomJoin": True, "room": os.environ["ROOM"], | ||
| 33 | + "canPublish": True, "canSubscribe": True, "canPublishData": True, | ||
| 34 | + "roomCreate": True, "roomList": True, "roomAdmin": True | ||
| 35 | + }, | ||
| 36 | + "exp": int(time.time()) + 3600, | ||
| 37 | + "nbf": int(time.time()) | ||
| 38 | +}, separators=(',',':')).encode()) | ||
| 39 | +sig = b64u(hmac.new(os.environ["API_SECRET"].encode(), | ||
| 40 | + f"{header}.{payload}".encode(), | ||
| 41 | + hashlib.sha256).digest()) | ||
| 42 | +print(f"{header}.{payload}.{sig}") | ||
| 43 | +PY | ||
| 44 | +) | ||
| 45 | +[ -n "$TOKEN" ] || fail "Token 生成失败" | ||
| 46 | +ok "Token 已生成 (${#TOKEN} chars)" | ||
| 47 | + | ||
| 48 | +echo "==> 3/5 创建房间 ${ROOM} (CreateRoom RPC)" | ||
| 49 | +create_resp=$(curl -s -X POST "http://${HOST}/twirp/livekit.RoomService/CreateRoom" \ | ||
| 50 | + -H "Authorization: Bearer ${TOKEN}" \ | ||
| 51 | + -H "Content-Type: application/json" \ | ||
| 52 | + -d "{\"name\":\"${ROOM}\",\"empty_timeout\":300,\"max_participants\":10}") | ||
| 53 | +echo " 响应: $create_resp" | ||
| 54 | +echo "$create_resp" | jq -e '.sid' >/dev/null 2>&1 \ | ||
| 55 | + && ok "房间已创建" \ | ||
| 56 | + || fail "CreateRoom 失败" | ||
| 57 | + | ||
| 58 | +echo "==> 4/5 列出房间 (ListRooms RPC)" | ||
| 59 | +list_resp=$(curl -s -X POST "http://${HOST}/twirp/livekit.RoomService/ListRooms" \ | ||
| 60 | + -H "Authorization: Bearer ${TOKEN}" \ | ||
| 61 | + -H "Content-Type: application/json" \ | ||
| 62 | + -d '{}') | ||
| 63 | +room_count=$(echo "$list_resp" | jq '.rooms | length' 2>/dev/null || echo "0") | ||
| 64 | +ok "当前房间数: ${room_count}" | ||
| 65 | +echo "$list_resp" | jq '.' | ||
| 66 | + | ||
| 67 | +echo "==> 5/5 删除房间 (DeleteRoom RPC) —— 清理" | ||
| 68 | +del_resp=$(curl -s -X POST "http://${HOST}/twirp/livekit.RoomService/DeleteRoom" \ | ||
| 69 | + -H "Authorization: Bearer ${TOKEN}" \ | ||
| 70 | + -H "Content-Type: application/json" \ | ||
| 71 | + -d "{\"room\":\"${ROOM}\"}") | ||
| 72 | +ok "删除响应: $del_resp" | ||
| 73 | + | ||
| 74 | +# 重新签一个仅 client 权限的 token;用于浏览器进会 | ||
| 75 | +CLIENT_TOKEN=$(API_KEY="$API_KEY" API_SECRET="$API_SECRET" ROOM="$ROOM" python3 - <<'PY' | ||
| 76 | +import json, time, hmac, hashlib, base64, os | ||
| 77 | +def b64u(b): return base64.urlsafe_b64encode(b).rstrip(b'=').decode() | ||
| 78 | +header = b64u(json.dumps({"alg":"HS256","typ":"JWT"}, separators=(',',':')).encode()) | ||
| 79 | +payload = b64u(json.dumps({ | ||
| 80 | + "iss": os.environ["API_KEY"], | ||
| 81 | + "sub": "browser-tester", | ||
| 82 | + "name": "Browser", | ||
| 83 | + "video": { | ||
| 84 | + "roomJoin": True, "room": os.environ["ROOM"], | ||
| 85 | + "canPublish": True, "canSubscribe": True, "canPublishData": True | ||
| 86 | + }, | ||
| 87 | + "exp": int(time.time()) + 7200 | ||
| 88 | +}, separators=(',',':')).encode()) | ||
| 89 | +sig = b64u(hmac.new(os.environ["API_SECRET"].encode(), | ||
| 90 | + f"{header}.{payload}".encode(), | ||
| 91 | + hashlib.sha256).digest()) | ||
| 92 | +print(f"{header}.{payload}.{sig}") | ||
| 93 | +PY | ||
| 94 | +) | ||
| 95 | + | ||
| 96 | +echo "" | ||
| 97 | +echo "============================================================" | ||
| 98 | +echo " LiveKit Server 验证通过" | ||
| 99 | +echo "============================================================" | ||
| 100 | +echo " 浏览器测试 (开两个窗口能互通):" | ||
| 101 | +echo " https://meet.livekit.io/?liveKitUrl=ws%3A%2F%2F${HOST}&token=${CLIENT_TOKEN}" | ||
| 102 | +echo "" | ||
| 103 | +echo " 停止服务:" | ||
| 104 | +echo " docker compose -f tools/livekit-poc/docker-compose.yml down" | ||
| 105 | +echo "============================================================" |