服务器配置

# 基础服务器配置
mode: "release"                       # 运行模式：debug(测试), release(正式), bench(压力测试)
tokenAuthOn: false                    # 是否开启token验证，默认为false，如果不开启任何人都可以连接到此节点，生产环境建议开启
managerUID: ""                        # 管理员UID，默认为 ____manager
managerToken: ""                      # 管理员token，如果此字段有值，则API接口需要在请求头中添加token字段，值为此字段的值
addr: "tcp://0.0.0.0:5100"           # TCP监听地址
httpAddr: "0.0.0.0:5001"             # HTTP API的监听地址，默认：0.0.0.0:5001
wsAddr: "ws://0.0.0.0:5200"          # WebSocket ws 监听地址
wssAddr: "wss://0.0.0.0:5210"        # WebSocket wss 监听地址，如果打开则需要进行 wssConfig相关的证书配置
rootDir: "./wukongimdata"             # 数据存储目录
ginMode: "release"                    # Gin框架的模式：debug(调试), release(正式), test(测试)
deadlockCheck: false                  # 是否开启死锁检测
pprofOn: false                        # 是否开启pprof
whitelistOffOfPerson: true            # 是否关闭个人白名单，默认为true表示关闭个人白名单的验证

# 公网配置
external:
  ip: ""                              # 节点外网IP，客户端能够访问到的IP地址，如果客户端是内网使用，这里也可以填写内网IP
  tcpAddr: ""                         # 默认自动获取，节点的TCP地址对外公开，APP端长连接通讯，格式：ip:port
  wsAddr: ""                          # 默认自动获取，节点的wsAddr地址对外公开，WEB端长连接通讯，格式：ws://ip:port（支持域名配置）
  wssAddr: ""                         # 对外的wssAddr地址，也就是客户端真正连接的地址，格式：wss://ip:port（支持域名配置）
  managerAddr: ""                     # 默认自动获取，节点的manager地址对外公开，管理后台服务，格式：ip:port
  apiUrl: ""                          # 默认自动获取，节点的http地址对外公开，http api，格式：http://ip:port

# WSS证书配置
wssConfig:
  certFile: ""                        # wss证书文件路径
  keyFile: ""                         # wss证书key文件路径

# 日志配置
logger:
  level: 0                            # 日志级别：0(未配置,将根据mode属性判断), 1(debug), 2(info), 3(warn), 4(error)
  dir: "./logs"                       # 日志目录
  lineNum: false                      # 是否打印行号

# 管理后台配置
manager:
  on: true                            # 是否开启管理后台
  addr: "0.0.0.0:5300"               # 管理后台监听地址，默认为 0.0.0.0:5300

# 演示界面配置
demo:
  on: true                            # 是否开启demo
  addr: "0.0.0.0:5172"               # demo监听地址，默认为 0.0.0.0:5172

# 频道配置
channel:
  cacheCount: 1000                    # 频道缓存数量，频道被加载后会缓存到内存中，如果频道数量过多，会占用大量内存，可以通过此配置限制缓存数量
  createIfNoExist: true               # 频道不存在时是否自动创建，默认为true
  subscriberCompressOfCount: 0        # 订阅者数多大开始压缩，如果开启默认采用gzip压缩（离线推送的时候订阅者数组太大可以设置此参数进行压缩，默认为0表示不压缩）

# 临时频道配置
tmpChannel:
  suffix: "@tmp"                      # 临时频道后缀，带有此后缀的频道将被认为是临时频道，临时频道不会被持久化
  cacheCount: 500                     # 临时频道缓存数量

# 认证配置
auth:
  on: true                            # 是否开启认证
  kind: "jwt"                         # 认证方式：jwt(jwt认证), none(无需认证)
  # 用户配置
  # 用户名:密码:资源:权限 *表示通配符，资源格式也可以是[资源ID:权限]
  # 例如: "admin:pwd:[clusterchannel:rw]" 表示admin用户密码为pwd对clusterchannel资源有读写权限
  # "admin:pwd:*" 表示admin用户密码为pwd对所有资源有读写权限
  users:
    - "admin:pwd:*"                   # 管理员用户
    - "guest:guest:[*:r]"             # guest用户密码为guest对所有资源有读权限

