blackteay/open-im-server
1
0
Fork 0
mirror of https://github.com/openimsdk/open-im-server.git synced 2025-04-06 04:15:46 +08:00
Code Issues Packages Projects Releases Wiki Activity

config description

Browse Source
This commit is contained in:
wenxu12345 2022-02-23 18:22:44 +08:00
parent 188ca8fc58
commit 0fca91ca37
2 changed files with 65 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
cmd/Open-IM-SDK-Core

@ -1 +1 @@
Subproject commit 23f31958dae08260c5f9631f4937389a8e2d6751 Subproject commit 992f76df0ee500a0377523b0780d3a85f2275755

125
config/config.yaml
View File

@ -4,44 +4,44 @@
serverversion: 2.0.0 serverversion: 2.0.0
#---------------Infrastructure configuration---------------------# #---------------Infrastructure configuration---------------------#
etcd: etcd:
etcdSchema: openIM etcdSchema: openIM #默认即可
etcdAddr: [ 127.0.0.1:2379 ] etcdAddr: [ 127.0.0.1:2379 ] #单机部署时，默认即可
mysql: mysql:
dbMysqlAddress: [ 127.0.0.1:13306 ] dbMysqlAddress: [ 127.0.0.1:13306 ] #mysql地址 目前仅支持单机，默认即可
dbMysqlUserName: root dbMysqlUserName: root #mysql用户名，建议修改
dbMysqlPassword: openIM dbMysqlPassword: openIM # mysql密码，建议修改
dbMysqlDatabaseName: openIM_v2 dbMysqlDatabaseName: openIM_v2 #默认即可
dbTableName: eMsg dbTableName: eMsg #默认即可
dbMsgTableNum: 1 dbMsgTableNum: 1
dbMaxOpenConns: 20 dbMaxOpenConns: 20
dbMaxIdleConns: 10 dbMaxIdleConns: 10
dbMaxLifeTime: 120 dbMaxLifeTime: 120
mongo: mongo:
dbAddress: [ 127.0.0.1:37017 ] dbAddress: [ 127.0.0.1:37017 ] #redis地址 目前仅支持单机，默认即可
dbDirect: false dbDirect: false
dbTimeout: 10 dbTimeout: 10
dbDatabase: openIM dbDatabase: openIM #mongo db 默认即可
dbSource: admin dbSource: admin
dbUserName: dbUserName: #mongo用户名，建议先不设置
dbPassword: dbPassword: #mongo密码，建议先不设置
dbMaxPoolSize: 20 dbMaxPoolSize: 20
dbRetainChatRecords: 7 dbRetainChatRecords: 3650 #mongo保存离线消息时间（天），根据需求修改
redis: redis:
dbAddress: 127.0.0.1:16379 dbAddress: 127.0.0.1:16379 #redis地址 目前仅支持单机，默认即可
dbMaxIdle: 128 dbMaxIdle: 128
dbMaxActive: 0 dbMaxActive: 0
dbIdleTimeout: 120 dbIdleTimeout: 120
dbPassWord: openIM dbPassWord: openIM #redis密码 建议修改
kafka: kafka:
ws2mschat: ws2mschat:
addr: [ 127.0.0.1:9092 ] addr: [ 127.0.0.1:9092 ] #kafka配置，默认即可
topic: "ws2ms_chat" topic: "ws2ms_chat"
ms2pschat: ms2pschat:
addr: [ 127.0.0.1:9092 ] addr: [ 127.0.0.1:9092 ] #kafka配置，默认即可
topic: "ms2ps_chat" topic: "ms2ps_chat"
consumergroupid: consumergroupid:
msgToMongo: mongo msgToMongo: mongo
@ -55,6 +55,7 @@ kafka:
# The service ip default is empty, # The service ip default is empty,
# automatically obtain the machine's valid network card ip as the service ip, # automatically obtain the machine's valid network card ip as the service ip,
# otherwise the configuration ip is preferred # otherwise the configuration ip is preferred
#如果是单机模式，用0.0.0.0或者不填，默认即可
serverip: 0.0.0.0 serverip: 0.0.0.0
# endpoints 内部组件间访问的端点host名称，访问时，可以内部直接访问 host:port 来访问 # endpoints 内部组件间访问的端点host名称，访问时，可以内部直接访问 host:port 来访问
@ -73,27 +74,28 @@ endpoints:
rpc_message_cms: openim_rpc_admin_cms rpc_message_cms: openim_rpc_admin_cms
api: api:
openImApiPort: [ 10000 ] openImApiPort: [ 10000 ] #api服务端口，默认即可，需要开放此端口或做nginx转发
cmsapi: cmsapi:
openImCmsApiPort: [ 8000 ] openImCmsApiPort: [ 8000 ] #管理后台api服务端口，默认即可，需要开放此端口或做nginx转发
sdk: sdk:
openImSdkWsPort: [ 30000 ] openImSdkWsPort: [ 30000 ] #jssdk服务端口，默认即可，项目中使用jssdk才需开放此端口或做nginx转发
credential: credential: #腾讯cos，发送图片、视频、文件时需要，请自行申请后替换，必须修改
tencent: tencent:
appID: 1302656840 appID: 1302656840
region: ap-chengdu region: ap-chengdu
bucket: echat-1302656840 bucket: echat-1302656840
secretID: AKIDGNYVChzIQinu7QEgtNp0hnNgqcV8vZTC secretID: AKIDGNYVChzIQinu7QEgtNp0hnNgqcV8vZTC
secretKey: kz15vW83qM6dBUWIq681eBZA0c0vlIbe secretKey: kz15vW83qM6dBUWIq681eBZA0c0vlIbe
minio: minio: #MinIO 发送图片、视频、文件时需要，请自行申请后替换，必须修改。 客户端初始化时相应改动
bucket: openim bucket: openim
location: us-east-1 location: us-east-1
endpoint: http://127.0.0.1:9000 endpoint: http://127.0.0.1:9000
accessKeyID: minioadmin accessKeyID: minioadmin
secretAccessKey: minioadmin secretAccessKey: minioadmin
rpcport:
rpcport: #rpc服务端口 默认即可
openImUserPort: [ 10100 ] openImUserPort: [ 10100 ]
openImFriendPort: [ 10200 ] openImFriendPort: [ 10200 ]
openImOfflineMessagePort: [ 10300 ] openImOfflineMessagePort: [ 10300 ]
@ -114,7 +116,7 @@ rpcport:
stateChange: stateChange:
switch: false switch: false
rpcregistername: rpcregistername: #rpc注册服务名，默认即可
openImUserName: User openImUserName: User
openImFriendName: Friend openImFriendName: Friend
openImOfflineMessageName: OfflineMessage openImOfflineMessageName: OfflineMessage
@ -129,57 +131,57 @@ rpcregistername:
log: log:
storageLocation: ../logs/ storageLocation: ../logs/
rotationTime: 24 rotationTime: 24
remainRotationCount: 5 remainRotationCount: 5 #日志数量
remainLogLevel: 6 remainLogLevel: 6 #日志级别 6表示全都打印，测试阶段建议设置为6
elasticSearchSwitch: false elasticSearchSwitch: false
elasticSearchAddr: [ 127.0.0.1:9201 ] elasticSearchAddr: [ 127.0.0.1:9201 ]
elasticSearchUser: "" elasticSearchUser: ""
elasticSearchPassword: "" elasticSearchPassword: ""
modulename: modulename: #日志文件按模块命名，默认即可
longConnSvrName: msg_gateway longConnSvrName: msg_gateway
msgTransferName: msg_transfer msgTransferName: msg_transfer
pushName: push pushName: push
longconnsvr: longconnsvr:
openImWsPort: [ 17778 ] openImWsPort: [ 17778 ] # ws服务端口，默认即可，要开放此端口或做nginx转发
websocketMaxConnNum: 10000 websocketMaxConnNum: 10000
websocketMaxMsgLen: 4096 websocketMaxMsgLen: 4096
websocketTimeOut: 10 websocketTimeOut: 10
push: push:
tpns: tpns: #腾讯推送，暂未测试 暂不要使用
ios: ios:
accessID: 1600018281 accessID: 1600018281
secretKey: 3cd68a77a95b89e5089a1aca523f318f secretKey: 3cd68a77a95b89e5089a1aca523f318f
android: android:
accessID: 111 accessID: 111
secretKey: 111 secretKey: 111
jpns: jpns: #极光推送 在极光后台申请后，修改以下四项，必须修改
appKey: cf47465a368f24c659608e7e appKey: cf47465a368f24c659608e7e
masterSecret: 02204efe3f3832947a236ee5 masterSecret: 02204efe3f3832947a236ee5
pushUrl: "https://api.jpush.cn/v3/push" pushUrl: "https://api.jpush.cn/v3/push"
pushIntent: "intent:#Intent;component=io.openim.app.enterprisechat/io.openim.app.enterprisechat.MainActivity;end" pushIntent: "intent:#Intent;component=io.openim.app.enterprisechat/io.openim.app.enterprisechat.MainActivity;end"
manager: manager:
#app管理员userID和对应的secret 建议修改。 用于管理后台登录，也可以用户管理后台对应的api
appManagerUid: [ "openIM123456","openIM654321", "openIM333", "openIMAdmin"] appManagerUid: [ "openIM123456","openIM654321", "openIM333", "openIMAdmin"]
secrets: [ "openIM1","openIM2", "openIM333", "openIMAdmin"] secrets: [ "openIM1","openIM2", "openIM333", "openIMAdmin"]
secret: tuoyun secret: tuoyun
# 多端互踢策略
# 1：多平台登录：Android、iOS、Windows、Mac 每种平台只能一个在线，web端可以多个同时在线
multiloginpolicy: 1 multiloginpolicy: 1
#token config #token config
tokenpolicy: tokenpolicy:
accessSecret: "open_im_server" accessSecret: "open_im_server" #token生成相关，默认即可
# Token effective time day as a unit # Token effective time day as a unit
accessExpire: 7 accessExpire: 3650 #token过期时间（天） 默认即可
messagecallback: messagecallback: #暂时不要使用 还需完善
callbackUrl: "http://www.xxx.com/msg/judge" callbackUrl: "http://www.xxx.com/msg/judge"
#TimeOut use second as unit #TimeOut use second as unit
callbackTimeOut: 10 callbackTimeOut: 10
messagejudge:
isJudgeFriend: true
# c2c: # c2c:
# callbackBeforeSendMsg: # callbackBeforeSendMsg:
# switch: false # switch: false
@ -189,7 +191,7 @@ messagejudge:
# state: # state:
# stateChange: # stateChange:
# switch: false # switch: false
#ios系统推送声音以及标记计数
iospush: iospush:
pushSound: "xxx" pushSound: "xxx"
badgeCount: true badgeCount: true
@ -253,7 +255,7 @@ notification:
desc: "groupApplicationAccepted desc" desc: "groupApplicationAccepted desc"
ext: "groupApplicationAccepted ext" ext: "groupApplicationAccepted ext"
defaultTips: defaultTips:
tips: "was allowed to join the group" # group info changed by xx tips: "allowed to join the group" # group info changed by xx
groupApplicationRejected: groupApplicationRejected:
conversation: conversation:
@ -265,7 +267,7 @@ notification:
desc: " desc" desc: " desc"
ext: " ext" ext: " ext"
defaultTips: defaultTips:
tips: "was rejected into the group" # group info changed by xx tips: "rejected into the group" # group info changed by xx
groupOwnerTransferred: groupOwnerTransferred:
conversation: conversation:
@ -289,7 +291,7 @@ notification:
desc: "memberKicked desc" desc: "memberKicked desc"
ext: "memberKicked ext" ext: "memberKicked ext"
defaultTips: defaultTips:
tips: "was kicked out of the group" # group info changed by xx tips: "kicked out of the group" # group info changed by xx
memberInvited: memberInvited:
conversation: conversation:
@ -301,7 +303,7 @@ notification:
desc: "memberInvited desc" desc: "memberInvited desc"
ext: "memberInvited ext" ext: "memberInvited ext"
defaultTips: defaultTips:
tips: "was invited into the group" # group info changed by xx tips: "invited into the group" # group info changed by xx
memberEnter: memberEnter:
conversation: conversation:
@ -378,11 +380,11 @@ notification:
unreadCount: false unreadCount: false
offlinePush: offlinePush:
switch: true switch: true
title: "Deleted a friend" title: "deleted a friend"
desc: "Deleted a friend" desc: "deleted a friend"
ext: "Deleted a friend" ext: "deleted a friend"
defaultTips: defaultTips:
tips: "Deleted a friend" # tips: "deleted a friend" #
friendRemarkSet: friendRemarkSet:
@ -405,11 +407,11 @@ notification:
unreadCount: false unreadCount: false
offlinePush: offlinePush:
switch: true switch: true
title: "Blocked a user" title: "blocked a user"
desc: "Blocked a user" desc: "blocked a user"
ext: "Blocked a user" ext: "blocked a user"
defaultTips: defaultTips:
tips: "Blocked a user" # tips: "blocked a user" #
blackDeleted: blackDeleted:
@ -435,7 +437,7 @@ notification:
desc: "Remove a blocked user" desc: "Remove a blocked user"
ext: "Remove a blocked user" ext: "Remove a blocked user"
defaultTips: defaultTips:
tips: "Remove a blocked user" tips: "remove a blocked user"
#####################conversation######################### #####################conversation#########################
conversationOptUpdate: conversationOptUpdate:
@ -454,23 +456,24 @@ notification:
#---------------demo configuration---------------------# #---------------demo configuration---------------------#
#The following configuration items are applied to openIM Demo configuration #The following configuration items are applied to openIM Demo configuration
#是否启动demo，如果自身没有账号体系，设置为true
demoswitch: true demoswitch: true
demo: demo:
openImDemoPort: [ 42233 ] openImDemoPort: [ 42233 ] #demo对外服务端口，默认即可，需要开放此端口或做nginx转发
alismsverify: alismsverify: #阿里云短信配置，在阿里云申请成功后修改以下四项，必须修改
accessKeyId: LTAI5tJPkn4HuuePdiLdGqe7 accessKeyId: LTAI5tJPkn4HuuePdiLdGqe71
accessKeySecret: 4n9OJ7ZCVN1U6KeHDAtOyNeVZcjOuV accessKeySecret: 4n9OJ7ZCVN1U6KeHDAtOyNeVZcjOuV1
signName: 托云信息技术 signName: OpenIM Corporation
verificationCodeTemplateCode: SMS_226810164 verificationCodeTemplateCode: SMS_2268101641
superCode: 666666 superCode: 666666 #超级验证码，建议修改掉，收不到短信验证码时可以用此替代
# second # second
codeTTL: 300 codeTTL: 60
mail: mail: #仅支持qq邮箱，具体操作参考 https://service.mail.qq.com/cgi-bin/help?subtype=1&id=28&no=1001256 必须修改
title: "openIM" title: "openIM"
senderMail: "765567899@qq.com" senderMail: "1765567899@qq.com"
senderAuthorizationCode: "gxyausfoevlzbfag" senderAuthorizationCode: "1gxyausfoevlzbfag"
smtpAddr: "smtp.qq.com" smtpAddr: "smtp.qq.com"
smtpPort: 25 smtpPort: 25 #需开放此端口 出口方向