diff --git a/config/config.yaml b/config/config.yaml index c9b800b0f..abe17144a 100644 --- a/config/config.yaml +++ b/config/config.yaml @@ -1,60 +1,59 @@ # The class cannot be named by Pascal or camel case. # If it is not used, the corresponding structure will not be set, # and it will not be read naturally. -serverversion: 1.0.3 +serverversion: 3.0.0 #---------------Infrastructure configuration---------------------# etcd: - etcdSchema: openIM - etcdAddr: [ 127.0.0.1:2379 ] + etcdSchema: openIM #默认即可 + etcdAddr: [127.0.0.1:2379] #单机部署时，默认即可 mysql: - dbMysqlAddress: [ 127.0.0.1:13306 ] - dbMysqlUserName: root - dbMysqlPassword: openIM - dbMysqlDatabaseName: openIM - dbTableName: eMsg + dbMysqlAddress: [127.0.0.1:13306] #mysql地址 目前仅支持单机，默认即可 + dbMysqlUserName: root #mysql用户名，建议修改 + dbMysqlPassword: openIM # mysql密码，建议修改 + dbMysqlDatabaseName: openIM #默认即可 + dbTableName: eMsg #默认即可 dbMsgTableNum: 1 dbMaxOpenConns: 20 dbMaxIdleConns: 10 dbMaxLifeTime: 120 mongo: - dbAddress: [ 127.0.0.1:37017 ] + dbAddress: [127.0.0.1:37017] #redis地址 目前仅支持单机，默认即可 dbDirect: false dbTimeout: 10 - dbDatabase: openIM + dbDatabase: openIM #mongo db 默认即可 dbSource: admin - dbUserName: - dbPassword: + dbUserName: #mongo用户名，建议修改 + dbPassword: #mongo密码，建议修改 dbMaxPoolSize: 20 - dbRetainChatRecords: 7 + dbRetainChatRecords: 3650 #mongo保存离线消息时间（天） redis: - dbAddress: 127.0.0.1:16379 + dbAddress: 127.0.0.1:16379 #redis地址 目前仅支持单机，默认即可 dbMaxIdle: 128 dbMaxActive: 0 dbIdleTimeout: 120 - dbPassWord: openIM + dbPassWord: openIM #redis密码 建议修改 kafka: ws2mschat: - addr: [ 127.0.0.1:9092 ] + addr: [127.0.0.1:9092] #kafka配置，默认即可 topic: "ws2ms_chat" ms2pschat: - addr: [ 127.0.0.1:9092 ] + addr: [127.0.0.1:9092] #kafka配置，默认即可 topic: "ms2ps_chat" consumergroupid: msgToMongo: mongo msgToMySql: mysql msgToPush: push - - #---------------Internal service configuration---------------------# # The service ip default is empty, # automatically obtain the machine's valid network card ip as the service ip, # otherwise the configuration ip is preferred +#如果是单机模式，用0.0.0.0或者不填，默认即可 serverip: 0.0.0.0 # endpoints 内部组件间访问的端点host名称，访问时，可以内部直接访问 host:port 来访问 @@ -73,13 +72,13 @@ endpoints: rpc_message_cms: openim_rpc_admin_cms api: - openImApiPort: [ 10000 ] + openImApiPort: [10000] #api服务端口，默认即可，注意开放此端口或做nginx转发 cmsapi: - openImCmsApiPort: [ 8000 ] + openImCmsApiPort: [8000] #管理后台api服务端口，默认即可，注意开放此端口或做nginx转发 sdk: - openImSdkWsPort: [ 30000 ] + openImSdkWsPort: [30000] #jssdk服务端口，默认即可，项目中使用jssdk才需开放此端口或做nginx转发 -credential: +credential: #腾讯cos，发送图片、视频、文件时需要，请自行申请后替换，必须修改 tencent: appID: 1302656840 region: ap-chengdu @@ -93,17 +92,17 @@ credential: accessKeyID: minioadmin secretAccessKey: minioadmin -rpcport: - openImUserPort: [ 10100 ] - openImFriendPort: [ 10200 ] - openImOfflineMessagePort: [ 10300 ] - openImOnlineRelayPort: [ 10400 ] - openImGroupPort: [ 10500 ] - openImAuthPort: [ 10600 ] - openImPushPort: [ 10700 ] - openImStatisticsPort: [ 10800 ] - openImMessageCmsPort: [ 10900 ] - openImAdminCmsPort: [ 11000 ] +rpcport: #rpc服务端口 默认即可 + openImUserPort: [10100] + openImFriendPort: [10200] + openImOfflineMessagePort: [10300] + openImOnlineRelayPort: [10400] + openImGroupPort: [10500] + openImAuthPort: [10600] + openImPushPort: [10700] + openImStatisticsPort: [10800] + openImMessageCmsPort: [10900] + openImAdminCmsPort: [11000] c2c: callbackBeforeSendMsg: switch: false @@ -114,7 +113,7 @@ rpcport: stateChange: switch: false -rpcregistername: +rpcregistername: #rpc注册服务名，默认即可 openImUserName: User openImFriendName: Friend openImOfflineMessageName: OfflineMessage @@ -129,52 +128,54 @@ rpcregistername: log: storageLocation: ../logs/ rotationTime: 24 - remainRotationCount: 5 - remainLogLevel: 6 + remainRotationCount: 5 #日志数量 + remainLogLevel: 6 #日志级别 6表示全都打印，测试阶段建议设置为6 elasticSearchSwitch: false - elasticSearchAddr: [ 127.0.0.1:9201 ] + elasticSearchAddr: [127.0.0.1:9201] elasticSearchUser: "" elasticSearchPassword: "" -modulename: +modulename: #日志文件按模块命名，默认即可 longConnSvrName: msg_gateway msgTransferName: msg_transfer pushName: push longconnsvr: - openImWsPort: [ 17778 ] + openImWsPort: [17778] # ws服务端口，默认即可，要开放此端口或做nginx转发 websocketMaxConnNum: 10000 websocketMaxMsgLen: 4096 websocketTimeOut: 10 push: - tpns: + tpns: #腾讯推送，暂未测试 暂不要使用 ios: accessID: 1600018281 secretKey: 3cd68a77a95b89e5089a1aca523f318f android: accessID: 111 secretKey: 111 - jpns: + 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" manager: - appManagerUid: [ "openIM123456","openIM654321", "openIM333", "openIMAdmin"] - secrets: [ "openIM1","openIM2", "openIM333", "openIMAdmin"] + #app管理员userID和对应的secret 建议修改。 用于管理后台登录，也可以用户管理后台对应的api + appManagerUid: ["openIM123456", "openIM654321", "openIM333", "openIMAdmin"] + secrets: ["openIM1", "openIM2", "openIM333", "openIMAdmin"] secret: tuoyun - +# 多端互踢策略 +# 1：多平台登录：Android、iOS、Windows、Mac 每种平台只能一个在线，web端可以多个同时在线 multiloginpolicy: 1 #token config tokenpolicy: - accessSecret: "open_im_server" + accessSecret: "open_im_server" #token生成相关，默认即可 # Token effective time day as a unit - accessExpire: 7 + accessExpire: 3650 #token过期时间（天） -messagecallback: +messagecallback: #暂时不要使用 还需完善 callbackUrl: "http://www.xxx.com/msg/judge" #TimeOut use second as unit callbackTimeOut: 10 @@ -189,7 +190,7 @@ messagejudge: # state: # stateChange: # switch: false - +#ios系统推送声音以及标记计数 iospush: pushSound: "xxx" badgeCount: true @@ -205,7 +206,7 @@ notification: desc: "create group desc" ext: "create group ext" defaultTips: - tips: "create the group" # xx create the group + tips: "create the group" # xx create the group groupInfoSet: conversation: @@ -217,7 +218,7 @@ notification: desc: "groupInfoSet desc" ext: "groupInfoSet ext" defaultTips: - tips: "modified the group profile" # group info changed by xx + tips: "modified the group profile" # group info changed by xx joinGroupApplication: conversation: @@ -229,7 +230,7 @@ notification: desc: "joinGroupApplication desc" ext: "joinGroupApplication ext" defaultTips: - tips: "apply to join the group" # group info changed by xx + tips: "apply to join the group" # group info changed by xx memberQuit: conversation: @@ -241,7 +242,7 @@ notification: desc: "memberQuit desc" ext: "memberQuit ext" defaultTips: - tips: "quit group chat" # group info changed by xx + tips: "quit group chat" # group info changed by xx groupApplicationAccepted: conversation: @@ -253,7 +254,7 @@ notification: desc: "groupApplicationAccepted desc" ext: "groupApplicationAccepted ext" 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: conversation: @@ -265,7 +266,7 @@ notification: desc: " desc" ext: " ext" defaultTips: - tips: "was rejected into the group" # group info changed by xx + tips: "rejected into the group" # group info changed by xx groupOwnerTransferred: conversation: @@ -277,7 +278,7 @@ notification: desc: "groupOwnerTransferred desc" ext: "groupOwnerTransferred ext" defaultTips: - tips: "become a new group owner" # group info changed by xx + tips: "become a new group owner" # group info changed by xx memberKicked: conversation: @@ -289,7 +290,7 @@ notification: desc: "memberKicked desc" ext: "memberKicked ext" 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: conversation: @@ -301,7 +302,7 @@ notification: desc: "memberInvited desc" ext: "memberInvited ext" defaultTips: - tips: "was invited into the group" # group info changed by xx + tips: "invited into the group" # group info changed by xx memberEnter: conversation: @@ -313,7 +314,7 @@ notification: desc: "memberEnter desc" ext: "memberEnter ext" defaultTips: - tips: "entered the group" # group info changed by xx + tips: "entered the group" # group info changed by xx #############################friend################################# @@ -327,7 +328,7 @@ notification: desc: "Somebody applies to add you as a friend" ext: "Somebody applies to add you as a friend" defaultTips: - tips: "I applies to add you as a friend" # + tips: "I applies to add you as a friend" # friendApplicationApproved: conversation: @@ -339,8 +340,7 @@ notification: desc: "Someone applies to add your friend application" ext: "Someone applies to add your friend application" defaultTips: - tips: "I applies to add your friend application" # - + tips: "I applies to add your friend application" # friendApplicationRejected: conversation: @@ -352,11 +352,7 @@ notification: desc: "Someone rejected your friend application" ext: "Someone rejected your friend application" defaultTips: - tips: "I rejected your friend application" # - - - - + tips: "I rejected your friend application" # friendAdded: conversation: @@ -368,9 +364,7 @@ notification: desc: "We have become friends" ext: "We have become friends" defaultTips: - tips: "We have become friends" # - - + tips: "We have become friends" # friendDeleted: conversation: @@ -378,12 +372,11 @@ notification: unreadCount: false offlinePush: switch: true - title: "Deleted a friend" - desc: "Deleted a friend" - ext: "Deleted a friend" + title: "deleted a friend" + desc: "deleted a friend" + ext: "deleted a friend" defaultTips: - tips: "Deleted a friend" # - + tips: "deleted a friend" # friendRemarkSet: conversation: @@ -395,9 +388,7 @@ notification: desc: "Your friend's profile has been changed" ext: "Your friend's profile has been changed" defaultTips: - tips: "Your friend's profile has been changed" # - - + tips: "Your friend's profile has been changed" # blackAdded: conversation: @@ -405,12 +396,11 @@ notification: unreadCount: false offlinePush: switch: true - title: "Blocked a user" - desc: "Blocked a user" - ext: "Blocked a user" + title: "blocked a user" + desc: "blocked a user" + ext: "blocked a user" defaultTips: - tips: "Blocked a user" # - + tips: "blocked a user" # blackDeleted: conversation: @@ -435,7 +425,7 @@ notification: desc: "Remove a blocked user" ext: "Remove a blocked user" defaultTips: - tips: "Remove a blocked user" + tips: "remove a blocked user" #####################conversation######################### conversationOptUpdate: @@ -450,27 +440,23 @@ notification: defaultTips: tips: "conversation opt update" - - #---------------demo configuration---------------------# #The following configuration items are applied to openIM Demo configuration -demoswitch: true +demoswitch: true #是否启动demo，如果自身没有账号体系，设置为true demo: - openImDemoPort: [ 42233 ] - alismsverify: + openImDemoPort: [42233] #demo对外服务端口，默认即可，需要开放此端口或做nginx转发 + alismsverify: #阿里云短信配置，在阿里云申请成功后修改以下四项，必须修改 accessKeyId: LTAI5tJPkn4HuuePdiLdGqe71 accessKeySecret: 4n9OJ7ZCVN1U6KeHDAtOyNeVZcjOuV1 signName: OpenIM Corporation verificationCodeTemplateCode: SMS_2268101641 - superCode: 666666 + superCode: 666666 #超级验证码，建议修改掉，收不到短信验证码时可以用此替代 # second codeTTL: 60 - mail: + mail: #仅支持qq邮箱，具体操作参考 https://service.mail.qq.com/cgi-bin/help?subtype=1&id=28&no=1001256 必须修改 title: "openIM" senderMail: "1765567899@qq.com" senderAuthorizationCode: "1gxyausfoevlzbfag" smtpAddr: "smtp.qq.com" - smtpPort: 25 - - + smtpPort: 25 #需开放此端口 出口方向