docs: add livekit deployment document

Author: moonrailgun

docker/livekit.yml

@@ -1,7 +1,7 @@
 version: "3.3"
 
 services:
-  # 后台应用
+  # livekit webhook receiver
   tailchat-livekit-webhook-receiver:
     build:
       context: ../

website/docs/meeting/_category_.json

@@ -1,4 +1,4 @@
 {
   "label": "Video Conference",
-  "position": 60
+  "position": 35
 }

website/docs/meeting/deployment.md

@@ -3,6 +3,10 @@ sidebar_position: 2
 title: Deploy Tailchat Meeting
 ---
 
+:::info
+The `Tailchat Meeting` solution is currently not integrated with `Tailchat`, if you want to use the video conferencing solution in Tailchat, please choose `agora` or `livekit` solution
+:::
+
 The video conferencing service `Tailchat Meeting` can exist as an independent application. In this section, we will describe how to deploy `Tailchat Meeting` independently
 
 The following content is based on the `docker` environment, please ensure that the server has the most basic `docker` environment.

website/docs/meeting/design.md

@@ -2,34 +2,46 @@
 sidebar_position: 1
 title: Summary
 ---
-`Tailchat` provides two solutions for video and voice calls, you can choose according to the actual situation:
-- `tailchat-meeting` self-deploying video conferencing (WIP)
+
+:::info
+Video Conference solutions require SSL support, so only websites that support https will work properly
+:::
+
+`Tailchat` provides those solutions for video and voice calls, you can choose according to the actual situation:
+- ~~`tailchat-meeting` self-deploying video conferencing (WIP)~~
 - `agora` Acoustic Network integration, for details, see: [Acoustic Network Plug-in Deployment Guide](./agora.md)
+- `livekit` Allow self-host solution: [Livekit Plugin Deployment Guide](./livekit.md)
 
-## Tailchat Meeting
 
-The video conferencing module is an important part of the suite of `Tailchat` series. Capabilities are provided as follows:
-- Voice communication
-- Video session
-- screen sharing
-- virtual background
-- file transfer
-- chat record
+<details>
+  <summary>Collapsed content is outdated</summary>
+  
+  ## Tailchat Meeting
 
-At the same time, `tailchat-meeting` can also exist as an independent product, and you can quickly initiate/join meetings without logging in
+  The video conferencing module is an important part of the suite of `Tailchat` series. Capabilities are provided as follows:
+  - Voice communication
+  - Video session
+  - screen sharing
+  - virtual background
+  - file transfer
+  - chat record
 
-### Project repository
+  At the same time, `tailchat-meeting` can also exist as an independent product, and you can quickly initiate/join meetings without logging in
 
-- Open source address: [https://github.com/msgbyte/tailchat-meeting](https://github.com/msgbyte/tailchat-meeting)
-- Open source agreement: Apache 2.0
+  ### Project repository
 
-:::info Open source statement
-This project is based on secondary development of [edumeet](https://github.com/edumeet/edumeet) and [mediasoup](https://github.com/versatica/mediasoup).
+  - Open source address: [https://github.com/msgbyte/tailchat-meeting](https://github.com/msgbyte/tailchat-meeting)
+  - Open source agreement: Apache 2.0
+
+  :::info Open source statement
+  This project is based on secondary development of [edumeet](https://github.com/edumeet/edumeet) and [mediasoup](https://github.com/versatica/mediasoup).
+
+  On this basis, function addition, SDK implementation and code optimization were carried out. If you want to find a looser implementation of the open source protocol (MIT + ISC protocol), you can take a look at these two projects
+  :::
 
-On this basis, function addition, SDK implementation and code optimization were carried out. If you want to find a looser implementation of the open source protocol (MIT + ISC protocol), you can take a look at these two projects
-:::
 
+  ### Project Architecture
 
-### Project Architecture
+  ![](/img/architecture/meeting.excalidraw.svg)
 
-![](/img/architecture/meeting.excalidraw.svg)
+</details>

website/docs/meeting/intro.md

@@ -0,0 +1,73 @@
+---
+sidebar_position: 20
+title: Livekit Plugin Deployment Guide
+---
+
+`Livekit` is an open source video conferencing solution based on the `Apache-2.0` open source protocol, allowing self-host, supporting video conferencing, live streaming, recording and other scenarios
+
+You can use his cloud service or self-host. Below I will introduce how to integrate `Livekit` into `Tailchat`:
+
+## Cloud Services
+
+First enter the Livekit cloud platform: [https://cloud.livekit.io/](https://cloud.livekit.io/), in the first time you enter, you need to create a project:
+
+It will ask some questions, just answer them according to the situation.
+
+![](/img/advanced-usage/livekit/1.png)
+
+After completion, we will enter the console main dashboard:
+
+![](/img/advanced-usage/livekit/2.png)
+
+### Get the required environment variables
+
+For the plugin to work, we need the following environment variables:
+
+- `LIVEKIT_URL`
+- `LIVEKIT_API_KEY`
+- `LIVEKIT_API_SECRET`
+
+Among them, `LIVEKIT_URL` can be obtained directly from the console, in the form of `wss://********.livekit.cloud`
+
+In the `Settings` menu on the left, we need to create a pair of secret keys by ourselves
+
+![](/img/advanced-usage/livekit/3.png)
+
+![](/img/advanced-usage/livekit/4.png)
+
+![](/img/advanced-usage/livekit/5.png)
+
+Here we can get `LIVEKIT_API_KEY` and `LIVEKIT_API_SECRET`.
+
+Record and fill in the environment variables and start `Tailchat`.
+
+### Start the webhook
+
+![](/img/advanced-usage/livekit/6.png)
+
+If you need the above-mentioned channel online prompts to be updated immediately, you need to start a `webhook-receiver` separately to accept pushes from `livekit` and forward the received events to `Tailchat`, so that `Tailchat` can update all groups Display of group membership.
+
+The official `docker-compose` configuration has been prepared for you with one click, just like `admin`:
+
+```bash
+wget https://raw.githubusercontent.com/msgbyte/tailchat/master/docker/livekit.yml
+docker compose -f docker-compose.yml -f livekit.yml up -d
+```
+
+At this point you can see a `tailchat-livekit-webhook-receiver` service in the docker running container.
+
+Then we switch to the `livekit` console and add our address in the `webhook`.
+
+![](/img/advanced-usage/livekit/7.png)
+
+Generally `https://<your tailchat url>/livekit/webhook`, remember to choose the same key pair as the service
+
+![](/img/advanced-usage/livekit/8.png)
+
+> PS: There may be some delays in cloud applications.
+
+## Self-host
+
+See the official documentation for self-host: [https://docs.livekit.io/oss/deployment/](https://docs.livekit.io/oss/deployment/)
+
+In addition to the different deployment methods and configuration first, others are the same as using cloud services

website/docs/meeting/livekit.md

@@ -3,6 +3,10 @@ sidebar_position: 2
 title: 部署视频会议
 ---
 
+:::info
+`Tailchat Meeting` 方案目前没有与 `Tailchat` 做集成，如果你期望在Tailchat中使用视频会议方案请选择 `agora` 或 `livekit` 解决方案
+:::
+
 视频会议服务 `Tailchat Meeting` 可以作为一个独立应用单品存在。在本节中将会讲述如何独立部署 `Tailchat Meeting`
 
 以下内容均基于`docker`环境，请确保服务端有 `docker` 最基本程度的环境。