配置文件
框架采用 Yaml 作为后端配置,所有配置均存在 config 下,配置在使用时系统会根据需要按需加载,配置名为 xxx.yaml
为了防止同步时本地配置覆盖线上配置可使用 xxx.dev.yaml
来定义本地开发配置,系统将优先读取该配置文件,提交线上时请勿提交本地配置。
配置中的值可使用以下特殊字符串来代替部分绝对路径,如下:
名称 | 说明 |
---|---|
%config_path% | /config 目录 |
%data_path% | /data 目录 |
%app_path% | /app 目录 |
%public_path% | /public 目录 |
应用配置
app.yaml
registers
该参数值类型为 array
,数组元素为应用注册类的命名空间字符串,如:\App\System\App
对应的文件为 /app/System/App.php
用户配置
use.yaml
app
名称 | 类型 | 描述 |
---|---|---|
name | string | 系统名称,后台标题处显示 |
debug | boolean | 调试模式,关闭后会屏蔽返回的异常详情,不影响日志记录 |
cache | boolean | 系统缓存,上线后建议开启,会缓存注册过程中的数据 |
secret | string | 系统密钥,请勿分享,建议定期更换保证安全性 |
domain | string | 系统域名,用于部分模块读取当前域名 |
lang
用于指定系统语言,安装向导的选择会覆盖该值,目前支持以下语言:
zh-CN
简体中文zh-TW
繁体中文en-US
英语ru-RU
俄语ko-KR
韩语ja-JP
日语
vite
名称 | 类型 | 描述 |
---|---|---|
dev | boolean | 后台前端调试模式 |
port | number | 后台前端调试端口 |
缓存配置
cache.yaml
键名 | 类型 | 描述 |
---|---|---|
type | string | 缓存类型,支持 file 与 redis |
driver | string | 驱动配置名, 默认 default,使用 database.yaml 配置 |
命令配置
command.yaml
用于注册自定义命令。
registers
参数值类型为 array
,数组元素为 console
类的命名空间字符串,如:\Console\TestCommand
对应的文件为 /console/TestCommand.php
数据库配置
database.yaml
db
可在 drivers 下设置多组配置
键名 | 类型 | 描述 |
---|---|---|
drivers.default.driver | string | 默认数据库驱动 |
drivers.default.host | string | 数据库主机地址 |
drivers.default.database | string | 数据库名称 |
drivers.default.username | string | 数据库用户名 |
drivers.default.password | string | 数据库密码 |
drivers.default.port | number | 数据库端口号 |
drivers.default.prefix | string | 数据表前缀 |
redis
可在 drivers 下设置多组配置
键名 | 类型 | 描述 |
---|---|---|
drivers.default.host | string | Redis主机地址 |
drivers.default.port | number | Redis端口号 |
drivers.default.timeout | number | Redis连接超时时间 |
drivers.default.auth | string | Redis密码 |
队列配置
queue.yaml
键名 | 类型 | 描述 |
---|---|---|
type | string | 队列驱动 |
driver | string | 驱动配置名, 默认 default,使用 database.yaml 中的配置 |
retry | number | 重试次数,默认 3 次后取消重试 |
存储配置
storage.yaml
键名 | 类型 | 描述 |
---|---|---|
type | string | 存储驱动,支持 local、qiniu、cos、oss |
ext | array | 允许存储后缀格式 |
drivers | array | 驱动配置 |
本地驱动
键名 | 类型 | 描述 |
---|---|---|
drivers.local.type | string | local |
drivers.local.public_url | string | 公共URL |
drivers.local.path | string | 存储路径 |
七牛存储
键名 | 类型 | 描述 |
---|---|---|
drivers.qiniu.type | string | qiniu |
drivers.qiniu.accessKey | string | accessKey |
drivers.qiniu.secretKey | string | secretKey |
drivers.qiniu.bucket | string | 存储桶名称 |
drivers.qiniu.domain | string | 存储桶 url 地址 |
drivers.qiniu.public_url | string | 外链URL |
腾讯云存储
键名 | 类型 | 描述 |
---|---|---|
drivers.cos.type | string | cos |
drivers.cos.app_id | string | 应用 id |
drivers.cos.secret_id | string | secret id |
drivers.cos.secret_key | string | secret key |
drivers.cos.region | string | 存储区域名 |
drivers.cos.bucket | string | 存储桶名称 |
drivers.cos.signed_url | boolean | 可选,如果 bucket 为私有访问请打开此项 |
drivers.cos.signed_url | use_https | 可选,是否使用 https,默认 false |
drivers.cos.domain | string | 可选,自定义存储桶 url 地址 |
drivers.cos.public_url | string | 外链URL |
阿里云存储
键名 | 类型 | 描述 |
---|---|---|
drivers.cos.type | string | oos |
drivers.cos.accessKeyId | string | accessKeyId |
drivers.cos.accessKeySecret | string | accessKeySecret |
drivers.cos.endpoint | string | 存储桶 url 地址 |
drivers.cos.bucket | string | 存储桶名称 |
drivers.cos.isCName | boolean | 如果 isCname 为 false,endpoint 应配置 oss 提供的域名如:oss-cn-beijing.aliyuncs.com ,cname 或 cdn 请自行到阿里 oss 后台配置并绑定 bucket |
drivers.cos.public_url | string | 外链URL |
ip 地址库
geo.yaml
用于针对 ip 和地址的转换。
键名 | 类型 | 描述 |
---|---|---|
db | string | 地址数据库,仅支持 maxmind 提供的数据库。 |