配置
go-cqhttp 包含 config.yml
和 device.json
两个配置文件, 其中 config.yml
为运行配置 device.json
为虚拟设备信息。
config.yml
会在首次运行 go-cqhttp 的时候自动生成,device.json
会在首次登陆账户的时候自动生成。
配置信息
默认生成的运行配置文件 config.yml
如下所示:
# go-cqhttp 默认配置文件
account: # 账号相关
uin: 1233456 # QQ账号
password: '' # 密码为空时使用扫码登录
encrypt: false # 是否开启密码加密
status: 0 # 在线状态 请参考 https://docs.go-cqhttp.org/guide/config.html#在线状态
relogin: # 重连设置
delay: 3 # 首次重连延迟, 单位秒
interval: 3 # 重连间隔
max-times: 0 # 最大重连次数, 0为无限制
# 是否使用服务器下发的新地址进行重连
# 注意, 此设置可能导致在海外服务器上连接情况更差
use-sso-address: true
# 是否允许发送临时会话消息
allow-temp-session: false
# 数据包的签名服务器
# 兼容 https://github.com/fuqiuluo/unidbg-fetch-qsign
# 暂不支持最新版qsign服务可用(v1.1.0)
# 如果遇到 登录 45 错误, 或者发送信息风控的话需要填入一个服务器
# 示例:
# sign-server: 'http://127.0.0.1:8080' # 本地签名服务器
# sign-server: 'https://signserver.example.com' # 线上签名服务器
# 服务器可使用docker在本地搭建或者使用他人开放的服务
# 不建议使用公共服务器, 有封号风险
sign-server: '-'
heartbeat:
# 心跳频率, 单位秒
# -1 为关闭心跳
interval: 5
message:
# 上报数据类型
# 可选: string,array
post-format: string
# 是否忽略无效的CQ码, 如果为假将原样发送
ignore-invalid-cqcode: false
# 是否强制分片发送消息
# 分片发送将会带来更快的速度
# 但是兼容性会有些问题
force-fragment: false
# 是否将url分片发送
fix-url: false
# 下载图片等请求网络代理
proxy-rewrite: ''
# 是否上报自身消息
report-self-message: false
# 移除服务端的Reply附带的At
remove-reply-at: false
# 为Reply附加更多信息
extra-reply-data: false
# 跳过 Mime 扫描, 忽略错误数据
skip-mime-scan: false
output:
# 日志等级 trace,debug,info,warn,error
log-level: warn
# 日志时效 单位天. 超过这个时间之前的日志将会被自动删除. 设置为 0 表示永久保留.
log-aging: 15
# 是否在每次启动时强制创建全新的文件储存日志. 为 false 的情况下将会在上次启动时创建的日志文件续写
log-force-new: true
# 是否启用日志颜色
log-colorful: true
# 是否启用 DEBUG
debug: false # 开启调试模式
# 默认中间件锚点
default-middlewares: &default
# 访问密钥, 强烈推荐在公网的服务器设置
access-token: ''
# 事件过滤器文件目录
filter: ''
# API限速设置
# 该设置为全局生效
# 原 cqhttp 虽然启用了 rate_limit 后缀, 但是基本没插件适配
# 目前该限速设置为令牌桶算法, 请参考:
# https://baike.baidu.com/item/%E4%BB%A4%E7%89%8C%E6%A1%B6%E7%AE%97%E6%B3%95/6597000?fr=aladdin
rate-limit:
enabled: false # 是否启用限速
frequency: 1 # 令牌回复频率, 单位秒
bucket: 1 # 令牌桶大小
database: # 数据库相关设置
leveldb:
# 是否启用内置leveldb数据库
# 启用将会增加10-20MB的内存占用和一定的磁盘空间
# 关闭将无法使用 撤回 回复 get_msg 等上下文相关功能
enable: true
# 媒体文件缓存, 删除此项则使用缓存文件(旧版行为)
cache:
image: data/image.db
video: data/video.db
# 连接服务列表
servers:
# 添加方式,同一连接方式可添加多个,具体配置说明请查看文档
#- http: # http 通信
#- ws: # 正向 Websocket
#- ws-reverse: # 反向 Websocket
#- pprof: #性能分析服务器
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
servers
部分参考配置:
servers:
- http: # HTTP 通信设置
address: 0.0.0.0:5700 # HTTP监听地址
timeout: 5 # 反向 HTTP 超时时间, 单位秒,<5 时将被忽略
long-polling: # 长轮询拓展
enabled: false # 是否开启
max-queue-size: 2000 # 消息队列大小,0 表示不限制队列大小,谨慎使用
middlewares:
<<: *default # 引用默认中间件
post: # 反向HTTP POST地址列表
#- url: '' # 地址
# secret: '' # 密钥
# max-retries: 3 # 最大重试,0 时禁用
# retries-interval: 1500 # 重试时间,单位毫秒,0 时立即
#- url: http://127.0.0.1:5701/ # 地址
# secret: '' # 密钥
# max-retries: 10 # 最大重试,0 时禁用
# retries-interval: 1000 # 重试时间,单位毫秒,0 时立即
# LambdaServer 配置
- lambda:
type: scf # scf: 腾讯云函数 aws: aws Lambda
middlewares:
<<: *default # 引用默认中间件
# 正向WS设置
- ws:
# 正向WS服务器监听地址
address: 0.0.0.0:8080
middlewares:
<<: *default # 引用默认中间件
# 反向WS设置
- ws-reverse:
# 反向WS Universal 地址
# 注意 设置了此项地址后下面两项将会被忽略
universal: ws://your_websocket_universal.server
# 反向WS API 地址
api: ws://your_websocket_api.server
# 反向WS Event 地址
event: ws://your_websocket_event.server
# 重连间隔 单位毫秒
reconnect-interval: 3000
middlewares:
<<: *default # 引用默认中间件
# 可添加更多
#- ws-reverse:
#- ws:
#- http:
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
提示
开启密码加密后程序将在每次启动时要求输入解密密钥, 密钥错误会导致登录时提示密码错误.
解密后密码将储存在内存中, 用于自动重连等功能. 所以此加密并不能防止内存读取.
解密密钥在使用完成后并不会留存在内存中, 所以可用相对简单的字符串作为密钥.
提示
分片发送为原酷Q发送长消息的老方案, 发送速度更优/兼容性更好
但在有发言频率限制的群里,可能无法发送。
关闭后将优先使用新方案, 能发送更长的消息,
但发送速度更慢,在部分老客户端将无法解析.
提示
对于不需要的通信方式,你可以使用注释将其停用(推荐),或者添加配置 disabled: true
将其关闭
注意
关闭心跳服务可能引起断线, 请谨慎关闭
环境变量
go-cqhttp 配置文件可以使用占位符来读取环境变量的值。
account: # 账号相关
uin: ${CQ_UIN} # 读取环境变量 CQ_UIN
password: ${CQ_PWD:123456} # 当 CQ_PWD 为空时使用默认值 123456
2
3
在线状态
状态 | 值 |
---|---|
在线 | 0 |
离开 | 1 |
隐身 | 2 |
忙 | 3 |
听歌中 | 4 |
星座运势 | 5 |
今日天气 | 6 |
遇见春天 | 7 |
Timi中 | 8 |
吃鸡中 | 9 |
恋爱中 | 10 |
汪汪汪 | 11 |
干饭中 | 12 |
学习中 | 13 |
熬夜中 | 14 |
打球中 | 15 |
信号弱 | 16 |
在线学习 | 17 |
游戏中 | 18 |
度假中 | 19 |
追剧中 | 20 |
健身中 | 21 |
设备信息
默认生成的虚拟设备信息文件 device.json
如下所示:
{
"protocol": 0,
"display": "xxx",
"product": "xxx",
"device": "xxx",
"board": "xxx",
"model": "xxx",
"finger_print": "xxx",
"boot_id": "xxx",
"proc_version": "xxx",
"imei": "xxx",
"brand": "xxx",
"bootloader": "xxx",
"base_band": "",
"version": {
"incremental": "xxx",
"release": "xxx",
"codename": "xxx",
"sdk": 0 // 随机
},
"sim_info": "xxx",
"os_type": "xxx",
"mac_address": "xxx",
"ip_address": [
// ...
],
"wifi_bssid": "xxx",
"wifi_ssid": "xxx",
"imsi_md5": "xxx",
"android_id": "xxx",
"apn": "xxx",
"vendor_name": "xxx",
"vendor_os_name": "xxx"
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
在大部分情况下 我们只需要关心 protocol
字段:
值 | 类型 | 限制 |
---|---|---|
0 | Default/Unset | 当前版本下默认为iPad |
1 | Android Phone | 无 |
2 | Android Watch | 无法接收 notify 事件、无法接收口令红包、无法接收撤回消息 |
3 | MacOS | 无 |
4 | 企点 | 只能登录企点账号或企点子账号 |
5 | iPad | 无 |
6 | aPad | 无 |
注意
根据协议的不同, 各类消息有所限制
自定义服务器IP
提示
某些海外服务器使用默认地址可能会存在链路问题, 此功能可以指定 go-cqhttp 连接哪些地址以达到最优化.
提示
假如你在使用 use-sso-address
后依然登录失败,可尝试开启 debug
模式后透过查看记录 got new server addr: aaa.bbb.ccc.ddd location: xxxx
来获得服务器IP,然后手动输入 aaa.bbb.ccc.ddd:xxxx
到 address.txt
将文件 address.txt
创建到 go-cqhttp
工作目录, 并键入 IP:PORT
以换行符为分割即可.
示例:
1.1.1.1:53
1.1.2.2:8899
2
云函数部署
使用CustomRuntime进行部署, bootstrap 文件在 scripts/bootstrap 中已给出。 在部署前,请在本地完成登录,并将 config.yml
, device.json
,bootstrap
和 go-cqhttp
一起打包。
在触发器中创建一个 API 网关触发器,并启用集成响应, 创建完成后即可通过api网关访问 go-cqhttp
(建议配置 AccessToken)。
scripts/bootstrap
中使用的工作路径为 /tmp, 这个目录最大能容下 500M 文件, 如需长期使用, 请挂载文件存储(CFS).