Merge remote-tracking branch 'origin/main'

3 years ago · e2c53754b5
parent f328ebc300 094911bab2
commit e2c53754b5
3 changed files with 68 additions and 69 deletions
--- a/README.md
+++ b/README.md
@ -26,7 +26,6 @@ By deployment of the Open-IM-Server on the customer's server, developers can int
 - Supports multiple protocols

 ## Community
-
 - 中文官网访问这里：[Open-IM中文开发文档](https://doc.rentsoft.cn/)

 ## Quick start
--- a/config/config.yaml
+++ b/config/config.yaml
@ -115,11 +115,11 @@ sdk:
 #对象存储服务，以下配置二选一，目前支持两种，腾讯云和minio，二者配置好其中一种即可（如果使用minio参考https://doc.rentsoft.cn/#/qa/minio搭建minio服务器）
 credential: #腾讯cos，发送图片、视频、文件时需要，请自行申请后替换，必须修改
  tencent:
-    appID:  
-    region:  
-    bucket:  
-    secretID:  
-    secretKey:  
+    appID:
+    region:
+    bucket:
+    secretID:
+    secretKey:
  minio: #MinIO 发送图片、视频、文件时需要，请自行申请后替换，必须修改。 客户端初始化InitSDK，中 object_storage参数为minio
    bucket: openim # 存储内容桶
    appBucket: app # 存储app的桶
@ -132,23 +132,23 @@ credential: #腾讯cos，发送图片、视频、文件时需要，请自行申
    storageTime: 50 #文件在minio中保存的时间
    isDistributedMod: false # 是否分布式多硬盘部署 默认docker-compose中为false
  ali: # ali oss
-    regionID:  
-    accessKeyID:  
-    accessKeySecret:  
-    stsEndpoint:  
-    ossEndpoint:  
-    bucket: 
-    finalHost:  
-    stsDurationSeconds:  
-    OssRoleArn:  
+    regionID:
+    accessKeyID:
+    accessKeySecret:
+    stsEndpoint:
+    ossEndpoint:
+    bucket:
+    finalHost:
+    stsDurationSeconds:
+    OssRoleArn:
  aws:
-    accessKeyID:                         #AssumeRole用户关联的accessKeyID
-    accessKeySecret:     #AssumeRole用户关联的accessKeySecrect
-    region:                                          #分区
-    bucket:                                                  #桶
-    finalHost:              #对外Host
-    roleArn:      #RoleArn
-    externalId:                                    #角色扩展Id
+    accessKeyID:                            #AssumeRole用户关联的accessKeyID
+    accessKeySecret:                        #AssumeRole用户关联的accessKeySecrect
+    region:                                 #分区
+    bucket:                                 #桶
+    finalHost:                              #对外Host
+    roleArn:                                #RoleArn
+    externalId:                             #角色扩展Id
    roleSessionName:                        #角色SESSION名称


@ -216,17 +216,17 @@ longconnsvr:
 push:
  tpns: #腾讯推送，暂未测试 暂不要使用
    ios:
-      accessID:  
-      secretKey:  
+      accessID:
+      secretKey:
    android:
-      accessID:  
-      secretKey:  
+      accessID:
+      secretKey:
    enable: false # true or false (bool)
  jpns: #极光推送 在极光后台申请后，修改以下四项，必须修改
-    appKey:  
-    masterSecret:  
-    pushUrl:  
-    pushIntent:  
+    appKey:
+    masterSecret:
+    pushUrl:
+    pushIntent:
    enable: false # true or false (bool)
  getui:  #个推推送
    pushUrl: 
@ -241,9 +241,9 @@ push:
    enable: false
  mob:  #袤博推送
    appKey:   #帐号文件，此处需要改修配置，并且这个文件放在 config目录下
-    pushUrl:  
-    scheme:  
-    appSecret: 
+    pushUrl:
+    scheme:
+    appSecret:
    enable: false


@ -765,18 +765,18 @@ demo:
  #demo对外服务端口，默认即可，需要开放此端口或做nginx转发
  openImDemoPort: [ 10004 ]
  alismsverify: #阿里云短信配置，在阿里云申请成功后修改以下四项，enable为true则必须修改，阿里云为默认短信验证方式
-    accessKeyId:  
-    accessKeySecret:  
-    signName:  
-    verificationCodeTemplateCode:  
+    accessKeyId:
+    accessKeySecret:
+    signName:
+    verificationCodeTemplateCode:
    enable: false
  tencentsms: #腾讯云短信配置，在腾讯云申请成功后，修改以下选项，enable为true则必须修改
-    appID:   
-    region:  
-    secretID:  
-    secretKey:  
-    signName:  
-    verificationCodeTemplateCode:  
+    appID:
+    region:
+    secretID:
+    secretKey:
+    signName:
+    verificationCodeTemplateCode:
    enable: true
  superCode: 666666 #超级验证码，建议修改掉，收不到短信验证码时可以用此替代
  needInvitationCode: false
@ -784,10 +784,10 @@ demo:
  codeTTL: 60
  useSuperCode: true
  mail: #仅支持qq邮箱，具体操作参考 https://service.mail.qq.com/cgi-bin/help?subtype=1&id=28&no=1001256 必须修改
-    title:  
-    senderMail:  
-    senderAuthorizationCode:  
-    smtpAddr:  
+    title:
+    senderMail:
+    senderAuthorizationCode:
+    smtpAddr:
    smtpPort:     #需开放此端口 出口方向
  testDepartMentID: 001
  imAPIURL: http://127.0.0.1:10002
--- a/deploy/config.example.yaml
+++ b/deploy/config.example.yaml
@ -79,11 +79,11 @@ cmsapi:

 credential:
  tencent:
-    appID: 1302656840
-    region: ap-chengdu
-    bucket: echat-1302656840
-    secretID: AKIDGNYVChzIQinu7QEgtNp0hnNgqcV8vZTC
-    secretKey: kz15vW83qM6dBUWIq681eBZA0c0vlIbe
+    appID:  
+    region:    
+    bucket:  
+    secretID:  
+    secretKey:  


 rpcport:
@ -131,16 +131,16 @@ longconnsvr:
 push:
  tpns:
    ios:
-      accessID: 1600018281
-      secretKey: 3cd68a77a95b89e5089a1aca523f318f
+      accessID:  
+      secretKey:  
    android:
-      accessID: 111
-      secretKey: 111
+      accessID:  
+      secretKey:  
  jpns:
-    appKey: cf47465a368f24c659608e7e
-    masterSecret: 02204efe3f3832947a236ee5
-    pushUrl: "https://api.jpush.cn/v3/push"
-    pushIntent: "intent:#Intent;component=io.openim.app.enterprisechat/io.openim.app.enterprisechat.MainActivity;end"
+    appKey:  
+    masterSecret:  
+    pushUrl:  
+    pushIntent:  
 manager:
  appManagerUid: ["openIM123456","openIM654321"]
  secrets: ["openIM1","openIM2"]
@ -168,16 +168,16 @@ demoswitch: true
 demo:
  openImDemoPort: [ 42233 ]
  alismsverify:
-    accessKeyId: LTAI5tJPkn4HuuePdiLdGqe71
-    accessKeySecret: 4n9OJ7ZCVN1U6KeHDAtOyNeVZcjOuV1
-    signName: OpenIM Corporation
-    verificationCodeTemplateCode: SMS_2268101641
+    accessKeyId:  
+    accessKeySecret:  
+    signName:    
+    verificationCodeTemplateCode:  
  superCode: 666666
  mail:
-    title: "openIM"
-    senderMail: "1765567899@qq.com"
-    senderAuthorizationCode: "1gxyausfoevlzbfag"
-    smtpAddr: "smtp.qq.com"
-    smtpPort: 25
+    title:  
+    senderMail:  
+    senderAuthorizationCode: 
+    smtpAddr:  
+    smtpPort: