Files
easygoadmin-wiki/EasyGoAdmin_Gin_EleVue/zh/appendix/config-reference.md
T
2026-10-25 17:24:27 +08:00

94 lines
3.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# C. 配置项速查
:::tip 说明
`config/config.yaml` 全部配置节速查。任意键可用环境变量覆盖(大写 + 点换下划线 + `APP_` 前缀,仅覆盖已存在键)。完整注释见配置文件本身。
:::
## server
| 键 | 默认 | 说明 |
|---|---|---|
| server.address | :8000 | 监听地址 |
## logger
| 键 | 默认 | 说明 |
|---|---|---|
| logger.level | all | debug/info/warn/error/all |
| logger.stdout | true | 控制台输出 |
| logger.path | log | 日志目录 |
## database.default
| 键 | 默认 | 说明 |
|---|---|---|
| driver | mysql | mysql/postgres/sqlserver/sqlite/oracle |
| host / port | 127.0.0.1 / 3306 | 连接(sqlite 忽略) |
| username / password | root / root | 账号 |
| dbname | easygoadmin.gin.elevue | 库名(sqlite 为文件路径) |
| params | charset=utf8mb4&... | DSN 追加参数 |
| debug | false | SQL 日志 |
| maxOpenConns / maxIdleConns | 50 / 10 | 连接池 |
| connMaxLifetime | 3600 | 连接存活(秒) |
## redis.default
| 键 | 默认 | 说明 |
|---|---|---|
| address | 127.0.0.1:6379 | 为空降级内存 |
| db | 0 | 库编号 |
| pass | — | 密码 |
## jwt / captcha / rateLimit
| 键 | 默认 | 说明 |
|---|---|---|
| jwt.secret | 样例值 | 签名密钥(生产必换) |
| jwt.issuer | easygoadmin | 签发者 |
| jwt.accessTokenExpire | 7200 | 访问令牌(秒) |
| jwt.refreshTokenExpire | 604800 | 刷新令牌(秒) |
| captcha.expire / length / chars | 300 / 6 / 字符集 | 验证码参数 |
| captcha.bypassCode | 空 | 万能码(prod 拒绝非空) |
| captcha.fontPath / imageWidth / ... | Vera.ttf / 160... | 渲染参数 |
| rateLimit.enable / limit / windowSeconds | true / 120 / 60 | 普通限流 |
| rateLimit.authLimit | 10 | 认证接口限流 |
## operationLog / job / tenant / app
| 键 | 默认 | 说明 |
|---|---|---|
| operationLog.enable / logQuery | true / true | 操作日志开关 |
| job.logRetentionDays | 90 | 日志保留(LogClean) |
| job.lockTTLSeconds | 300 | 任务锁 TTL |
| tenant.defaultId | 1 | 超管新增默认归属 |
| app.timezone | Asia/Shanghai | 时区 |
| app.demo | false | 演示模式(拒写) |
| app.prod | false | 生产模式(红线校验) |
## api / cors / file
| 键 | 默认 | 说明 |
|---|---|---|
| api.proxyIps | 127.0.0.1,::1,... | 受信代理(CIDR) |
| api.maxBodyMB | 10 | 请求体上限 |
| api.docs / api.metrics | true / true | 文档/指标端点 |
| cors.allowOrigin | * | 允许来源 |
| file.uploadDir | upload 绝对路径 | 上传根 |
| file.domainUrl | http://file.gin.elevue(样例) | 文件访问域址(生产覆盖;为空则应用回退) |
| file.imageExt / fileExt / maxSize | 白名单 / 10 | 扩展名与大小 |
| file.tempExpireDays | 7 | temp 保留天数 |
## generator / ip2region
| 键 | 默认 | 说明 |
|---|---|---|
| generator.enable | true | 总开关(生产 false) |
| generator.parentMenuId | 189 | 菜单挂载父级 |
| generator.overwrite | true | 覆盖策略 |
| ip2region.path | resource/data/ip2region.xdb | 归属地库 |
## 相关
- [2.3 配置文件与环境变量](/zh/quickstart/env-vars.html)
- [.env.example](键一致性由 make check-config 硬检查)