feat: 支持绘画同步

feat: 支持敏感词检测
feat: 支持多语言版本
feat: 支持回车发送消息
feat: 支持展示房主，语言版本
feat: 支持分享链接带上语言版本
feat: 支持设置公共聊天频道消息展示条数
feat: 支持固定/临时turn账号切换
feat: 支持一键启动脚本
feat: 支持浏览器控制台打印logo
feat: 调整优化svg, icon图标
feat: 调整优化弹窗动画
feat: 调整优化媒体流时间动画
feat: 调整优化oss逻辑
feat: 调整优化报错告警信息

Author: iamtsm

PAY.md

@@ -7,14 +7,14 @@
 
 ## 项目定制服务
 
-### 1. 项目功能定制
+### 1. 定制开发支持
+- **服务内容：** 免费提供定制开发技术支持，可协助部署安装相关事项，或协助自行开发，细节问题答疑
+- **免费：** 非常乐意为各位使用的小伙伴提供帮助，大家觉得好用的同时可以点击start支持下
+
+### 2. 项目功能定制
 - **服务内容：** 对项目进行功能定制或扩展
 - **价格：** 按功能大小，紧急程度，耗时，定制内容是否允许开源，等情况收费
 
-### 2. 定制开发支持
-- **服务内容：** 提供定制开发技术支持，可协助部署安装相关事项，或协助自行开发，细节问题答疑
-- **价格：** 一杯咖啡
-
 ## 收费模式
 - **按小时计费：** 根据实际工作时间计算费用，目前个人定制功能2小时起，每小时200~300，企业定制另谈
 - **阶段性付费：** 确认开发前，预付1/3，开发完成付1/3，交付上线1/3

README.md

@@ -21,7 +21,7 @@
 
 **qq交流群 : 624214498**
 
-## 准备
+## 准备 (必须步骤)
 
 安装node-14.x，npm后进入项目目录运行下面命令
 
@@ -40,97 +40,185 @@
     `npm run dev` (打包开发环境min) 或者  `npm run pro` 打包生产环境min
 
 
-## 启动
+## 启动 (必须步骤)
 
-http形式启动以下两个服务
+http形式启动以下两个服务, 选一种模式启动即可
 
     api服务: `npm run lapi`
 
     socket服务 : `npm run lsocket`
 
-    或者https形式启动一下两个服务
+或者https形式启动一下两个服务
 
     api服务: `npm run sapi`
 
     socket服务 : `npm run ssocket`
 
-选一种模式启动即可
 
-## 配置数据库 (默认关闭)
+## 配置websocket (必须步骤)
 
-    修改conf/cfg.json中相应数据库配置即可, 如open, dbName, host, port, user, pwd 等
+修改cfg.json中相应ws配置，或者wss配置
 
+    "ws": {
+          "port": 8444,                         #socket 端口
+          "host": "ws://127.0.0.1:8444",        #socket ip
+          "control_port": 8445,                 #远程控制socket 端口
+          "control_host": "ws://127.0.0.1:8445" #远程控制socket ip
+     },
+     "wss" : {
+          "port": 8444,
+          "host": "wss://域名||ip:port",
+          "control_port": 8445,
+          "control_host": "wss://域名||ip:port"
+     },
 
-## 配置websocket (ws/wss)
+## 配置数据库 (非必须步骤)
 
-    修改conf/cfg.json中相应ws配置，或者wss配置
+修改cfg.json中相应数据库配置  
 
-## 配置turnserver (中继服务)
+    "db": {
+        "open": false, #是否开启数据库, 默认关闭
+        "mysql": {
+            "host": "host地址",
+            "port": 3306,
+            "dbName": "数据库名称",
+            "user": "用户名",
+            "password": "密码",
+            "other": {
+                "sequelize": {
+                    "dialect": "mysql",
+                    "host": "host地址",
+                    "port": 3306,
+                    "logging": false,
+                    "pool": {
+                        "max": 5,
+                        "min": 0,
+                        "acquire": 30000,
+                        "idle": 10000
+                    },
+                    "timezone": "+08:00",
+                    "define": {
+                        "freezeTableName": true,
+                        "underscored": true,
+                        "charset": "utf8",
+                        "collate": "utf8_general_ci",
+                        "timestamps": false,
+                        "paranoid": true
+                    }
+                }
+            }
+        }
+    }
 
-    ubuntu:
+## 配置turnserver (局域网非必须步骤，公网必须步骤)
 
