Skip to content

Commit

Permalink
Merge pull request #141 from Janet-Baker/main
Browse files Browse the repository at this point in the history
docs: 同步dev版配置文件
  • Loading branch information
ishkong authored Oct 9, 2023
2 parents cbf832c + 626b571 commit b50ee1d
Showing 1 changed file with 57 additions and 13 deletions.
70 changes: 57 additions & 13 deletions docs/guide/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,17 +27,56 @@ account: # 账号相关
# 是否允许发送临时会话消息
allow-temp-session: false


# 数据包的签名服务器
# 数据包的签名服务器列表,第一个作为主签名服务器,后续作为备用
# 兼容 https://github.com/fuqiuluo/unidbg-fetch-qsign
# 暂不支持最新版qsign服务可用(v1.1.0)
# 如果遇到 登录 45 错误, 或者发送信息风控的话需要填入一个服务器
# 如果遇到 登录 45 错误, 或者发送信息风控的话需要填入一个或多个服务器
# 不建议设置过多,设置主备各一个即可,超过 5 个只会取前五个
# 示例:
# sign-server: 'http://127.0.0.1:8080' # 本地签名服务器
# sign-server: 'https://signserver.example.com' # 线上签名服务器
# sign-servers:
# - url: 'http://127.0.0.1:8080' # 本地签名服务器
# key: "114514" # 相应 key
# authorization: "-" # authorization 内容, 依服务端设置
# - url: 'https://signserver.example.com' # 线上签名服务器
# key: "114514"
# authorization: "-"
# ...
#
# 服务器可使用docker在本地搭建或者使用他人开放的服务
# 不建议使用公共服务器, 有封号风险
sign-server: '-'
sign-servers:
- url: '-' # 主签名服务器地址, 必填
key: '114514' # 签名服务器所需要的apikey, 如果签名服务器的版本在1.1.0及以下则此项无效
authorization: '-' # authorization 内容, 依服务端设置,如 'Bearer xxxx'
- url: '-' # 备用
key: '114514'
authorization: '-'

# 判断签名服务不可用(需要切换)的额外规则
# 0: 不设置 (此时仅在请求无法返回结果时判定为不可用)
# 1: 在获取到的 sign 为空 (若选此建议关闭 auto-register,一般为实例未注册但是请求签名的情况)
# 2: 在获取到的 sign 或 token 为空(若选此建议关闭 auto-refresh-token )
rule-change-sign-server: 1

# 连续寻找可用签名服务器最大尝试次数
# 为 0 时会在连续 3 次没有找到可用签名服务器后保持使用主签名服务器,不再尝试进行切换备用
# 否则会在达到指定次数后 **退出** 主程序
max-check-count: 0
# 签名服务请求超时时间(s)
sign-server-timeout: 60
# 如果签名服务器的版本在1.1.0及以下, 请将下面的参数改成true
# 建议使用 1.1.6 以上版本,低版本普遍半个月冻结一次
is-below-110: false
# 在实例可能丢失(获取到的签名为空)时是否尝试重新注册
# 为 true 时,在签名服务不可用时可能每次发消息都会尝试重新注册并签名。
# 为 false 时,将不会自动注册实例,在签名服务器重启或实例被销毁后需要重启 go-cqhttp 以获取实例
# 否则后续消息将不会正常签名。关闭此项后可以考虑开启签名服务器端 auto_register 避免需要重启
# 由于实现问题,当前建议关闭此项,推荐开启签名服务器的自动注册实例
auto-register: false
# 是否在 token 过期后立即自动刷新签名 token(在需要签名时才会检测到,主要防止 token 意外丢失)
# 独立于定时刷新
auto-refresh-token: false
# 定时刷新 token 间隔时间,单位为分钟, 建议 30~40 分钟, 不可超过 60 分钟
# 目前丢失token也不会有太大影响,可设置为 0 以关闭,推荐开启
refresh-interval: 40

heartbeat:
# 心跳频率, 单位秒
Expand Down Expand Up @@ -66,6 +105,10 @@ message:
extra-reply-data: false
# 跳过 Mime 扫描, 忽略错误数据
skip-mime-scan: false
# 是否自动转换 WebP 图片
convert-webp-image: false
# download 超时时间(s)
http-timeout: 15

output:
# 日志等级 trace,debug,info,warn,error
Expand Down Expand Up @@ -101,11 +144,12 @@ database: # 数据库相关设置
# 启用将会增加10-20MB的内存占用和一定的磁盘空间
# 关闭将无法使用 撤回 回复 get_msg 等上下文相关功能
enable: true

# 媒体文件缓存, 删除此项则使用缓存文件(旧版行为)
cache:
image: data/image.db
video: data/video.db
sqlite3:
# 是否启用内置sqlite3数据库
# 启用将会增加一定的内存占用和一定的磁盘空间
# 关闭将无法使用 撤回 回复 get_msg 等上下文相关功能
enable: false
cachettl: 3600000000000 # 1h

# 连接服务列表
servers:
Expand Down

0 comments on commit b50ee1d

Please sign in to comment.