Lingchu Bot 文档现已上线 — 快来看看吧!
Lingchu Bot

环境变量

Lingchu Bot 使用 NoneBot2 的环境变量系统。将 .env.example 复制为 .env 并根据你的环境调整取值。

项目提供跨平台初始化脚本(./scripts/setup.sh),可自动生成 .env.env.development.env.test.env.production 四个环境配置文件。你也可以手动创建这些文件。

服务器设置

变量默认值说明
ENVIRONMENTprod运行环境(proddev
HOST0.0.0.0FastAPI 监听地址
PORT8080FastAPI 监听端口
DRIVER~fastapi+~httpx+~websocketsNoneBot 驱动栈;前缀 ~ 启用默认适配器配置

命令设置

变量默认值说明
COMMAND_START["/", ""]命令起始前缀;空字符串允许无前缀命令
COMMAND_SEP[".", " "]命令分段分隔符

日志和 API 文档

变量默认值说明
LOG_LEVELINFOPython 日志级别
FASTAPI_OPENAPI_URL/openapi.jsonOpenAPI schema 路径;设为空字符串以禁用
FASTAPI_DOCS_URL/docsSwagger UI 路径;生产环境应禁用
FASTAPI_REDOC_URL/redocReDoc 文档路径;生产环境应禁用

数据库设置

变量默认值说明
ALEMBIC_STARTUP_CHECKfalse生产环境设为 true 以在启动时强制执行 schema 迁移检查
SQLALCHEMY_DATABASE_URL(未设置)用于多数据库测试的 SQLAlchemy 数据库 URL;支持 SQLite / PostgreSQL / MySQL / MariaDB / Oracle / SQL Server 六个后端,未设置时使用默认 SQLite

超级用户设置

变量默认值说明
LINGCHU_SUPERUSERS(未设置)Lingchu UID 到平台账号映射的 JSON 对象;参见超级用户身份
SUPERUSERS(未设置)NoneBot 原生回退;当 LINGCHU_SUPERUSERS 缺失或为 null 时使用

参见超级用户身份了解详细配置。

布尔值格式

NoneBot 配置文件只接受标准 JSON 小写 true / false。使用 True / False 会在启动时抛出配置错误。

最后更新于

本页目录