-    1. sudo apt-get install coturn  #安装coturn 
+ubuntu示例:
 
-    2. cp conf/turn/turnserver.conf /etc/turnserver.conf    #修改配置文件, 文件内容按需修改
+    安装coturn  `sudo apt-get install coturn`
 
-    3. chomd +x bin/genTurnUser.sh && ./genTurnUser.sh     #文件内容按需修改
+    项目提供了一份配置文件模板在 : `conf/turn/turnserver.conf`
 
-    4. chomd +x bin/startTurnServer.sh && ./startTurnServer.sh     #启动turnserver，文件内容按需修改
+    修改配置文件后复制一份  `cp conf/turn/turnserver.conf /etc/turnserver.conf`
 
-## Docker
+示例用户和密码: tlrtcfile
 
-    修改conf/cfg.json中的ws/wss的ip地址（有更好的办法可以反馈下）
+    生成用户 (turnadmin生成密码)  `turnadmin -k -u tlrtcfile -r 你的域名`
+    或者 (自定义密码)  `turnadmin -a -u tlrtcfile -p tlrtcfile -r 你的域名`    
+    启动turnserver  `turnserver -c /etc/turnserver.conf`
 
-    docker build -t iamtsm/tl-rtc-file .
+    可参考示例模板 : `bin/turnStart.sh`
 
-    docker run -p 9092:9092 -p 8444:8444 --name local -d iamtsm/tl-rtc-file
 
-    访问 : http://localhost:9092 或者 http://本机ip:9092
+## Docker (非必须步骤)
 
-## 管理后台
+    按需配置conf.json中的ws, 或者wss (需要填容器的ip，端口信息)
 
-    前提 ： 需要开启数据库配置
+    docker build -t tl-open-source/tl-rtc-file .
 
-    修改conf/cfg.json中的manage的room和password，默认房间号和密码都是tlrtcfile
+    docker run -p 9092:9092 -p 8444:8444 --name tl-rtc-file-local -d tl-open-source/tl-rtc-file
 
     访问 : http://localhost:9092 或者 http://本机ip:9092
 
-    输入配置的房间号，输入密码，即可进入管理后台
+## 管理后台 (非必须步骤)
+
+前提 ： 需要开启数据库配置
 
-    ps : 如有需要配置企业微信通知，修改conf/cfg.json中的notify的qiwei数组，填入企业微信机器人的key即可
+修改cfg.json中的manage的room和password，默认房间号和密码都是tlrtcfile
 
-## Chat-GPT
+    访问 : http://localhost:9092 或者 http://本机ip:9092
+
+    输入配置的房间号，输入密码，即可进入管理后台
 
-    修改conf/cfg.json中的openai.apiKeys，填写你自己openai账号生成的apiKey
+    "manage": {
+		"room": "tlrtcfile",
+		"password": "tlrtcfile"
+	},
+
+## 企微通知 (非必须步骤)
+
+修改cfg.json中的notify的qiwei数组，填入企业微信机器人的key即可
+
+normal : 正常通知, error : 系统报错通知
+
+    "notify": {
+        "open": true,  #是否开启企业微信通知
+        "qiwei": {
+            "normal" : [
+                "key1",
+                "key2"
+            ],
+            "error" : [
+                "key3",
+                "key4"
+            ]
+        }
+    },
+
+## OSS云存储 (非必须步骤)
+
+修改cfg.json中的oss
+
+    "oss": {
+		"seafile": {
+			"repoid": "",
+			"host": "",
+			"username": "帐号",
+			"password": "密码"
+		},
+		"alyun": {
+			"AccessKey": "",
+			"SecretKey": "",
+			"bucket": "tl-rtc-file"
+		},
+		"txyun": {
+			"AccessKey": "",
+			"SecretKey": "",
+			"bucket": "tl-rtc-file"
+		},
+		"qiniuyun": {
+			"AccessKey": "",
+			"SecretKey": "",
+			"bucket": "tl-rtc-file"
+		}
+	},
+
+## Chat-GPT (非必须步骤)
+
+修改cfg.json中的openai.apiKeys，填写你自己openai账号生成的apiKey
+
+    "openai": {
+		"apiKeys": [
+			
+		]
+	},
 
 ## 概述图
 
 ![image](doc/tl-rtc-file-tool.jpg)
 
 ## License
 
-MIT License
-
-Copyright (c) 2022 iamtsm
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-
+### MIT License Copyright (c) 2022 iamtsm
 
 ## 免责声明