livekit/livekit-cli

LiveKit CLI 工具镜像

镜像概述

本镜像包含LiveKit的命令行工具集（CLI utilities），旨在提供与LiveKit实时音视频服务交互的便捷命令行接口。LiveKit是一个开源的实时音视频平台，支持高并发、低延迟的音视频通信，而本CLI工具集则为开发者和运维人员提供了通过命令行高效管理、配置、测试和监控LiveKit服务的能力。

核心功能与特性

• 房间管理：支持创建、列出、删除LiveKit房间，配置房间属性（如最大参与者数、媒体模式等）。
• 用户认证：生成和管理访问LiveKit服务的用户令牌，支持自定义权限、有效期和元数据。
• 媒体流测试：提供媒体流发布/订阅测试功能，模拟音视频流推流与拉流，验证服务媒体处理能力。
• 服务配置：支持导出/导入LiveKit服务配置，批量更新服务参数（如媒体编码设置、网络优化策略等）。
• 日志与监控：实时查看LiveKit服务日志，获取房间内媒体流状态、参与者连接信息等监控数据。
• 兼容性：与LiveKit服务各版本保持兼容，自动适配不同版本API特性。

使用场景与适用范围

• 开发环境：开发人员在本地或测试环境中快速验证LiveKit服务功能，调试音视频流交互逻辑。
• 生产运维：运维人员通过CLI工具远程管理生产环境中的LiveKit实例，执行房间清理、配置更新等操作。
• 自动化集成：集成到Shell脚本或CI/CD流程中，实现LiveKit服务的自动化部署、配置验证和健康检查。
• 问题诊断：通过媒体流测试和日志查看功能，快速定位LiveKit服务连接失败、媒体卡顿等问题。

使用方法与配置说明

前提条件

• 已安装Docker环境（Docker Engine 20.10+）。
• 已部署LiveKit服务，并获取服务访问地址（URL）、API密钥（API Key）和API密钥密钥（API Secret）。

安装与拉取镜像

通过Docker Hub拉取最新版本镜像：

bash
docker pull livekit/cli:latest

如需指定版本，可替换latest为具体版本号（如v1.5.0）：

bash
docker pull livekit/cli:v1.5.0

基本使用示例

通过docker run命令执行CLI工具，基本格式如下：

bash
docker run --rm -e LIVEKIT_API_KEY=<your-api-key> -e LIVEKIT_API_SECRET=<your-api-secret> -e LIVEKIT_URL=<your-livekit-url> livekit/cli <command> [options]

• --rm：容器退出后自动删除，避免残留容器文件。
• 环境变量用于配置与LiveKit服务的连接参数（见下文“环境变量配置”）。
• <command>：CLI工具具体命令（如room list、token generate等）。

环境变量配置

常用命令示例

1. 列出所有房间

bash
docker run --rm -e LIVEKIT_API_KEY=your-key -e LIVEKIT_API_SECRET=your-secret -e LIVEKIT_URL=your-url livekit/cli room list

2. 创建房间

bash
docker run --rm -e LIVEKIT_API_KEY=your-key -e LIVEKIT_API_SECRET=your-secret -e LIVEKIT_URL=your-url livekit/cli room create --name "test-room" --max-participants 50

3. 生成用户访问令牌

bash
docker run --rm -e LIVEKIT_API_KEY=your-key -e LIVEKIT_API_SECRET=your-secret livekit/cli token generate --room "test-room" --identity "user123" --expires-in 3600s

4. 测试媒体流发布

bash
docker run --rm -e LIVEKIT_API_KEY=your-key -e LIVEKIT_API_SECRET=your-secret -e LIVEKIT_URL=your-url livekit/cli test publish --room "test-room" --identity "test-publisher" --video-path ./test-video.mp4

命令行参数说明

除通过环境变量配置外，部分核心参数也可通过命令行直接指定（优先级高于环境变量）：

• --api-key：指定API密钥（替代LIVEKIT_API_KEY）。
• --api-secret：指定API密钥密钥（替代LIVEKIT_API_SECRET）。
• --url：指定LiveKit服务URL（替代LIVEKIT_URL）。

示例：

bash
docker run --rm livekit/cli room list --api-key your-key --api-secret your-secret --url your-url

注意事项

• 敏感信息保护：API密钥和密钥属于敏感信息，建议通过环境变量传入，避免直接写在命令行（可通过docker run -e或.env文件加载）。
• 版本匹配：确保CLI工具版本与LiveKit服务版本兼容，可通过docker run --rm livekit/cli version查看工具版本，并参考LiveKit官方文档确认兼容性。
• 网络权限：容器需具备访问LiveKit服务URL的网络权限，确保防火墙策略允许容器与服务端口通信（默认WebSocket端口：8080/443，HTTP API端口：7880）。