2024-03-28 11:12:55 +08:00
|
|
|
|
---
|
|
|
|
|
title: 配置
|
2024-03-31 10:59:17 +08:00
|
|
|
|
icon: cog
|
2024-03-28 11:12:55 +08:00
|
|
|
|
order: 2
|
|
|
|
|
category: 使用指南
|
|
|
|
|
tag:
|
|
|
|
|
- 配置
|
|
|
|
|
- 部署
|
|
|
|
|
---
|
2024-03-28 12:05:03 +08:00
|
|
|
|
|
2024-04-12 13:07:19 +08:00
|
|
|
|
首次运行后生成`config.yml`,你可以修改配置项后重启轻雪,绝大多数情况下,你只需要修改`superusers`和`nickname`字段即可
|
2024-03-31 06:22:53 +08:00
|
|
|
|
|
2024-04-12 13:07:19 +08:00
|
|
|
|
## **基础配置项**
|
2024-03-28 12:05:03 +08:00
|
|
|
|
|
|
|
|
|
```yaml
|
2024-03-31 18:54:58 +08:00
|
|
|
|
command_start: [ "/", "" ] # 指令前缀,若没有""空命令头,请开启alconna_use_command_start保证alconna解析正常
|
2024-04-12 13:07:19 +08:00
|
|
|
|
host: 127.0.0.1 # 监听地址,默认为本机,若要接收外部请求请填写0.0.0.0
|
2024-03-28 12:05:03 +08:00
|
|
|
|
port: 20216 # 绑定端口
|
2024-04-12 13:07:19 +08:00
|
|
|
|
nickname: [ "liteyuki" ] # 机器人昵称列表
|
|
|
|
|
superusers: [ "1919810" ] # 超级用户列表
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## **其他配置**
|
2024-04-20 12:46:49 +08:00
|
|
|
|
|
2024-04-12 13:07:19 +08:00
|
|
|
|
以下为默认值,如需自定义请手动添加
|
2024-03-28 12:05:03 +08:00
|
|
|
|
|
2024-04-12 13:07:19 +08:00
|
|
|
|
```yaml
|
2024-04-12 01:07:53 +08:00
|
|
|
|
onebot_access_token: "" # 访问令牌,对公开放时建议设置
|
|
|
|
|
default_language: "zh-CN" # 默认语言
|
2024-04-22 21:05:35 +08:00
|
|
|
|
alconna_auto_completion: false # alconna是否自动补全指令,默认false,建议开启
|
|
|
|
|
# 开发者选项
|
2024-05-26 18:15:57 +08:00
|
|
|
|
allow_update: true # 是否允许更新
|
2024-03-28 12:05:03 +08:00
|
|
|
|
log_level: "INFO" # 日志等级
|
|
|
|
|
log_icon: true # 是否显示日志等级图标(某些控制台字体不可用)
|
2024-04-12 01:07:53 +08:00
|
|
|
|
auto_report: true # 是否自动上报问题给轻雪服务器
|
|
|
|
|
auto_update: true # 是否自动更新轻雪,每天4点检查更新
|
2024-05-31 19:17:25 +08:00
|
|
|
|
debug: false # 轻雪调试,开启会自动重载Bot或者资源,其他插件自带的调试功能也将开启
|
2024-04-20 12:46:49 +08:00
|
|
|
|
safe_mode: false # 安全模式,开启后将不会加载任何第三方插件
|
2024-03-28 12:05:03 +08:00
|
|
|
|
# 其他Nonebot插件的配置项
|
|
|
|
|
custom_config_1: "custom_value1"
|
|
|
|
|
custom_config_2: "custom_value2"
|
|
|
|
|
...
|
|
|
|
|
```
|
|
|
|
|
|
2024-04-12 13:07:19 +08:00
|
|
|
|
> [!tip]
|
|
|
|
|
> 如果要使用dotenv配置文件,请自行创建`.env.{ENVIRONMENT}`,并在`config.yml`中添加`environment:{ENVIRONMENT}`字段
|
|
|
|
|
|
|
|
|
|
## **OneBot实现端配置**
|
2024-03-28 12:05:03 +08:00
|
|
|
|
|
2024-04-12 13:07:19 +08:00
|
|
|
|
生产环境中推荐反向WebSocket
|
2024-03-28 12:05:03 +08:00
|
|
|
|
不同的实现端给出的字段可能不同,但是基本上都是一样的,这里给出一个参考值
|
|
|
|
|
|
2024-04-12 13:07:19 +08:00
|
|
|
|
| 字段 | 参考值 | 说明 |
|
|
|
|
|
|-------------|------------------------------------|----------------------------------|
|
|
|
|
|
| 协议 | 反向WebSocket | 推荐使用反向ws协议进行通信,即轻雪作为服务端 |
|
|
|
|
|
| 地址 | ws://127.0.0.1:20216/onebot/v11/ws | 地址取决于配置文件,本机默认为`127.0.0.1:20216` |
|
|
|
|
|
| AccessToken | `""` | 如果你给轻雪配置了`AccessToken`,请在此填写相同的值 |
|
2024-03-28 12:05:03 +08:00
|
|
|
|
|
2024-04-12 13:07:19 +08:00
|
|
|
|
## **其他**
|
2024-03-31 06:22:53 +08:00
|
|
|
|
|
2024-04-12 13:07:19 +08:00
|
|
|
|
- 要使用其他通信方式请访问[OneBot Adapter](https://onebot.adapters.nonebot.dev/)获取详细信息
|
|
|
|
|
- 轻雪不局限于OneBot适配器,你可以使用NoneBot2支持的任何适配器
|