1
0
forked from bot/app
LiteyukiBot/docs/deploy/config.md

79 lines
3.4 KiB
Markdown
Raw Permalink Normal View History

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
轻雪支持`yaml`、`json`和`toml`作为配置文件,取决于你个人的喜好
2024-03-31 06:22:53 +08:00
首次运行后生成`config.yml`和`config`目录,你可修改配置项后重启轻雪,绝大多数情况下,你只需要修改`superusers`及`nickname`字段即可
启动时会加载项目目录下`config.yml/yaml/json/toml`和`config`目录下的所有配置文件,你可在`config`目录下创建多个配置文件,轻雪会自动合并这些配置文件
2024-04-12 13:07:19 +08:00
## **基础配置项**
2024-03-28 12:05:03 +08:00
```yaml
nonebot:
# Nonebot机器人的配置以前的最外层配置项仍可为Nonebot服务但是部分内容会被覆盖请尽快迁移
command_start: [ "/", "" ] # 指令前缀,若没有""空命令头请开启alconna_use_command_start保证alconna解析正常
host: 127.0.0.1 # 监听地址默认为本机若要接收外部请求请填写0.0.0.0
port: 20216 # 绑定端口
nickname: [ "liteyuki" ] # 机器人昵称列表
superusers: [ "1919810" ] # 超级用户列表
liteyuki:
# 写在外层的配置项将会被覆盖建议迁移到liteyuki下
log_level: "INFO" # 日志等级
log_icon: true # 是否显示日志等级图标(某些控制台字体不可用)
auto_report: true # 是否自动上报问题给轻雪服务器
auto_update: true # 是否自动更新轻雪每天4点检查更新
plugins: [ ] # 轻雪插件列表
plugin_dirs: [ ] # 轻雪插件目录列表
2024-04-12 13:07:19 +08:00
```
## **其他配置**
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
# 高级NoneBot配置
nonebot:
onebot_access_token: "" # 访问令牌,对公开放时建议设置
default_language: "zh-CN" # 默认语言
alconna_auto_completion: false # alconna是否自动补全指令默认false建议开启
safe_mode: false # 安全模式开启后将不会加载任何第三方NoneBot插件
# 其他Nonebot插件的配置项
custom_config_1: "custom_value1"
custom_config_2: "custom_value2"
# 开发者选项
liteyuki:
allow_update: true # 是否允许更新
debug: false # 轻雪调试开启会自动重载Bot或者资源其他插件自带的调试功能也将开启
dev_mode: false # 开发者模式,开启后将会启动监视者,监视文件变化并自动重载
2024-03-28 12:05:03 +08:00
...
```
2024-04-12 13:07:19 +08:00
> [!tip]
> 如果要使用NoneBot和dotenv配置文件请自行创建`.env.{ENVIRONMENT}`,并在`config.yml`中添加`nonebot.environment:{ENVIRONMENT}`字段
2024-04-12 13:07:19 +08:00
## **与NoneBot对接的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支持的任何适配器