diff --git a/website/docs/meeting/agora.md b/website/docs/meeting/agora.md new file mode 100644 index 00000000..650760ae --- /dev/null +++ b/website/docs/meeting/agora.md @@ -0,0 +1,86 @@ +--- +sidebar_position: 10 +title: 声网插件部署指南 +--- + +:::info +声网插件需要确保您的 `tailchat` 镜像版本在 1.4.0+ +::: + +## 在声网平台申请项目 + +Tailchat 声网集成是依赖声网服务实现的音视频通话功能,因此在使用前需要在声网平台上注册。 + +声网官方: [https://www.agora.io/](https://www.agora.io/) + +### 获取配置参数 + +注册完毕后/登录后会自动跳转到控制台。在控制台中可以进行项目配置 + +![](./images/1.png) + +如果没有创建项目则需要先创建项目。如下图所示 + +![](./images/2.png) + +建议使用安全模式以避免被其他人盗用。 + +接下来我们需要获取一些配置项用于配置`Tailchat`的声网插件。 + +![](./images/3.png) + +在项目配置中我们可以获取 `appid` 和`app cert`。这个两个是我们之后要用到的环境变量 `AGORA_APP_ID` 和 `AGORA_APP_CERT` + + + +### 申请服务状态回调 + +为了使通话状态能够同步给`Tailchat`, 需要在声网中申请服务端回调。 + +在项目配置中,我们需要在`服务配置` 中启用`消息通知服务` + +![](./images/6.png) + +需要订阅以下事件: + +- channel create=101 +- channel destroy=102 +- broadcaster join channel=103 +- broadcaster leave channel=104 + +接收服务器 URL 一般为: `https:///api/plugin:com.msgbyte.agora/webhook`, 其中`` 换成你的 `Tailchat` 域名。 + +配置完成后你会看到如下提示。等待声网工作人员确认完毕后即可生效。 + +![](./images/7.png) + +### 获取客户凭证 + +另外我们还需要在右上角的 `RESTful API` 处获得客户的权限, + +操作如图所示: + +![](./images/4.png) + +![](./images/5.png) + +这样我们就拿到了另外两个环境变量: `AGORA_CUSTOMER_KEY` 和 `AGORA_CUSTOMER_SECRET`。 + +我们初步的准备工作就完成了 + +## 安装插件 + +目前声网插件的服务端插件已经被默认安装,您无需做任何事情。但是为了正常使用需要配置环境变量 + +### 配置环境变量 + +配置环境变量请见 [环境变量](../deployment/environment.md) + +声网插件需要环境变量如下: + +- `AGORA_APP_ID`: 声网项目应用id +- `AGORA_APP_CERT`: 声网项目证书 +- `AGORA_CUSTOMER_KEY`: 声网客户id +- `AGORA_CUSTOMER_SECRET`: 声网客户秘钥 + +这些环境变量都可以在上面的教程中获取。 diff --git a/website/docs/meeting/images/1.png b/website/docs/meeting/images/1.png new file mode 100644 index 00000000..67801ec8 Binary files /dev/null and b/website/docs/meeting/images/1.png differ diff --git a/website/docs/meeting/images/2.png b/website/docs/meeting/images/2.png new file mode 100644 index 00000000..19f9e0cd Binary files /dev/null and b/website/docs/meeting/images/2.png differ diff --git a/website/docs/meeting/images/3.png b/website/docs/meeting/images/3.png new file mode 100644 index 00000000..4b60d5e6 Binary files /dev/null and b/website/docs/meeting/images/3.png differ diff --git a/website/docs/meeting/images/4.png b/website/docs/meeting/images/4.png new file mode 100644 index 00000000..138375d0 Binary files /dev/null and b/website/docs/meeting/images/4.png differ diff --git a/website/docs/meeting/images/5.png b/website/docs/meeting/images/5.png new file mode 100644 index 00000000..b04aacfd Binary files /dev/null and b/website/docs/meeting/images/5.png differ diff --git a/website/docs/meeting/images/6.png b/website/docs/meeting/images/6.png new file mode 100644 index 00000000..2af1123b Binary files /dev/null and b/website/docs/meeting/images/6.png differ diff --git a/website/docs/meeting/images/7.png b/website/docs/meeting/images/7.png new file mode 100644 index 00000000..11b72c66 Binary files /dev/null and b/website/docs/meeting/images/7.png differ diff --git a/website/docs/meeting/intro.md b/website/docs/meeting/intro.md index a36a4363..67a93e78 100644 --- a/website/docs/meeting/intro.md +++ b/website/docs/meeting/intro.md @@ -3,6 +3,10 @@ sidebar_position: 1 title: 概述 --- +`Tailchat` 提供两套方案用于视频语音通话,可以根据实际情况自行选择: +- `tailchat-meeting` 自部署视频会议(WIP) +- `agora` 声网集成, 详细说明见: [声网插件部署指南](./agora.md) + ## Tailchat Meeting 视频会议模块是 `Tailchat` 系列的一套重要组成部分。提供能力如下: