Files
open-im-server/config/config.yaml
T

834 lines
24 KiB
YAML
Raw Normal View History

2021-05-26 18:47:52 +08:00
# The class cannot be named by Pascal or camel case.
2022-06-02 18:17:11 +08:00
# The class cannot be named by Pascal or camel case.
2021-05-26 18:47:52 +08:00
# If it is not used, the corresponding structure will not be set,
# and it will not be read naturally.
2022-08-24 18:12:18 +08:00
serverversion: 2.3.1
2021-05-26 18:47:52 +08:00
#---------------Infrastructure configuration---------------------#
etcd:
2022-05-07 09:34:49 +08:00
etcdSchema: openim #默认即可
2022-02-23 18:22:44 +08:00
etcdAddr: [ 127.0.0.1:2379 ] #单机部署时,默认即可
2022-09-16 11:57:01 +08:00
userName:
2022-09-16 15:11:13 +08:00
password:
2022-11-14 15:37:32 +08:00
secret:
2021-11-29 11:25:57 +08:00
2021-05-26 18:47:52 +08:00
mysql:
2022-03-02 19:07:17 +08:00
dbMysqlAddress: [ 127.0.0.1:13306 ] #mysql地址 目前仅支持单机,默认即可
2022-11-10 14:51:35 +08:00
dbMysqlUserName: #mysql用户名,建议修改
dbMysqlPassword: # mysql密码,建议修改
2022-02-23 18:22:44 +08:00
dbMysqlDatabaseName: openIM_v2 #默认即可
dbTableName: eMsg #默认即可
2021-05-26 18:47:52 +08:00
dbMsgTableNum: 1
2022-08-30 21:22:14 +08:00
dbMaxOpenConns: 100
dbMaxIdleConns: 10
dbMaxLifeTime: 5
2022-09-14 17:45:38 +08:00
logLevel: 1 #1=slient 2=error 3=warn 4=info
slowThreshold: 500
2021-05-26 18:47:52 +08:00
mongo:
2022-03-21 11:13:17 +08:00
dbUri: ""#当dbUri值不为空则直接使用该值
2022-09-16 15:08:48 +08:00
#dbAddress: 127.0.0.1:37017 #单机时为mongo地址,使用分片集群时,为mongos地址 默认即可
2022-09-16 16:17:21 +08:00
dbAddress: [ 127.0.0.1:37017 ] #单机时为mongo地址,使用分片集群时,为mongos地址 默认即可
2021-05-26 18:47:52 +08:00
dbDirect: false
2022-05-20 20:11:47 +08:00
dbTimeout: 60
2022-02-23 18:22:44 +08:00
dbDatabase: openIM #mongo db 默认即可
2021-05-26 18:47:52 +08:00
dbSource: admin
2022-11-10 14:51:35 +08:00
dbUserName: #mongo用户名,建议先不设置
dbPassword: #mongo密码,建议先不设置
2022-05-20 20:11:47 +08:00
dbMaxPoolSize: 100
2022-02-23 18:22:44 +08:00
dbRetainChatRecords: 3650 #mongo保存离线消息时间(天),根据需求修改
2022-12-28 18:56:49 +08:00
chatRecordsClearTime: "0 3 * * *" # 每天凌晨3点清除消息,该配置和linux定时任务一样, 清理操作建议设置在用户活跃少的时候 # 0 3 * * *
2021-05-26 18:47:52 +08:00
redis:
2022-07-11 11:01:41 +08:00
dbAddress: [ 127.0.0.1:16379 ] #redis地址 单机时,填写一个地址即可,使用redis集群时候,填写集群中多个节点地址(主从地址都可以填写,增加容灾能力),默认即可
2021-05-26 18:47:52 +08:00
dbMaxIdle: 128
dbMaxActive: 0
dbIdleTimeout: 120
2022-07-11 11:00:32 +08:00
dbUserName: #only redis version 6.0+ need username
2022-11-10 14:51:35 +08:00
dbPassWord: #redis密码 建议修改
2022-07-11 11:02:56 +08:00
enableCluster: false #如果外部redis以集群方式启动,需要打开此开关
2021-05-26 18:47:52 +08:00
kafka:
2022-09-16 16:51:12 +08:00
SASLUserName:
SASLPassword:
2021-05-26 18:47:52 +08:00
ws2mschat:
2022-02-23 18:22:44 +08:00
addr: [ 127.0.0.1:9092 ] #kafka配置,默认即可
topic: "ws2ms_chat" #用于mongo和mysql保存消息
# ws2mschatoffline:
# addr: [ 127.0.0.1:9092 ] #kafka配置,默认即可
# topic: "ws2ms_chat_offline" #原为离线用户消息处理,目前暂时弃用
2022-06-16 12:21:49 +08:00
msgtomongo:
addr: [ 127.0.0.1:9092 ] #kafka配置,默认即可
topic: "msg_to_mongo"
2021-05-26 18:47:52 +08:00
ms2pschat:
2022-02-23 18:22:44 +08:00
addr: [ 127.0.0.1:9092 ] #kafka配置,默认即可
topic: "ms2ps_chat" #消息push
2022-12-12 19:22:50 +08:00
msgtomodify:
addr: [ 127.0.0.1:9092 ] #kafka配置,默认即可
topic: "msg_to_modify"
2021-05-26 18:47:52 +08:00
consumergroupid:
2022-06-17 10:59:50 +08:00
msgToTransfer: mongo
msgToMongo: mongo_ex
2021-05-26 18:47:52 +08:00
msgToMySql: mysql
msgToPush: push
2022-12-12 19:22:50 +08:00
msgToModify: modify
2021-05-26 18:47:52 +08:00
#---------------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
2022-02-23 18:22:44 +08:00
#如果是单机模式,用0.0.0.0或者不填,默认即可
2021-11-25 13:57:11 +08:00
serverip: 0.0.0.0
2021-05-26 18:47:52 +08:00
2022-07-01 14:59:53 +08:00
#作为rpc时,注册到etcd的地址,单机默认即可,如果是集群部署,需要修改(具体使用内网地址还是外网地址,要依情况而定,目的是api/gateway能访问到)
2022-08-17 11:35:33 +08:00
rpcRegisterIP:
2022-07-01 14:59:53 +08:00
#默认即可
2022-05-07 17:05:05 +08:00
listenIP: 0.0.0.0
# endpoints 内部组件间访问的端点host名称,访问时,可以内部直接访问 host:port 来访问
endpoints:
api: openim_api
2022-02-16 11:06:35 +08:00
cmsapi: openim_cms_api
push: openim_push
msg_gateway: openim_msg_gateway
rpc_auth: openim_rpc_auth
rpc_friend: openim_rpc_friend
rpc_group: openim_rpc_group
rpc_msg: openim_rpc_msg
rpc_user: openim_rpc_user
2022-02-16 11:06:35 +08:00
rpc_admin_cms: openim_rpc_admin_cms
2022-03-28 14:54:46 +08:00
rpc_office: openim_rpc_office
2021-11-25 13:57:11 +08:00
api:
2022-04-25 15:45:39 +08:00
openImApiPort: [ 10002 ] #api服务端口,默认即可,需要开放此端口或做nginx转发
2022-05-07 19:52:18 +08:00
listenIP: 0.0.0.0
2022-01-24 01:40:49 +08:00
cmsapi:
2022-04-25 15:45:39 +08:00
openImCmsApiPort: [ 10006 ] #管理后台api服务端口,默认即可,需要开放此端口或做nginx转发
2022-05-07 19:52:18 +08:00
listenIP: 0.0.0.0
2021-09-27 21:03:36 +08:00
sdk:
2022-04-25 15:45:39 +08:00
openImSdkWsPort: [ 10003 ] #jssdk服务端口,默认即可,项目中使用jssdk才需开放此端口或做nginx转发
2022-05-07 19:52:18 +08:00
dataDir: [ ../db/sdk/ ]
2022-08-24 16:20:31 +08:00
openImWsAddress: ws://127.0.0.1:10001
openImApiAddress: http://127.0.0.1:10002
2022-03-15 17:25:31 +08:00
#对象存储服务,以下配置二选一,目前支持两种,腾讯云和minio,二者配置好其中一种即可(如果使用minio参考https://doc.rentsoft.cn/#/qa/minio搭建minio服务器)
2022-02-23 18:22:44 +08:00
credential: #腾讯cos,发送图片、视频、文件时需要,请自行申请后替换,必须修改
2021-05-26 18:47:52 +08:00
tencent:
2023-02-08 11:53:54 +08:00
appID:
region:
bucket:
secretID:
secretKey:
2022-03-15 17:25:31 +08:00
minio: #MinIO 发送图片、视频、文件时需要,请自行申请后替换,必须修改。 客户端初始化InitSDK,中 object_storage参数为minio
2022-05-10 10:44:43 +08:00
bucket: openim # 存储内容桶
appBucket: app # 存储app的桶
2022-02-21 16:41:56 +08:00
location: us-east-1
2022-11-11 19:01:23 +08:00
endpoint: #minio外网ip 这个ip是给客户端访问的
2022-09-16 15:08:48 +08:00
endpointInner: http://127.0.0.1:10005 #minio内网地址 如果im server 可以通过内网访问到 minio就可以
2022-04-11 16:18:36 +08:00
endpointInnerEnable: true #是否启用minio内网地址 启用可以让桶初始化,IM server连接minio走内网地址访问
2022-11-10 14:51:35 +08:00
accessKeyID:
secretAccessKey:
2022-07-29 14:36:07 +08:00
storageTime: 50 #文件在minio中保存的时间
2022-08-01 14:33:50 +08:00
isDistributedMod: false # 是否分布式多硬盘部署 默认docker-compose中为false
2022-03-21 11:13:17 +08:00
ali: # ali oss
2023-02-08 11:53:54 +08:00
regionID:
accessKeyID:
accessKeySecret:
stsEndpoint:
ossEndpoint:
bucket:
finalHost:
stsDurationSeconds:
OssRoleArn:
2022-07-31 01:14:26 +08:00
aws:
2023-02-02 17:47:38 +08:00
accessKeyID: #AssumeRole用户关联的accessKeyID
accessKeySecret: #AssumeRole用户关联的accessKeySecrect
region: #分区
bucket: #桶
finalHost: #对外Host
roleArn: #RoleArn
externalId: #角色扩展Id
roleSessionName: #角色SESSION名称
2022-02-21 16:41:56 +08:00
2022-02-23 18:22:44 +08:00
rpcport: #rpc服务端口 默认即可
2022-04-25 16:21:48 +08:00
openImUserPort: [ 10110 ]
openImFriendPort: [ 10120 ]
openImMessagePort: [ 10130 ]
openImMessageGatewayPort: [ 10140 ]
openImGroupPort: [ 10150 ]
openImAuthPort: [ 10160 ]
openImPushPort: [ 10170 ]
openImAdminCmsPort: [ 10200 ]
openImOfficePort: [ 10210 ]
openImOrganizationPort: [ 10220 ]
openImConversationPort: [ 10230 ]
2022-08-17 11:35:33 +08:00
openImCachePort: [ 10240 ]
2022-08-17 11:42:12 +08:00
openImRealTimeCommPort: [ 11300 ]
2022-02-16 11:13:13 +08:00
c2c:
2021-12-02 21:35:01 +08:00
callbackBeforeSendMsg:
switch: false
timeoutStrategy: 1 #1:send
callbackAfterSendMsg:
switch: false
state:
stateChange:
switch: false
2021-05-26 18:47:52 +08:00
2022-02-23 18:22:44 +08:00
rpcregistername: #rpc注册服务名,默认即可
2022-02-09 16:22:58 +08:00
openImUserName: User
2021-05-26 18:47:52 +08:00
openImFriendName: Friend
2022-07-20 21:40:11 +08:00
openImMsgName: Msg
2021-05-26 18:47:52 +08:00
openImPushName: Push
2022-07-20 21:40:11 +08:00
openImRelayName: Relay
2021-05-26 18:47:52 +08:00
openImGroupName: Group
2021-10-11 18:18:50 +08:00
openImAuthName: Auth
2022-02-12 17:13:31 +08:00
openImAdminCMSName: AdminCMS
2022-03-28 14:54:46 +08:00
openImOfficeName: Office
2022-04-16 20:56:28 +08:00
openImOrganizationName: Organization
2022-04-24 11:23:54 +08:00
openImConversationName: Conversation
2022-04-25 20:05:21 +08:00
openImCacheName: Cache
2022-05-07 09:34:49 +08:00
openImRealTimeCommName: RealTimeComm
2021-05-26 18:47:52 +08:00
log:
storageLocation: ../logs/
2021-10-11 18:18:50 +08:00
rotationTime: 24
2022-07-15 15:17:54 +08:00
remainRotationCount: 2 #日志数量
2022-03-04 16:24:28 +08:00
#日志级别 6表示全都打印,测试阶段建议设置为6
2022-03-31 15:01:49 +08:00
remainLogLevel: 6
2021-05-26 18:47:52 +08:00
elasticSearchSwitch: false
2021-07-15 10:48:01 +08:00
elasticSearchAddr: [ 127.0.0.1:9201 ]
2021-05-26 18:47:52 +08:00
elasticSearchUser: ""
elasticSearchPassword: ""
2022-02-23 18:22:44 +08:00
modulename: #日志文件按模块命名,默认即可
2021-05-26 18:47:52 +08:00
longConnSvrName: msg_gateway
msgTransferName: msg_transfer
pushName: push
longconnsvr:
2022-04-25 15:45:39 +08:00
openImWsPort: [ 10001 ] # ws服务端口,默认即可,要开放此端口或做nginx转发
2021-05-26 18:47:52 +08:00
websocketMaxConnNum: 10000
websocketMaxMsgLen: 4096
websocketTimeOut: 10
2022-04-15 18:22:27 +08:00
## 推送只能开启一个 enable代表开启
2021-05-26 18:47:52 +08:00
push:
2022-02-23 18:22:44 +08:00
tpns: #腾讯推送,暂未测试 暂不要使用
2021-05-26 18:47:52 +08:00
ios:
2023-02-08 11:53:54 +08:00
accessID:
secretKey:
2021-05-26 18:47:52 +08:00
android:
2023-02-08 11:53:54 +08:00
accessID:
secretKey:
2022-11-10 14:51:35 +08:00
enable: false # true or false (bool)
2022-02-23 18:22:44 +08:00
jpns: #极光推送 在极光后台申请后,修改以下四项,必须修改
2023-02-08 11:53:54 +08:00
appKey:
masterSecret:
pushUrl:
pushIntent:
2022-11-10 14:51:35 +08:00
enable: false # true or false (bool)
2022-07-26 15:20:48 +08:00
getui: #个推推送
2022-11-11 15:18:04 +08:00
pushUrl:
2022-04-08 16:15:22 +08:00
masterSecret: ""
2022-04-08 15:40:07 +08:00
appKey: ""
intent: ""
2022-11-10 14:51:35 +08:00
enable: # true or false (bool)
2022-09-07 18:20:41 +08:00
channelID: ""
channelName: ""
2023-03-27 17:56:08 +08:00
channel:
HW:
category:
XM:
channelID:
OPPO:
channelID:
fcm: #firebase cloud message 消息推送
2023-02-02 18:04:08 +08:00
serviceAccount: #帐号文件,此处需要改修配置,并且这个文件放在 config目录下
2022-07-29 17:54:50 +08:00
enable: false
2022-09-23 17:40:48 +08:00
mob: #袤博推送
2023-02-02 18:04:08 +08:00
appKey: #帐号文件,此处需要改修配置,并且这个文件放在 config目录下
2023-02-08 11:53:54 +08:00
pushUrl:
scheme:
appSecret:
2022-09-23 17:40:48 +08:00
enable: false
2022-04-08 16:15:22 +08:00
2022-04-08 15:40:07 +08:00
2021-09-26 14:26:45 +08:00
manager:
2022-02-23 18:22:44 +08:00
#app管理员userID和对应的secret 建议修改。 用于管理后台登录,也可以用户管理后台对应的api
2022-02-12 17:13:31 +08:00
appManagerUid: [ "openIM123456","openIM654321", "openIM333", "openIMAdmin"]
2022-02-16 11:06:35 +08:00
secrets: [ "openIM1","openIM2", "openIM333", "openIMAdmin"]
2022-06-17 12:09:42 +08:00
appSysNotificationName: "系统通知"
2021-05-26 18:47:52 +08:00
2022-11-10 18:23:11 +08:00
secret:
2022-02-23 18:22:44 +08:00
# 多端互踢策略
# 1:多平台登录:Android、iOS、Windows、Mac 每种平台只能一个在线,web端可以多个同时在线
2021-11-25 14:12:52 +08:00
multiloginpolicy: 1
2021-05-26 18:47:52 +08:00
2022-07-20 21:26:52 +08:00
#msg log insert to db
2022-05-19 12:25:46 +08:00
chatpersistencemysql: true
#可靠性存储
2022-05-19 12:28:14 +08:00
reliablestorage: false
2022-05-24 17:22:17 +08:00
#消息缓存时间
2022-06-17 15:48:40 +08:00
msgCacheTimeout: 86400
2022-06-09 12:39:28 +08:00
#群聊已读开启
2022-06-16 11:45:52 +08:00
groupMessageHasReadReceiptEnable: true
2022-06-09 12:39:28 +08:00
#单聊已读开启
2022-06-16 11:45:52 +08:00
singleMessageHasReadReceiptEnable: true
2022-06-09 12:39:28 +08:00
2021-05-26 18:47:52 +08:00
#token config
tokenpolicy:
2022-11-10 18:23:11 +08:00
accessSecret: #token生成相关,默认即可
# Token effective time day as a unit
2022-11-10 18:23:11 +08:00
accessExpire: #token过期时间(天) 默认即可
2022-03-18 17:44:50 +08:00
messageverify:
2022-11-10 18:23:11 +08:00
friendVerify:
2021-05-31 10:03:57 +08:00
2022-02-08 19:18:07 +08:00
# c2c:
# callbackBeforeSendMsg:
# switch: false
# timeoutStrategy: 1 #1:send
# callbackAfterSendMsg:
# switch: false
# state:
# stateChange:
# switch: false
2022-02-23 18:22:44 +08:00
#ios系统推送声音以及标记计数
2022-02-08 19:22:15 +08:00
iospush:
2021-12-20 16:29:24 +08:00
pushSound: "xxx"
2021-12-21 21:40:50 +08:00
badgeCount: true
2022-06-21 11:28:02 +08:00
production: false
2021-12-20 16:29:24 +08:00
2022-02-28 17:57:03 +08:00
callback:
2022-03-04 18:03:22 +08:00
# callback url 需要自行更换callback url
2022-03-03 16:23:59 +08:00
callbackUrl : "http://127.0.0.1:8080/callback"
2022-02-28 17:57:03 +08:00
# 开启关闭操作前后回调的配置
2022-05-26 18:08:29 +08:00
callbackBeforeSendSingleMsg:
2022-03-04 18:37:55 +08:00
enable: false # 回调是否启用
2022-03-03 19:23:16 +08:00
callbackTimeOut: 2 # 回调超时时间
2022-03-11 17:37:01 +08:00
callbackFailedContinue: true # 回调超时是否继续执行代码
2022-02-28 17:57:03 +08:00
callbackAfterSendSingleMsg:
2022-03-04 18:37:55 +08:00
enable: false
2022-03-03 19:23:16 +08:00
callbackTimeOut: 2
2022-02-28 17:57:03 +08:00
callbackBeforeSendGroupMsg:
2022-03-04 18:37:55 +08:00
enable: false
2022-03-03 19:23:16 +08:00
callbackTimeOut: 2
2022-03-11 17:37:01 +08:00
callbackFailedContinue: true
2022-02-28 17:57:03 +08:00
callbackAfterSendGroupMsg:
2022-03-04 18:37:55 +08:00
enable: false
2022-03-03 19:23:16 +08:00
callbackTimeOut: 2
2023-02-27 17:08:34 +08:00
callbackAfterConsumeGroupMsg:
enable: false
callbackTimeOut: 2
2022-10-21 15:44:55 +08:00
callbackMsgModify:
2022-03-04 18:37:55 +08:00
enable: false
2022-03-03 19:23:16 +08:00
callbackTimeOut: 2
2022-03-11 17:37:01 +08:00
callbackFailedContinue: true
2022-05-26 18:08:29 +08:00
callbackUserOnline:
2022-05-27 13:16:05 +08:00
enable: false
2022-05-26 18:08:29 +08:00
callbackTimeOut: 2
callbackUserOffline:
2022-05-27 13:16:05 +08:00
enable: false
2022-05-26 18:08:29 +08:00
callbackTimeOut: 2
2022-08-11 15:55:33 +08:00
callbackUserKickOff:
enable: false
callbackTimeOut: 2
2022-05-26 18:08:29 +08:00
callbackOfflinePush:
2022-05-27 15:14:12 +08:00
enable: false
2022-05-26 18:08:29 +08:00
callbackTimeOut: 2
callbackFailedContinue: true # 回调超时是否继续离线推送
2022-07-29 14:36:07 +08:00
callbackOnlinePush:
enable: false
callbackTimeOut: 2
callbackFailedContinue: true # 回调超时是否继续离线推送
callbackSuperGroupOnlinePush:
enable: false
callbackTimeOut: 2
callbackFailedContinue: true # 回调超时是否继续离线推送
2022-10-19 21:06:48 +08:00
callbackBeforeAddFriend:
enable: false
callbackTimeOut: 2
callbackFailedContinue: true # 回调超时是否继续
2022-10-21 15:44:55 +08:00
callbackBeforeCreateGroup:
enable: false
callbackTimeOut: 2
callbackFailedContinue: true # 回调超时是否继续
2022-11-22 11:07:20 +08:00
callbackBeforeMemberJoinGroup:
enable: false
callbackTimeOut: 2
callbackFailedContinue: true # 回调超时是否继续
2022-12-16 16:54:18 +08:00
callbackBeforeSetGroupMemberInfo:
2022-12-07 21:12:48 +08:00
enable: false
callbackTimeOut: 2
callbackFailedContinue: true # 回调超时是否继续
2022-12-09 12:13:14 +08:00
callbackSetMessageReactionExtensions:
2022-12-07 21:12:48 +08:00
enable: false
callbackTimeOut: 2
callbackFailedContinue: true # 回调超时是否继续
2022-02-28 17:57:03 +08:00
2021-12-20 16:29:24 +08:00
notification:
groupCreated:
conversation:
2022-02-08 15:19:31 +08:00
reliabilityLevel: 3
2021-12-21 21:40:50 +08:00
unreadCount: true
2021-12-20 16:29:24 +08:00
offlinePush:
switch: true
2022-01-14 13:44:46 +08:00
title: "create group title" # xx create the group
2021-12-20 16:29:24 +08:00
desc: "create group desc"
ext: "create group ext"
defaultTips:
tips: "create the group" # xx create the group
2022-01-18 09:25:41 +08:00
groupInfoSet:
conversation:
2022-02-08 15:19:31 +08:00
reliabilityLevel: 3
unreadCount: true
2022-01-18 09:25:41 +08:00
offlinePush:
switch: false
2022-02-08 15:19:31 +08:00
title: "groupInfoSet title"
desc: "groupInfoSet desc"
ext: "groupInfoSet ext"
2022-01-18 09:25:41 +08:00
defaultTips:
2022-02-08 15:19:31 +08:00
tips: "modified the group profile" # group info changed by xx
2022-01-18 09:25:41 +08:00
joinGroupApplication:
conversation:
2022-02-08 15:19:31 +08:00
reliabilityLevel: 2
2022-01-18 09:25:41 +08:00
unreadCount: false
offlinePush:
switch: false
2022-02-08 15:19:31 +08:00
title: "joinGroupApplication title"
desc: "joinGroupApplication desc"
ext: "joinGroupApplication ext"
2022-01-18 09:25:41 +08:00
defaultTips:
2022-02-08 15:19:31 +08:00
tips: "apply to join the group" # group info changed by xx
2022-01-18 09:25:41 +08:00
memberQuit:
conversation:
2022-02-08 15:19:31 +08:00
reliabilityLevel: 3
unreadCount: true
2022-01-18 09:25:41 +08:00
offlinePush:
switch: false
2022-02-08 15:19:31 +08:00
title: "memberQuit title"
desc: "memberQuit desc"
ext: "memberQuit ext"
2022-01-18 09:25:41 +08:00
defaultTips:
2022-07-20 21:26:52 +08:00
tips: "quit group msg" # group info changed by xx
2022-01-18 09:25:41 +08:00
groupApplicationAccepted:
conversation:
2022-02-10 12:28:06 +08:00
reliabilityLevel: 2
2022-02-08 15:19:31 +08:00
unreadCount: true
2022-01-18 09:25:41 +08:00
offlinePush:
switch: false
2022-02-08 15:19:31 +08:00
title: "groupApplicationAccepted title"
desc: "groupApplicationAccepted desc"
ext: "groupApplicationAccepted ext"
2022-01-18 09:25:41 +08:00
defaultTips:
2022-02-21 16:41:56 +08:00
tips: "was allowed to join the group" # group info changed by xx
2022-01-18 09:25:41 +08:00
groupApplicationRejected:
conversation:
2022-02-08 15:19:31 +08:00
reliabilityLevel: 2
2022-01-18 09:25:41 +08:00
unreadCount: false
offlinePush:
switch: false
2022-02-08 15:19:31 +08:00
title: " title"
desc: " desc"
ext: " ext"
2022-01-18 09:25:41 +08:00
defaultTips:
2022-02-21 16:41:56 +08:00
tips: "was rejected into the group" # group info changed by xx
2022-01-18 09:25:41 +08:00
groupOwnerTransferred:
conversation:
2022-02-08 15:19:31 +08:00
reliabilityLevel: 3
unreadCount: true
2022-01-18 09:25:41 +08:00
offlinePush:
switch: false
2022-02-08 15:19:31 +08:00
title: "groupOwnerTransferred title"
desc: "groupOwnerTransferred desc"
ext: "groupOwnerTransferred ext"
2022-01-18 09:25:41 +08:00
defaultTips:
2022-02-08 15:19:31 +08:00
tips: "become a new group owner" # group info changed by xx
2022-01-14 13:44:46 +08:00
2022-01-18 09:25:41 +08:00
memberKicked:
2021-12-20 16:29:24 +08:00
conversation:
2022-02-08 15:19:31 +08:00
reliabilityLevel: 3
unreadCount: true
2021-12-20 16:29:24 +08:00
offlinePush:
2022-01-14 13:44:46 +08:00
switch: false
2022-02-08 15:19:31 +08:00
title: "memberKicked title"
desc: "memberKicked desc"
ext: "memberKicked ext"
2021-12-20 16:29:24 +08:00
defaultTips:
2022-02-21 16:41:56 +08:00
tips: "was kicked out of the group" # group info changed by xx
2022-01-14 13:44:46 +08:00
2022-01-18 09:25:41 +08:00
memberInvited:
conversation:
2022-02-08 15:19:31 +08:00
reliabilityLevel: 3
unreadCount: true
2022-01-18 09:25:41 +08:00
offlinePush:
switch: false
2022-02-08 15:19:31 +08:00
title: "memberInvited title"
desc: "memberInvited desc"
ext: "memberInvited ext"
2022-01-18 09:25:41 +08:00
defaultTips:
2022-02-21 16:41:56 +08:00
tips: "was invited into the group" # group info changed by xx
2022-01-18 09:25:41 +08:00
memberEnter:
conversation:
2022-02-08 15:19:31 +08:00
reliabilityLevel: 3
unreadCount: true
2022-01-18 09:25:41 +08:00
offlinePush:
switch: false
2022-02-08 15:19:31 +08:00
title: "memberEnter title"
desc: "memberEnter desc"
ext: "memberEnter ext"
2022-01-18 09:25:41 +08:00
defaultTips:
2022-02-08 15:19:31 +08:00
tips: "entered the group" # group info changed by xx
2021-12-20 16:29:24 +08:00
2022-03-24 15:33:30 +08:00
groupDismissed:
conversation:
reliabilityLevel: 3
unreadCount: true
offlinePush:
switch: false
title: "groupDismissed title"
desc: "groupDismissed desc"
ext: "groupDismissed ext"
defaultTips:
tips: "group dismissed"
2022-03-29 16:04:15 +08:00
groupMuted:
conversation:
reliabilityLevel: 3
unreadCount: true
offlinePush:
switch: false
title: "groupMuted title"
desc: "groupMuted desc"
ext: "groupMuted ext"
defaultTips:
tips: "group Muted"
groupCancelMuted:
conversation:
reliabilityLevel: 3
unreadCount: true
offlinePush:
switch: false
title: "groupCancelMuted title"
desc: "groupCancelMuted desc"
ext: "groupCancelMuted ext"
defaultTips:
tips: "group Cancel Muted"
groupMemberMuted:
conversation:
reliabilityLevel: 3
unreadCount: true
offlinePush:
switch: false
title: "groupMemberMuted title"
desc: "groupMemberMuted desc"
ext: "groupMemberMuted ext"
defaultTips:
tips: "group Member Muted"
groupMemberCancelMuted:
conversation:
reliabilityLevel: 3
unreadCount: true
offlinePush:
switch: false
title: "groupMemberCancelMuted title"
desc: "groupMemberCancelMuted desc"
ext: "groupMemberCancelMuted ext"
defaultTips:
tips: "group Member Cancel Muted"
2022-04-18 11:52:17 +08:00
groupMemberInfoSet:
conversation:
reliabilityLevel: 2
2022-04-18 11:53:03 +08:00
unreadCount: false
2022-04-18 11:52:17 +08:00
offlinePush:
switch: false
2022-04-18 11:53:03 +08:00
title: "groupMemberInfoSet title"
desc: "groupMemberInfoSet desc"
2022-04-18 11:52:17 +08:00
ext: "groupMemberInfoSet ext"
defaultTips:
tips: "group member info set"
2022-04-19 18:46:02 +08:00
organizationChanged:
conversation:
reliabilityLevel: 2
unreadCount: false
offlinePush:
switch: false
2022-04-19 18:46:33 +08:00
title: "organizationChanged title"
desc: "organizationChanged desc"
ext: "organizationChanged ext"
2022-04-19 18:46:02 +08:00
defaultTips:
2022-04-19 18:46:33 +08:00
tips: "organization changed"
2022-04-19 18:46:02 +08:00
2022-01-18 09:25:41 +08:00
#############################friend#################################
2021-12-20 16:29:24 +08:00
2022-01-18 09:25:41 +08:00
friendApplicationAdded:
2022-01-16 12:25:41 +08:00
conversation:
reliabilityLevel: 2
unreadCount: false
offlinePush:
switch: true
title: "Somebody applies to add you as a friend"
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" #
2022-01-18 09:25:41 +08:00
friendApplicationApproved:
2022-01-16 12:25:41 +08:00
conversation:
reliabilityLevel: 2
unreadCount: false
offlinePush:
switch: true
title: "Someone applies to add your friend application"
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" #
2022-01-18 09:25:41 +08:00
friendApplicationRejected:
2022-01-16 12:25:41 +08:00
conversation:
reliabilityLevel: 2
unreadCount: false
offlinePush:
switch: true
title: "Someone rejected your friend application"
desc: "Someone rejected your friend application"
ext: "Someone rejected your friend application"
defaultTips:
tips: "I rejected your friend application" #
2022-01-18 09:25:41 +08:00
friendAdded:
2022-01-16 12:25:41 +08:00
conversation:
reliabilityLevel: 3
unreadCount: true
offlinePush:
switch: true
title: "We have become friends"
desc: "We have become friends"
ext: "We have become friends"
defaultTips:
tips: "We have become friends" #
2022-01-18 09:25:41 +08:00
friendDeleted:
2022-01-16 12:25:41 +08:00
conversation:
reliabilityLevel: 2
unreadCount: false
offlinePush:
switch: true
2022-02-23 18:22:44 +08:00
title: "deleted a friend"
desc: "deleted a friend"
ext: "deleted a friend"
2022-01-16 12:25:41 +08:00
defaultTips:
2022-02-23 18:22:44 +08:00
tips: "deleted a friend" #
2022-01-16 12:25:41 +08:00
2022-01-18 09:40:08 +08:00
friendRemarkSet:
2022-01-16 12:25:41 +08:00
conversation:
reliabilityLevel: 2
unreadCount: false
offlinePush:
switch: true
title: "Your friend's profile has been changed"
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" #
2022-01-18 09:25:41 +08:00
blackAdded:
2022-01-16 12:25:41 +08:00
conversation:
reliabilityLevel: 2
unreadCount: false
offlinePush:
switch: true
2022-02-23 18:22:44 +08:00
title: "blocked a user"
desc: "blocked a user"
ext: "blocked a user"
2022-01-16 12:25:41 +08:00
defaultTips:
2022-02-23 18:22:44 +08:00
tips: "blocked a user" #
2022-01-16 12:25:41 +08:00
2022-01-18 09:25:41 +08:00
blackDeleted:
conversation:
reliabilityLevel: 2
unreadCount: false
offlinePush:
switch: true
title: "Remove a blocked user"
desc: "Remove a blocked user"
ext: "Remove a blocked user"
defaultTips:
tips: "Remove a blocked user"
2022-12-07 10:00:53 +08:00
friendInfoUpdated:
conversation:
reliabilityLevel: 2
unreadCount: false
offlinePush:
switch: true
title: "friend info updated"
desc: "friend info updated"
ext: "friend info updated"
defaultTips:
tips: "friend info updated"
2022-01-18 09:25:41 +08:00
#####################user#########################
userInfoUpdated:
2022-01-16 12:25:41 +08:00
conversation:
reliabilityLevel: 2
unreadCount: false
offlinePush:
switch: true
title: "Remove a blocked user"
desc: "Remove a blocked user"
ext: "Remove a blocked user"
defaultTips:
2022-02-23 18:22:44 +08:00
tips: "remove a blocked user"
2022-01-16 12:25:41 +08:00
2022-02-15 14:11:20 +08:00
#####################conversation#########################
conversationOptUpdate:
conversation:
2022-07-26 21:02:11 +08:00
reliabilityLevel: 1
2022-02-15 14:11:20 +08:00
unreadCount: false
offlinePush:
switch: true
title: "conversation opt update"
desc: "conversation opt update"
ext: "conversation opt update"
defaultTips:
tips: "conversation opt update"
2022-01-16 12:25:41 +08:00
2022-03-31 14:50:02 +08:00
conversationSetPrivate:
conversation:
2022-04-22 17:19:35 +08:00
reliabilityLevel: 3
2022-03-31 14:50:02 +08:00
unreadCount: true
2022-04-01 14:43:31 +08:00
offlinePush:
switch: true
title: "burn after reading"
desc: "burn after reading"
ext: "burn after reading"
defaultTips:
openTips: "burn after reading was opened"
closeTips: "burn after reading was closed"
2022-03-31 14:50:02 +08:00
2022-04-22 17:19:35 +08:00
###################workMoments################
workMomentsNotification:
conversation:
reliabilityLevel: 2
unreadCount: true
offlinePush:
switch: true
title: "burn after reading"
desc: "burn after reading"
ext: "burn after reading"
defaultTips:
openTips: "burn after reading was opened"
closeTips: "burn after reading was closed"
2022-01-16 12:25:41 +08:00
2022-05-12 19:00:48 +08:00
###################organization################
joinDepartmentNotification:
conversation:
reliabilityLevel: 3
unreadCount: true
offlinePush:
switch: false
title: "welcome user join department"
desc: "welcome user join department"
ext: "welcome user join department"
defaultTips:
tips: "welcome user join department"
2021-12-01 12:16:02 +08:00
#---------------demo configuration---------------------#
#The following configuration items are applied to openIM Demo configuration
2022-02-23 18:22:44 +08:00
#是否启动demo,如果自身没有账号体系,设置为true
2022-02-21 15:07:50 +08:00
demoswitch: true
2021-12-01 12:16:02 +08:00
demo:
2022-05-07 19:52:18 +08:00
listenIP: 0.0.0.0
2022-02-25 15:59:33 +08:00
#demo对外服务端口,默认即可,需要开放此端口或做nginx转发
2022-04-25 15:45:39 +08:00
openImDemoPort: [ 10004 ]
2022-06-24 19:04:06 +08:00
alismsverify: #阿里云短信配置,在阿里云申请成功后修改以下四项,enable为true则必须修改,阿里云为默认短信验证方式
2023-02-08 11:53:54 +08:00
accessKeyId:
accessKeySecret:
signName:
verificationCodeTemplateCode:
2022-06-30 18:42:30 +08:00
enable: false
2022-06-24 19:04:06 +08:00
tencentsms: #腾讯云短信配置,在腾讯云申请成功后,修改以下选项,enable为true则必须修改
2023-02-08 11:53:54 +08:00
appID:
region:
secretID:
secretKey:
signName:
verificationCodeTemplateCode:
2022-06-24 19:04:06 +08:00
enable: true
2022-02-23 18:22:44 +08:00
superCode: 666666 #超级验证码,建议修改掉,收不到短信验证码时可以用此替代
2022-08-13 10:41:10 +08:00
needInvitationCode: false
2022-02-11 16:25:28 +08:00
# second
2022-07-01 17:23:43 +08:00
codeTTL: 60
2022-07-02 09:50:25 +08:00
useSuperCode: true
2022-02-23 18:22:44 +08:00
mail: #仅支持qq邮箱,具体操作参考 https://service.mail.qq.com/cgi-bin/help?subtype=1&id=28&no=1001256 必须修改
2023-02-08 11:53:54 +08:00
title:
senderMail:
senderAuthorizationCode:
smtpAddr:
2023-02-02 17:24:15 +08:00
smtpPort: #需开放此端口 出口方向
2022-05-12 19:00:48 +08:00
testDepartMentID: 001
2022-05-26 19:53:13 +08:00
imAPIURL: http://127.0.0.1:10002
2022-08-05 15:54:00 +08:00
onboardProcess: false # 是否开启注册流程
2022-08-29 14:34:07 +08:00
createOrganizationUserAndJoinDepartment: false
2022-08-05 15:54:00 +08:00
joinDepartmentIDList: [] # 用户注册进来默认加的部门ID列表 不填就随机
joinDepartmentGroups: false # 注册是否加部门群
oaNotification: false # 注册是否发送OA通知
2022-02-11 16:25:28 +08:00
2022-09-27 15:35:36 +08:00
workMoment:
onlyFriendCanSee: false
2022-04-05 10:27:34 +08:00
rtc:
2022-06-15 10:34:32 +08:00
signalTimeout: 35
2022-09-08 01:27:05 +08:00
2022-09-12 19:32:24 +08:00
# prometheus每个服务监听的端口数量需要和rpc port保持一致
2022-09-09 01:10:06 +08:00
prometheus:
enable: false
userPrometheusPort: [ 20110 ]
friendPrometheusPort: [ 20120 ]
messagePrometheusPort: [ 20130 ]
messageGatewayPrometheusPort: [ 20140 ]
groupPrometheusPort: [ 20150 ]
authPrometheusPort: [ 20160 ]
pushPrometheusPort: [ 20170 ]
adminCmsPrometheusPort: [ 20200 ]
officePrometheusPort: [ 20210 ]
organizationPrometheusPort: [ 20220 ]
conversationPrometheusPort: [ 20230 ]
cachePrometheusPort: [ 20240 ]
realTimeCommPrometheusPort: [ 21300 ]
2023-02-02 17:24:15 +08:00
messageTransferPrometheusPort: [ 21400, 21401, 21402, 21403 ] # 端口数量和 script/path_info.cfg msg_transfer_service_num保持一致