# JWT配置
jwt:
  secret: ""                          # jwt密钥，这个配置比较重要，需要自己生成一个随机字符串（建议随机的32位字符串），用于jwt的加密
  expire: "30d"                       # jwt过期时间，默认为30天

# webhook配置，两者配其一即可，用于接收消息通知事件，详情请查看文档
webhook:
  httpAddr: ""                        # webhook的http地址，通过此地址通知数据给第三方，地址为你提供的api接口地址
  grpcAddr: ""                        # webhook的grpc地址，当前httpAddr成为瓶颈的时候可以用grpc进行推送，如果此地址有值则不会再调用httpAddr配置的地址，格式为 ip:port，通讯协议请查看文档
  msgNotifyEventPushInterval: "500ms" # 消息通知事件推送间隔，默认500毫秒发起一次推送
  msgNotifyEventRetryMaxCount: 5      # 消息通知事件消息推送失败最大重试次数，默认为5次，超过将丢弃
  msgNotifyEventCountPerPush: 100     # 每次webhook消息通知事件推送消息数量限制，默认一次请求最多推送100条
  focusEvents:                        # 关注的事件类型，如果没有配置则推送所有事件类型
    - "msg.offline"
    - "msg.notify"
    - "user.onlinestatus"

# 最近会话配置
conversation:
  on: true                            # 是否开启最近会话
  cacheExpire: "1d"                   # 最近会话缓存过期时间，默认为1天（注意：这里指清除内存里的最近会话缓存，并不表示清除最近会话）
  syncInterval: "5m"                  # 最近会话保存间隔，每隔指定的时间进行保存一次，默认为5分钟
  syncOnce: 100                       # 最近会话同步保存一次的数量，超过指定未保存的数量将进行保存，默认为100
  userMaxCount: 1000                  # 用户最近会话最大数量，超过此数量的最近会话后最旧的那条将被覆盖掉，默认为1000

# 消息重试配置
messageRetry:
  interval: "60s"                     # 消息重试间隔，默认为60秒
  scanInterval: "5s"                  # 消息重试扫描间隔，默认为5秒
  maxCount: 5                         # 消息重试最大次数，默认为5次

# 用户消息队列配置
userMsgQueueMaxSize: 0                # 用户消息队列最大大小，0为不限制，默认为0

# 数据追踪配置
trace:
  prometheusApiUrl: ""                # prometheus的api地址，用于获取监控数据，如果不配置则不会获取监控数据

# 集群配置
cluster:
  nodeId: 1001                        # 节点ID，每个节点的ID必须唯一，默认为1001
  addr: "tcp://0.0.0.0:11110"        # 分布式通讯监听地址，默认为tcp://0.0.0.0:11110
  serverAddr: ""                      # 节点的分布式通讯对外地址，其他节点连接此节点的地址，如果为空则使用addr的配置
  apiUrl: ""                          # 节点的http api对外地址，如果为空则使用httpAddr的配置
  slotCount: 64                       # 槽位数量，整个集群的槽位数量，所有节点的此配置必须一致，默认为64
  slotReplicaCount: 3                 # 槽位副本数量，每个槽位的副本数量，默认为3
  channelReplicaCount: 3              # 频道副本数量，每个频道的副本数量，默认为3
  initNodes:                          # 初始节点列表，集群启动时的初始节点列表
    - "1001@192.168.1.12:11110"
    - "1002@192.168.1.13:11110"
    - "1003@192.168.1.14:11110"
  seed:                               # 集群种子节点，集群启动时的种子节点列表，用于节点发现
    - "1001@192.168.1.12:11110"

# 插件配置
plugin:
  socketPath: "./wukongimdata/1/wukongim.sock"  # 插件的unix socket地址，用于与插件通讯
  install:                                      # 默认安装的插件列表，启动时会自动安装这些插件
    - "https://gitee.com/WuKongDev/plugins/releases/download/latest/wk.plugin.ai-example-${os}-${arch}.wkp"
    - "https://gitee.com/WuKongDev/plugins/releases/download/latest/wk.plugin.ai-volcengine-${os}-${arch}.wkp"