msb-public
/
Open-IM-Server
mirror of https://github.com/OpenIMSDK/Open-IM-Server
2
0
Code Issues Projects Releases Wiki Activity

Merge branch 'OpenIMSDK:main' into main

Browse Source
pull/329/head
sanmingting 3 years ago committed by GitHub
parent 50f3b9b42a c80b625977
commit adab1c6289
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 67 additions and 69 deletions
Show Stats Download Patch File Download Diff File

2
README.md
Unescape View File

@ -26,8 +26,6 @@ By deployment of the Open-IM-Server on the customer's server, developers can int
- Supports multiple protocols - Supports multiple protocols
## Community ## Community
- Join Slack Community : https://join.slack.com/t/openimcommunity/shared_invite/zt-1jo5m1wm9-ym2qj0LUU5UbO68L6Z1zQg
- 中文官网访问这里：[Open-IM中文开发文档](https://doc.rentsoft.cn/) - 中文官网访问这里：[Open-IM中文开发文档](https://doc.rentsoft.cn/)
## Quick start ## Quick start

88
config/config.yaml
Unescape View File

@ -115,11 +115,11 @@ sdk:
#对象存储服务，以下配置二选一，目前支持两种，腾讯云和minio，二者配置好其中一种即可（如果使用minio参考https://doc.rentsoft.cn/#/qa/minio搭建minio服务器） #对象存储服务，以下配置二选一，目前支持两种，腾讯云和minio，二者配置好其中一种即可（如果使用minio参考https://doc.rentsoft.cn/#/qa/minio搭建minio服务器）
credential: #腾讯cos，发送图片、视频、文件时需要，请自行申请后替换，必须修改 credential: #腾讯cos，发送图片、视频、文件时需要，请自行申请后替换，必须修改
tencent: tencent:
appID: 1302656840 appID:
region: ap-chengdu region:
bucket: echat-1302656840 bucket:
secretID: AKIDGNYVChzIQinu7QEgtNp0hnNgqcV8vZTC1 secretID:
secretKey: kz15vW83qM6dBUWIq681eBZA0c0vlIbe1 secretKey:
minio: #MinIO 发送图片、视频、文件时需要，请自行申请后替换，必须修改。 客户端初始化InitSDK，中 object_storage参数为minio minio: #MinIO 发送图片、视频、文件时需要，请自行申请后替换，必须修改。 客户端初始化InitSDK，中 object_storage参数为minio
bucket: openim # 存储内容桶 bucket: openim # 存储内容桶
appBucket: app # 存储app的桶 appBucket: app # 存储app的桶
@ -132,24 +132,24 @@ credential: #腾讯cos，发送图片、视频、文件时需要，请自行申
storageTime: 50 #文件在minio中保存的时间 storageTime: 50 #文件在minio中保存的时间
isDistributedMod: false # 是否分布式多硬盘部署 默认docker-compose中为false isDistributedMod: false # 是否分布式多硬盘部署 默认docker-compose中为false
ali: # ali oss ali: # ali oss
regionID: "oss-cn-beijing" regionID:
accessKeyID: "" accessKeyID: ""
accessKeySecret: "" accessKeySecret: ""
stsEndpoint: "sts.cn-beijing.aliyun.com" stsEndpoint:
ossEndpoint: "oss-cn-beijing.aliyuncs.com" ossEndpoint:
bucket: "bucket1" bucket:
finalHost: "http://bucket1.oss-cn-beijing.aliyuncs.com" finalHost:
stsDurationSeconds: 3600 stsDurationSeconds: 3600
OssRoleArn: "acs:ram::xxx:role/xxx" OssRoleArn: "acs:ram::xxx:role/xxx"
aws: aws:
accessKeyID: 1 #AssumeRole用户关联的accessKeyID accessKeyID: #AssumeRole用户关联的accessKeyID
accessKeySecret: 2 #AssumeRole用户关联的accessKeySecrect accessKeySecret: #AssumeRole用户关联的accessKeySecrect
region: ap-southeast-1 #分区 region: #分区
bucket: ouyang #桶 bucket: #桶
finalHost: ouyang.s3.ap-southeast-1.amazonaws.com #对外Host finalHost: #对外Host
roleArn: arn:aws:iam::192209831083:role/AWS_S3_FOR_OUYANG #RoleArn roleArn: #RoleArn
externalId: AssumeRoleExtend #角色扩展Id externalId: #角色扩展Id
roleSessionName: Required-AWS-ID-OPENIM #角色SESSION名称 roleSessionName: #角色SESSION名称
rpcport: #rpc服务端口 默认即可 rpcport: #rpc服务端口 默认即可
@ -216,17 +216,17 @@ longconnsvr:
push: push:
tpns: #腾讯推送，暂未测试 暂不要使用 tpns: #腾讯推送，暂未测试 暂不要使用
ios: ios:
accessID: 1600018281 accessID:
secretKey: 3cd68a77a95b89e5089a1aca523f318f secretKey:
android: android:
accessID: 111 accessID: 111
secretKey: 111 secretKey: 111
enable: false # true or false (bool) enable: false # true or false (bool)
jpns: #极光推送 在极光后台申请后，修改以下四项，必须修改 jpns: #极光推送 在极光后台申请后，修改以下四项，必须修改
appKey: cf47465a368f24c659608e7e appKey:
masterSecret: 02204efe3f3832947a236ee5 masterSecret:
pushUrl: "https://api.jpush.cn/v3/push" pushUrl:
pushIntent: "intent:#Intent;component=io.openim.app.enterprisechat/io.openim.app.enterprisechat.MainActivity;end" pushIntent:
enable: false # true or false (bool) enable: false # true or false (bool)
getui: #个推推送 getui: #个推推送
pushUrl: pushUrl:
@ -237,13 +237,13 @@ push:
channelID: "" channelID: ""
channelName: "" channelName: ""
fcm: #firebase cloud message 消息推送 fcm: #firebase cloud message 消息推送
serviceAccount: "openim-5c6c0-firebase-adminsdk-ppwol-8765884a78.json" #帐号文件，此处需要改修配置，并且这个文件放在 config目录下 serviceAccount: #帐号文件，此处需要改修配置，并且这个文件放在 config目录下
enable: false enable: false
mob: #袤博推送 mob: #袤博推送
appKey: "3377f689a25" #帐号文件，此处需要改修配置，并且这个文件放在 config目录下 appKey: #帐号文件，此处需要改修配置，并且这个文件放在 config目录下
pushUrl: "https://api.push.mob.com/v3/push/createPush" pushUrl:
scheme: "dianzhijiaunilinks://dianzhijia.com?page=rent" scheme:
appSecret: "77b4e20e94db3a776b87d8693be23e" appSecret:
enable: false enable: false
@ -765,18 +765,18 @@ demo:
#demo对外服务端口，默认即可，需要开放此端口或做nginx转发 #demo对外服务端口，默认即可，需要开放此端口或做nginx转发
openImDemoPort: [ 10004 ] openImDemoPort: [ 10004 ]
alismsverify: #阿里云短信配置，在阿里云申请成功后修改以下四项，enable为true则必须修改，阿里云为默认短信验证方式 alismsverify: #阿里云短信配置，在阿里云申请成功后修改以下四项，enable为true则必须修改，阿里云为默认短信验证方式
accessKeyId: LTAI5tJPkn4HuuePdiLdGqe7 accessKeyId:
accessKeySecret: 4n9OJ7ZCVN1U6KeHDAtOyNeVZcjOuV accessKeySecret:
signName: 托云信息技术 signName:
verificationCodeTemplateCode: SMS_226810164 verificationCodeTemplateCode:
enable: false enable: false
tencentsms: #腾讯云短信配置，在腾讯云申请成功后，修改以下选项，enable为true则必须修改 tencentsms: #腾讯云短信配置，在腾讯云申请成功后，修改以下选项，enable为true则必须修改
appID: 2400000648 appID:
region: "ap-singapore" region:
secretID: IKIDra4JPGsFMDwQedMq42lESQBgwwgBQQAe secretID:
secretKey: HI6fz4uUotjJdiX6QUIrAE2buxlKdgU2 secretKey:
signName: "" signName:
verificationCodeTemplateCode: 2902877 verificationCodeTemplateCode:
enable: true enable: true
superCode: 666666 #超级验证码，建议修改掉，收不到短信验证码时可以用此替代 superCode: 666666 #超级验证码，建议修改掉，收不到短信验证码时可以用此替代
needInvitationCode: false needInvitationCode: false
@ -784,11 +784,11 @@ demo:
codeTTL: 60 codeTTL: 60
useSuperCode: true useSuperCode: true
mail: #仅支持qq邮箱，具体操作参考 https://service.mail.qq.com/cgi-bin/help?subtype=1&id=28&no=1001256 必须修改 mail: #仅支持qq邮箱，具体操作参考 https://service.mail.qq.com/cgi-bin/help?subtype=1&id=28&no=1001256 必须修改
title: "openIM" title:
senderMail: "765567899@qq.com" senderMail:
senderAuthorizationCode: "gxyausfoevlzbfag" senderAuthorizationCode:
smtpAddr: "smtp.qq.com" smtpAddr:
smtpPort: 25 #需开放此端口 出口方向 smtpPort: #需开放此端口 出口方向
testDepartMentID: 001 testDepartMentID: 001
imAPIURL: http://127.0.0.1:10002 imAPIURL: http://127.0.0.1:10002
onboardProcess: false # 是否开启注册流程 onboardProcess: false # 是否开启注册流程

44
deploy/config.example.yaml
Unescape View File

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

Write Preview
Loading…
Cancel
Save