leftyer/WuKongIM
1
0
Fork 0
mirror of https://gitee.com/WuKongDev/WuKongIM.git synced 2025-12-06 14:59:08 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: update example config

Browse Source
This commit is contained in:
tt
2025-08-11 08:42:42 +08:00
parent bf21a6ba31
commit 331c90179f
2 changed files with 34 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
config/wk.yaml
View File

@@ -16,7 +16,7 @@ external: # 公网配置
# tcpAddr: "" # 默认自动获取， 节点的TCP地址 对外公开，APP端长连接通讯 格式： ip:port
# wsAddr: "" # 默认自动获取， 节点的wsAdd地址 对外公开 WEB端长连接通讯 格式： ws://ip:port （支持域名配置）
# wssAddr: "" # 对外的wssAddr地址，也就是客户端真正连接的地址 格式：wss://ip:port （支持域名配置）
# monitorAddr: "" # 默认自动获取， 节点的monitor地址 对外公开 监控服务 格式： ip:port
# managerAddr: "" # 默认自动获取， 节点的manager地址 对外公开 监控服务 格式： ip:port
# apiUrl: "" # 默认自动获取， 节点的http地址 对外公开 http api 格式： http://ip:port
#wssConfig:
# certFile: "" # wss证书文件路径
@@ -26,9 +26,9 @@ external: # 公网配置
# level: 0 # 日志级别 0:未配置,将根据mode属性判断 1:debug 2:info 3:warn 4:error
# dir: "./logs" # 日志目录
# lineNum: false # 是否打印行号
#monitor:
# on: true # 是否开启监控
# addr: "0.0.0.0:5300" # 监控监听地址 默认为 0.0.0.0:5300
#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

31
docs/openapi.json
View File

@@ -2187,6 +2187,7 @@
"properties": {
"uid": {
"type": "string",
"description": "User ID",
"example": "user123"
},
"version": {
@@ -2195,10 +2196,32 @@
"example": 1640995200000000000,
"description": "Version timestamp for incremental sync"
},
"last_msg_seqs": {
"type": "string",
"description": "Client's last message sequences for all conversations. Format: channelID:channelType:last_msg_seq|channelID:channelType:last_msg_seq",
"example": "user1:1:100|group1:2:200"
},
"msg_count": {
"type": "integer",
"format": "int64",
"example": 10,
"description": "Number of recent messages to include"
"description": "Number of recent messages to include per conversation"
},
"only_unread": {
"type": "integer",
"format": "uint8",
"description": "Only return unread conversations (1=only unread, 0=all)",
"enum": [0, 1],
"default": 0
},
"exclude_channel_types": {
"type": "array",
"items": {
"type": "integer",
"format": "uint8"
},
"description": "Array of channel types to exclude from results",
"example": [3, 4]
}
}
},
@@ -2785,6 +2808,12 @@
"description": "User ID",
"example": "user123"
},
"message_seq": {
"type": "integer",
"format": "uint64",
"description": "Client's maximum message sequence number for incremental sync",
"example": 12345
},
"limit": {
"type": "integer",
"description": "Maximum number of messages to sync",