跳到主要内容

主配置文件

主配置文件通常位于:

plugins/YourPlugin/config.yml

示例配置

plugins/YourPlugin/config.yml
# 插件语言,可选 zh_CN / en_US
language: zh_CN

# 是否检查更新
check-update: true

# 是否启用匿名统计
metrics: true

# 调试模式,生产环境建议关闭
debug: false

# 数据存储方式:file / mysql
storage:
type: file
mysql:
host: localhost
port: 3306
database: yourplugin
username: root
password: password

字段说明

字段类型默认值说明
languagestringzh_CN插件语言文件
check-updatebooleantrue是否检查新版本
metricsbooleantrue是否启用匿名统计
debugbooleanfalse是否输出调试日志
storage.typestringfile数据存储方式
数据库密码

不要把真实数据库密码提交到公开仓库。如果你的文档仓库是公开的,请只保留示例密码。