app/docs/deployment/config.md
2024-07-21 00:40:55 +08:00

2.6 KiB
Raw Permalink Blame History

title icon order category tag
配置 cog 2 使用指南
配置
部署

首次运行后生成config.yml,你可以修改配置项后重启轻雪,绝大多数情况下,你只需要修改superusersnickname字段即可

基础配置项

command_start: [ "/", "" ] # 指令前缀,若没有""空命令头请开启alconna_use_command_start保证alconna解析正常
host: 127.0.0.1 # 监听地址默认为本机若要接收外部请求请填写0.0.0.0
port: 20216 # 绑定端口
nickname: [ "liteyuki" ]  # 机器人昵称列表
superusers: [ "1919810" ]  # 超级用户列表

其他配置

以下为默认值,如需自定义请手动添加

onebot_access_token: "" # 访问令牌,对公开放时建议设置
default_language: "zh-CN" # 默认语言
alconna_auto_completion: false # alconna是否自动补全指令默认false建议开启
# 开发者选项
allow_update: true # 是否允许更新
log_level: "INFO" # 日志等级
log_icon: true # 是否显示日志等级图标(某些控制台字体不可用)
auto_report: true # 是否自动上报问题给轻雪服务器
auto_update: true # 是否自动更新轻雪每天4点检查更新
debug: false  # 轻雪调试开启会自动重载Bot或者资源其他插件自带的调试功能也将开启
safe_mode: false # 安全模式,开启后将不会加载任何第三方插件
# 其他Nonebot插件的配置项
custom_config_1: "custom_value1"
custom_config_2: "custom_value2"
...

Tip

如果要使用dotenv配置文件请自行创建.env.{ENVIRONMENT},并在config.yml中添加environment:{ENVIRONMENT}字段

OneBot实现端配置

生产环境中推荐反向WebSocket 不同的实现端给出的字段可能不同,但是基本上都是一样的,这里给出一个参考值

字段 参考值 说明
协议 反向WebSocket 推荐使用反向ws协议进行通信即轻雪作为服务端
地址 ws://127.0.0.1:20216/onebot/v11/ws 地址取决于配置文件,本机默认为127.0.0.1:20216
AccessToken "" 如果你给轻雪配置了AccessToken,请在此填写相同的值

其他

  • 要使用其他通信方式请访问OneBot Adapter获取详细信息
  • 轻雪不局限于OneBot适配器你可以使用NoneBot2支持的任何适配器