快速开始
快速了解如何注册和使用 TL-RTC-APP
- 1
注册账号
点击右上角“登录”按钮，选择“注册账号”完成注册
- 2
选择套餐
根据需求选择合适的套餐方案，完成下单，联系客服进行付款购买
- 3
部署系统
按照部署文档说明完成系统部署
- 4
使用系统
登录系统后，可以进行视频通话、会议、聊天等操作
部署步骤
从零开始部署 TL-RTC-APP 到你的服务器
# 克隆项目
git clone https://github.com/tl-open-source/tl-rtc-app.git
# 安装依赖
cd tl-rtc-app
npm install
# 配置环境
vim tlrtcapp.env
# 启动服务
npm run http-api
npm run http-socket
或者
npm run https-api
npm run https-socket
# 如果想后台启动，先安装pm2
npm install pm2 -g
# pm2后台启动服务
pm2 start npm --name "t-r-a-api" -- run http-api
pm2 start npm --name "t-r-a-socket" -- run http-socket
或者
pm2 start npm --name "t-r-a-api" -- run https-api
pm2 start npm --name "t-r-a-socket" -- run https-socket
# 停止服务
pm2 stop t-r-a-api
pm2 stop t-r-a-socket系统要求
部署和运行所需的环境与依赖
环境要求
| 组件 | 版本 | 说明 |
|---|---|---|
Node.js | v16.0+ (推荐 v18 LTS) | 运行时环境 |
MySQL | 5.7+ (推荐 8.0+) | 关系型数据库 |
Redis | 4.0+ | 缓存与会话管理 |
PM2 | 最新版 | 进程管理（生产环境推荐） |
npm | 8.0+ | 包管理器 |
Docker | 20.0+ (可选) | 容器化部署 |
支持的浏览器
Chrome72+
Firefox78+
Safari14+
Edge79+
Docker 部署
使用 Docker 容器化方式快速部署
# 进入 docker 目录
cd tl-rtc-app/docker
# 复制并配置环境变量
cp .env.template .env
vim .env
# 使用 docker-compose 一键启动
docker-compose up -d
# 查看运行状态
docker-compose ps
# 查看日志
docker-compose logs -f
# 停止服务
docker-compose down注意事项
请确保已正确配置 docker/.env 文件中的 MySQL、Redis 连接信息，以及 SSL 证书路径等环境变量。详细配置说明请参考项目中的 docker/docker-compose.yaml 文件。
架构设计概览
TL-RTC-APP 整体架构设计说明
系统架构
TL-RTC-APP 采用前后端分离架构，核心由以下服务组成：
- -API 服务 (tlapi.js) — 提供 RESTful API 接口，处理业务逻辑
- -Socket 服务 (tlsocket.js) — 基于 Socket.IO 的实时通讯服务
- -SFU 服务 (tlsfuapi.js) — 选择性转发单元，处理多人音视频
- -Super API (tlsuperapi.js) — 后台管理服务
- -定时任务 (tlrscheduletask.js) — 定时调度任务处理
- -实时任务 (tlrealtimetask.js) — 实时任务队列处理
技术栈
前端：原生 JS + LayUI + WebRTC
后端：Node.js + Express + Socket.IO
数据库：MySQL + Sequelize ORM
缓存：Redis
任务队列：Bull (Redis-based)
桌面端：Electron / Tauri
数据库设计
数据库表结构与设计思路
核心数据表
系统包含 60+ 张数据表，覆盖用户、聊天、群组、云存储、AI助手、插件等模块，主要包括：
- -用户模块 — tl_user, tl_user_friend, tl_user_notify 等
- -频道/聊天模块 — tl_channel, tl_channel_chat, tl_channel_user 等
- -云资源模块 — tl_cloud_file, tl_cloud_file_share, tl_cloud_folder 等
- -AI助手模块 — tl_ai_assistant, tl_ai_assistant_knowledge 等
- -插件模块 — tl_plugin, tl_plugin_user 等
- -企业/组织模块 — tl_company, tl_department, tl_role 等
完整的数据库 ER 图和详细字段说明请参考付费版技术文档。
查看定价方案 →前后端模块说明
项目目录结构与模块划分
/web-res前端代码包含所有前端页面、组件、样式和多语言包
/src后端服务包含 API、Socket、业务逻辑、数据访问层和中间件
/system-res后台管理包含所有后台管理页面和组件
/browser-extension浏览器插件Chrome Extension 的弹窗、侧边栏和配置页面
/tauri-resTauri 桌面端Tauri 桌面应用的 Rust 源码和配置
/conf配置文件功能特性配置、主题皮肤、加密工具和环境变量
/dockerDocker 部署Dockerfile、docker-compose 和部署脚本
/plugins-res插件资源19+ 官方插件的打包资源文件
gulpfile.js构建配置前端资源构建、混淆和打包的 Gulp 任务
更多详细使用说明与注意事项将持续补充，敬请期待。
部署常见问题
部署过程中遇到的常见问题及解决方案
- 备份当前配置文件
- 拉取最新代码：git pull
- 更新依赖：npm install
- 重启服务：pm2 restart all
- 准备SSL证书文件
- 修改配置文件中的SSL相关配置
- 重启服务即可生效
- 安装Docker环境
- 进入 docker 目录并配置 .env 文件
- 运行 docker-compose up -d 一键启动
- 使用 docker-compose ps 查看运行状态
- 所有实例连接同一个 MySQL 和 Redis
- Socket 服务使用 Redis Adapter 实现跨实例通信
- 使用 Nginx 做负载均衡和反向代理
- PM2 可配置集群模式启动多个进程
- 克隆项目到本地：git clone https://github.com/tl-open-source/tl-rtc-app.git
- 安装项目依赖：cd tl-rtc-app && npm install
- 安装开发工具：npm install gulp -g
- 启动开发模式：gulp watch （自动监听文件变化并实时编译）
- 启动后台服务：npm run http-api 和 npm run http-socket
- 修改源代码，保存后将自动编译
- 在浏览器中访问 http://localhost:9092 查看效果
- 提交代码前请运行 npm run lint 进行代码规范检查
目录结构说明
/web-res前端代码 — 包含所有前端页面和组件/src后端服务 — 包含API和Socket等服务实现/system-res后台管理 — 包含所有后台管理页面和组件gulpfile.js构建配置 — 包含gulp任务配置使用常见问题
产品使用中的常见问题及解决方案
- 腾讯云 COS（Cloud Object Storage）
- 阿里云 OSS（Object Storage Service）
- 七牛云 Kodo
- 在 tlrtcapp.env 配置文件中设置对应的 AccessKey 和 SecretKey 即可
- 在 tlrtcapp.env 中配置 AI 服务的 API Key
- 支持 OpenAI 和豆包（火山方舟）两种模型
- 在后台管理系统中创建和配置自定义助手
- 可以为助手关联知识库以增强回答准确性
- 在应用设置中找到语言切换选项
- 选择目标语言（如中文/English）
- 切换后所有界面文案实时更新，无需刷新页面
- 从 Chrome Web Store 安装或手动加载 browser-extension 目录
- 在插件选项页配置服务器地址
- 通过工具栏图标打开弹窗或侧边栏使用
- 在应用内打开插件市场
- 浏览或搜索需要的插件
- 点击安装，插件会自动加载到对应位置
- 在设置中可以管理已安装的插件
技术文档
详细的技术参考资料
购买获取完整文档
购买付费版本，获取完整技术文档与专属技术支持