313 lines
19 KiB
Plaintext
Executable File
313 lines
19 KiB
Plaintext
Executable File
#
|
||
#
|
||
# 本配置文件为debug使用，修改这里不会在Release包中生效。Release中包含的配置文件在 ${Porject_Path}/distribution/src/main/resources目录下
|
||
#
|
||
#
|
||
|
||
|
||
|
||
#*********************************************************************
|
||
# Server configuration
|
||
#*********************************************************************
|
||
#服务器的接入IP。给客户端提供是${server.ip}和${http_port}。
|
||
#客户端会从${http_port}端口获取到长链接端口。这个地址一定要改成客户端可以访问到的IP地址
|
||
#（如果您部署云服务器上或者具有独立公网出口的服务器上，请改为对应的公网IP；如果您部署在在内网环境下，在内网使用，这个地方改成内网地址）
|
||
server.ip 192.168.3.124
|
||
|
||
##原生客户端长链接端口
|
||
port 1883
|
||
|
||
##客户端短链接端口，客户端固定使用80端口，不要修改此端口。
|
||
http_port 80
|
||
|
||
#管理端口
|
||
http.admin.port 18080
|
||
|
||
##节点ID，当集群部署时，一定不能有重复。
|
||
node_id 1
|
||
|
||
##绑定IP，保持不变即可
|
||
host 0.0.0.0
|
||
|
||
##本地绑定端口
|
||
local_port 80
|
||
|
||
##是否使用内置DB。0使用mysql；1使用h2db。
|
||
embed.db 1
|
||
|
||
## 是否自动清理历史消息记录，当为true时，IM服务会定时扫描t_messages_x和t_user_messages_x表，清除掉3年前的历史消息。
|
||
## 如果不开启自动清理，需要手动清理t_messages_x和t_user_messages_x表内的历史数据，保存数据不能超过3年。
|
||
## 使用mongodb时次开关无效（因为mongodb设置了消息过期时间，会自动清理，仅专业版支持mongodb）。
|
||
db.auto_clean_history_messages true
|
||
|
||
##服务器管理接口密钥。如果修改此端口需要同步修改使用管理API的地方，比如应用服务。
|
||
http.admin.secret_key 123456
|
||
|
||
##服务器API接口参数是否检查时间。当设置为false时，所有的请求会检查时间的有效性；当设置为true时，可以在http.admin.secret_key保持不变的情况下，使用固定的服务API签名
|
||
##nonce = "76616", timestamp = "1558350862502", sign = "b98f9b0717f59febccf1440067a7f50d9b31bdde"
|
||
##这个地方上线前要改为false
|
||
http.admin.no_check_time true
|
||
|
||
##用来生产im token的私钥，只在服务器使用，客户端不用。正式使用时为了安全一定要修改这个值，切记切记
|
||
token.key testim
|
||
|
||
##token的过期时间，单位为毫秒，默认为无限期。如果需要设置无限期，客户端上一定需要加上token过期的处理。token过期的处理请参考文档的常见问题
|
||
##token.expire_time 2592000000
|
||
|
||
##首次登录，是否接收之前的历史消息。
|
||
##0 不接收历史消息，只接收5分钟以内的消息，由于服务器没有保存已经收取记录，所以如果有超过5分钟之前未收取的消息也不会收取下拉；
|
||
##1接收，会接收 message.max_queue 配置的条数的历史消息
|
||
message.roaming 0
|
||
|
||
##是否开启拉取远程历史消息。如果为1，客户端在会话内如果本地消息读取完了，可以下拉继续加载在服务器上的该会话的消息；如果为0则不能。
|
||
message.remote_history_message 0
|
||
|
||
##服务器为每个用户缓存的消息数量。这个值改得太大，拉取消息时间变长，另外会占用大量内存。
|
||
message.max_queue 1024
|
||
|
||
##是否禁止陌生人聊天
|
||
message.disable_stranger_chat false
|
||
|
||
##黑名单策略，0 发送失败，返回被拉黑的错误码；1 发送成功但消息被服务器直接丢弃
|
||
message.blacklist.strategy 0
|
||
|
||
##是否禁止服务器端消息搜索，该功能暂未实现。目前的影响是如果打开，则存储消息时不单独保存_searchable_content字段
|
||
message.disable_remote_search false
|
||
|
||
##是否数据库中加密消息内容。注意这个开关在服务运行起来后不能改变了，避免读取数据库时无法恢复历史消息。
|
||
##如果要避免数据库中明文存储消息内容，请打开这个开关和message.disable_remote_search开关
|
||
message.encrypt_message_content false
|
||
|
||
##允许客户端撤回用户自己发送的消息时限，单位是秒。
|
||
##Server API不受此限制，可以撤回任意时限内的消息
|
||
##群组管理员或群主撤回群成员消息不受此限制，可以撤回任意时限内的消息。但管理员或群主撤回自己的消息还是需要准守此时间限制。
|
||
##修改此参数需要同步修改客户端UI，客户端UI代码有判断撤回是否显示的逻辑。
|
||
message.recall_time_limit 120
|
||
|
||
##禁止群主/群管理员撤回群内消息，关闭时群主/群管理员可以撤回任意时间段内群内成员的消息。
|
||
message.disable_group_manager_recall false
|
||
|
||
##禁止客户端发送消息类型，消息类型以逗号分开，下面3个值为示例，可以删除。
|
||
##一般用于重要类型消息，比如交易、充值等，禁止客户端发送，仅限于服务器发送，提高安全性。
|
||
#message.forbidden_client_send_types 3999,4000,4001
|
||
|
||
## 当禁止发送消息时，允许例外发送的消息。这种一般用户需要被动回应的消息。比如群中被禁言的用户，他无法主动发起音视频，但可以接听未被禁言用户的音视频
|
||
## 因为音视频使用了消息作为信令，所以就需要允许发送音视频信令。如果开发了其它场景也需要被动回应消息，可以加在这里。
|
||
## 黑名单时允许发送的消息类型
|
||
message.blacklist_exception_types 401,402,403,404,405,407,408,410,411
|
||
## 群禁言或者聊天室或者频道禁言时允许发送的消息类型
|
||
message.group_mute_exception_types 401,402,403,404,405,407,408,410,411
|
||
## 用户被全局禁言时允许发送的消息类型
|
||
message.global_mute_exception_types 401,402,403,404,405,407,408,410,411
|
||
|
||
## 消息转发功能开启时，开关是否不转发server api接口消息。
|
||
## 当为true时，不转发server api发送的消息；当为false时，转发server api发送的消息。
|
||
message.no_forward_admin_message false
|
||
|
||
|
||
##禁止搜索用户
|
||
friend.disable_search false
|
||
|
||
##禁止按照昵称搜索用户。
|
||
friend.disable_nick_name_search false
|
||
|
||
##禁止发送好友邀请，通过server api添加好友不受此限制(force参数需要为true)
|
||
friend.disable_friend_request false
|
||
|
||
##好友请求重复发送的间隔，单位是毫秒，默认是7天，0为不限制
|
||
friend.repeat_request_duration 604800000
|
||
|
||
##好友请求被拒绝后再次发送的间隔，单位是毫秒，默认是30天，0为不限制
|
||
friend.reject_request_duration 2592000000
|
||
|
||
##好友请求过期时间，单位是毫秒，默认是7天，0为不限制
|
||
friend.request_expiration_duration 604800000
|
||
|
||
##添加好友后会发送欢迎消息，比如"你们已经是好友了，可以聊天了"。这个开关控制是用旧的方式还是用新的方式。
|
||
##旧的方式会发送notification消息（contenttype是80），内容会根据好友接收者的语言选择对应的语言，如果双方语言不一致会导致另外一方看到的不是本地语言。
|
||
##新的方式会发送添加好友消息（contenttype是93）和欢迎消息（contenttype是92），需要客户端实现这两种消息。
|
||
##如果客户端已经实现这两种消息可以打开这个开关（客户端2020.6.30添加了此消息类型）。
|
||
friend.new_welcome_message true
|
||
|
||
## 聊天室观众空闲退出时间，单位为毫秒，默认为15分钟，0为永远不退出
|
||
chatroom.participant_idle_time 900000
|
||
|
||
## 用户向聊天室发送消息，自动加入聊天室
|
||
chatroom.rejoin_when_active true
|
||
|
||
## 当一个聊天室不存在时，如果有用户加入就自动创建
|
||
chatroom.create_when_not_exist true
|
||
|
||
## 是否允许客户端发送操作群的自定义群通知消息
|
||
group.allow_client_custom_operation_notification true
|
||
|
||
## 当群成员退出或者被移除时，是否同时给管理员和相关人员发送显式通知消息。
|
||
## 0 不发送，1 退群时发送，2 踢人时发送，3 退群和踢人时都发送。
|
||
group.visible_quit_or_kickoff_notification 0
|
||
|
||
## 隐藏用户信息属性类型，2是性别，3是电话号码，4是邮箱，5是地址，6是公司信息，7是社交账号，8是Extra信息。当需要隐藏多个时以英文逗号分开;
|
||
## 本配置是为了提高安全性，避免把对应信息同步到客户端，这样就能防止程序被破解从而拿到用户关键信息。仅对客户端有效，server api不受影响。
|
||
## 注意，修改本配置不会对已经同步的信息产生影响。
|
||
#user.hide_properties 3,4,5
|
||
|
||
# 好友/好友请求/用户设置 这三类数据同步的最大条目数。之前是客户第一次登录时，会把所有的对应数据一次下载到客户端，但如果有特别多的信息，会导致无法同步到客户端，
|
||
# 因此需要分段多次同步，此开关定义了每次同步的数据的条数。此需要客户端支持，客户端SDK在2021.5.25日后支持此功能。如果确认所有客户端都在这个日志之后才可以打开此设置。
|
||
#sync.data_part_size 1000
|
||
|
||
#*********************************************************************
|
||
# hazelcase configuration
|
||
#*********************************************************************
|
||
hazelcast.configuration config/hazelcast.xml
|
||
|
||
#*********************************************************************
|
||
# Media server configuration
|
||
#*********************************************************************
|
||
##是否使用七牛云存储。1使用七牛；0使用内存文件服务器。默认的七牛账户信息不可用，请在七牛官网申请账户并配置
|
||
##专业版另外支持阿里云存储和野火私有存储，关于野火私有存储请参考：https://github.com/wildfirechat/WF-minio
|
||
##关于对象存储的详细信息请参考：https://docs.wildfirechat.cn/server/oss.html
|
||
media.server.use_qiniu 0
|
||
|
||
##媒体类型分类
|
||
#Media_Type_GENERAL = 0,
|
||
#Media_Type_IMAGE = 1,
|
||
#Media_Type_VOICE = 2,
|
||
#Media_Type_VIDEO = 3,
|
||
#Media_Type_FILE = 4,
|
||
#Media_Type_PORTRAIT = 5,
|
||
#Media_Type_FAVORITE = 6
|
||
|
||
# qiniu media server configuration
|
||
qiniu.server_url http://up.qbox.me
|
||
qiniu.access_key tU3vdBK5BL5j4N7jI5N5uZgq_HQDo170w5C9Amnn
|
||
qiniu.secret_key YfQIJdgp5YGhwEw14vGpaD2HJZsuJldWtqens7i5
|
||
qiniu.bucket_general_name media
|
||
qiniu.bucket_general_domain http://pghnpyzos.bkt.clouddn.com
|
||
qiniu.bucket_image_name media
|
||
qiniu.bucket_image_domain http://pghnpyzos.bkt.clouddn.com
|
||
qiniu.bucket_voice_name media
|
||
qiniu.bucket_voice_domain http://pghnpyzos.bkt.clouddn.com
|
||
qiniu.bucket_video_name media
|
||
qiniu.bucket_video_domain http://pghnpyzos.bkt.clouddn.com
|
||
qiniu.bucket_file_name media
|
||
qiniu.bucket_file_domain http://pghnpyzos.bkt.clouddn.com
|
||
qiniu.bucket_sticker_name media
|
||
qiniu.bucket_sticker_domain http://pghnpyzos.bkt.clouddn.com
|
||
qiniu.bucket_moments_name media
|
||
qiniu.bucket_moments_domain http://pghnpyzos.bkt.clouddn.com
|
||
qiniu.bucket_portrait_name storage
|
||
qiniu.bucket_portrait_domain http://cdn2.wildfirechat.cn
|
||
qiniu.bucket_favorite_name storage
|
||
qiniu.bucket_favorite_domain http://cdn2.wildfirechat.cn
|
||
|
||
|
||
# local media server configuration
|
||
# 本地媒体服务器配置。
|
||
local.media.storage.root media
|
||
# 如果使用内置文件存储，文件上传后地址默认为 http://server.ip:http_port/fs/5/2021/03/27/08/filename。
|
||
# 如果需要使用nginx添加https支持，请打开下面配置，这样客户端得到的文件地址为 https://example.com/media/fs/5/2021/03/27/08/filename。
|
||
# 需要nginx把请求从https://example.com/media/fs 转到 http://server.ip:http_port/fs。注意需要带上所有header。
|
||
# 尽管内置文件存储可以使用，但是我们还是建议使用专业级别的对象存储服务，社区版可以使用七牛，专业版另外支持阿里云和也是私有对象存储。详情请参考 https://docs.wildfirechat.cn/server/oss.html
|
||
# local.media.storage.remote_server_url https://example.com/media
|
||
|
||
# 是否支持任意多端登陆，为true时支持任意平台任意多个客户端同时登录；为false时每个平台只支持一个端登录，但不同平台可以同时登录。
|
||
# Android/iOS为移动平台，windows/mac/linux为pc平台，web为web平台，小程序为小程序平台。
|
||
# 建议使用false
|
||
server.multi_endpoint false
|
||
|
||
# 多平台连接状态通知（仅当multi_endpoint为false时有效），true时移动端可以收到pc或web端登录的通知。
|
||
server.multi_platform_notification true
|
||
|
||
# 当pc或者web在线时，手机是否默认静音，默认为true。注意仅影响默认值，用户可以手动切换是否静音。
|
||
# 如果这里改为false，客户端那边需要同步修改pc在线默认通知状态，方法是client的setDefaultSilentWhenPcOnline函数。
|
||
server.mobile_default_silent_when_pc_online true
|
||
|
||
## 客户端是否支持kickoff事件。当客户端被其他端登录踢出时，如果此开关为false时，客户端协议栈上报secret_mismatch。如果此开关为ture时，客户端协议栈上报kicked_off。
|
||
## 客户端被踢时上报kicked_off是在2021.9.15之后才加上的。如果客户端协议栈全部为此日期之后的版本才可以打开此开关。
|
||
server.client_support_kickoff_event false
|
||
|
||
#*********************************************************************
|
||
# Push server configuration
|
||
#*********************************************************************
|
||
##推送服务项目地址：https://github.com/wildfirechat/push_server。
|
||
##安卓推送服务器地址
|
||
##注意回调是单线程回调，接收服务必须在同一内网，且异步处理快速返回，否则会有延迟问题！！
|
||
push.android.server.address http://localhost:8085/android/push
|
||
|
||
##苹果推送服务器地址
|
||
##注意回调是单线程回调，接收服务必须在同一内网，且异步处理快速返回，否则会有延迟问题！！
|
||
push.ios.server.address http://localhost:8085/ios/push
|
||
|
||
#*********************************************************************
|
||
# 监控配置
|
||
#*********************************************************************
|
||
##异常事件产生回调
|
||
##注意回调是单线程回调，接收服务必须在同一内网，且异步处理快速返回，否则会有延迟问题！！
|
||
#monitor.exception_event_address http://localhost:8888/im_exception_event/
|
||
|
||
#*********************************************************************
|
||
# 各种事件回调
|
||
#*********************************************************************
|
||
##用户在线状态事件回调地址
|
||
##注意回调是单线程回调，接收服务必须在同一内网，且异步处理快速返回，否则会有延迟问题！！
|
||
#user.online_status_callback http://localhost:8888/im_event/user/online
|
||
|
||
##用户信息变动事件回调地址
|
||
##注意回调是单线程回调，接收服务必须在同一内网，且异步处理快速返回，否则会有延迟问题！！
|
||
#relation.relation_update_callback http://localhost:8888/im_event/user/relation
|
||
|
||
##用户信息变动事件回调地址
|
||
##注意回调是单线程回调，接收服务必须在同一内网，且异步处理快速返回，否则会有延迟问题！！
|
||
#user.user_info_update_callback http://localhost:8888/im_event/user/info
|
||
|
||
##消息转发地址
|
||
##注意回调是单线程回调，接收服务必须在同一内网，且异步处理快速返回，否则会有延迟问题！！
|
||
#message.forward.url http://localhost:8888/im_event/message
|
||
##需要转发的消息类型，当有多个时以英文逗号分割。如果转发所有消息，请注释掉配置或者设置为空
|
||
#message.forward.types 1,2,3
|
||
|
||
##提醒消息转发地址，@全体用户和@某个用户消息会回调此地址。此转发不受${message.forward.types}限制。
|
||
##注意回调是单线程回调，接收服务必须在同一内网，且异步处理快速返回，否则会有延迟问题！！
|
||
#message.mentionmsg.forward.url http://localhost:8888/im_event/message
|
||
|
||
|
||
##设备信息转发地址
|
||
##注意回调是单线程回调，接收服务必须在同一内网，且异步处理快速返回，否则会有延迟问题！！
|
||
#things_message.forward.url http://localhost:8888/im_event/things/message
|
||
|
||
##群组信息变动事件回调地址
|
||
##注意回调是单线程回调，接收服务必须在同一内网，且异步处理快速返回，否则会有延迟问题！！
|
||
#group.group_info_update_callback http://localhost:8888/im_event/group/info
|
||
|
||
##群组信息变动事件回调地址
|
||
##注意回调是单线程回调，接收服务必须在同一内网，且异步处理快速返回，否则会有延迟问题！！
|
||
#group.group_member_update_callback http://localhost:8888/im_event/group/member
|
||
|
||
##频道信息变动回调地址
|
||
##注意回调是单线程回调，接收服务必须在同一内网，且异步处理快速返回，否则会有延迟问题！！
|
||
#channel.channel_info_update_callback http://localhost:8888/im_event/channel/info
|
||
|
||
##聊天室信息变动回调地址
|
||
##注意回调是单线程回调，接收服务必须在同一内网，且异步处理快速返回，否则会有延迟问题！！
|
||
#chatroom.chatroom_info_update_callback http://localhost:8888/im_event/chatroom/info
|
||
|
||
##聊天室成员变动回调地址
|
||
##注意回调是单线程回调，接收服务必须在同一内网，且异步处理快速返回，否则会有延迟问题！！
|
||
#chatroom.chatroom_member_update_callback http://localhost:8888/im_event/chatroom/member
|
||
|
||
#*********************************************************************
|
||
# Sensitive configuration
|
||
#*********************************************************************
|
||
## 内置文本敏感词过滤处理方法，0 发送失败；1 发送成功但消息被服务器直接丢弃；2 命中的敏感词被替换成***；3 记录并继续发送
|
||
sensitive.filter.type 0
|
||
|
||
## 如果内置敏感词库无法满足您的需求，可以自己开发部署敏感词审核服务。配置如下地址和消息类型，IM服务会把指定消息类型的消息回调到指定地址
|
||
## 审核服务返回状态码200表示继续发送，如果需要替换内容，返回状态码200并且内容为替换后的内容。返回403表示不允许发送。其它错误继续发送。
|
||
## 独立审核服务地址，IM服务会post SendMessageData。如果需要修改消息内容，返回 MessagePayload。请参考应用服务中 "/message/censor" Mapping.
|
||
#sensitive.remote_server_url http://192.168.3.202:8888/message/censor
|
||
## 需要进行敏感词审核的消息类型，当有多个时以英文逗号分割
|
||
#sensitive.remote_sensitive_message_type 1,2,3
|
||
## 如果远程审核服务返回403，返回给发送端发送失败还是成功？实际上这个值影响发送响应是否等待审核结果，当为false时，消息发送给审核服务就立即返回成功给客户端。
|
||
## 当为true时，消息发送给审核服务，等待审核结果，如果结果为继续发送就返回给客户端为成功，结果为禁止发送就返回失败给客户端。
|
||
## 客户端操作的超时一般为10s左右，且考虑到复杂的网络情况，建议处理时间不要超过3s。建议这个值为false。
|
||
#sensitive.remote_fail_when_matched false
|