Skip to content

C. 配置项速查 ​

概述

manifest/config/config.yaml 全键速查。环境变量覆盖(12-Factor,环境变量 > 配置文件):GF_ 前缀 + 键路径大写下划线(如 GF_DATABASE_DEFAULT_LINK);空值视为未设置,仅覆盖本文件已有键,键名规则与 Docker 注入方式详见 2.5 配置文件说明。

server(服务端) ​

键默认说明
server.address:8000监听地址
server.openapiPath/api.jsonOpenAPI 路径
server.swaggerPath""Swagger UI(本地托管 resource/swagger/)
server.dumpRouterMapfalse启动打印路由表
server.errorStacktrue响应携带堆栈(生产 false)
server.gracefultrue优雅重启

logger / database / redis ​

键默认说明
logger.levelall日志级别
logger.stdouttrue控制台输出
logger.pathlog日志目录
database.default.typemysql五方言:mysql/pgsql/mssql/oracle/sqlite
database.default.link—连接串(库名含点需注意)
database.default.debugfalseSQL 日志(生产 false)
redis.default.address127.0.0.1:6379地址
redis.default.pass—密码(生产强密码)
redis.default.db / idle / maxActive / timeout0/10/50/300池参数

jwt / captcha / rateLimit ​

键默认说明
jwt.secret—签名密钥(生产必改)
jwt.issuereasygoadmin签发者
jwt.accessTokenExpire7200访问令牌秒数(2h)
jwt.refreshTokenExpire604800刷新令牌秒数(7d)
captcha.expire300验证码秒数
captcha.bypassCode618618万能码(生产留空)
captcha.length / chars6 / 排除易混淆字符
captcha.fontPathresource/static/fonts/Vera.ttf缺失降级 SVG
captcha.imageWidth/Height/fontSize160/50/40尺寸
captcha.noiseLines/noiseDots8/500干扰
rateLimit.enabletrue限流开关
rateLimit.limit120普通接口/窗口/IP/路径
rateLimit.windowSeconds60窗口
rateLimit.authLimit10认证入口严阈值

operationLog / job / tenant / app ​

键默认说明
operationLog.enabletrue操作日志总开关
operationLog.logQuerytrue记录查询类
job.logRetentionDays90三张日志表保留天数(LogClean 消费)
tenant.defaultId1超管新增的默认归属租户
app.timezoneAsia/Shanghai时区
app.demofalse演示模式(true 拦截全部写操作)
app.errorMsgtrue详细错误信息(生产 false)

api / cors / file / generator / ip2region ​

键默认说明
api.camelSnakeConverttrue驼峰转换(恒开)
api.proxyIps127.0.0.1,::1,CIDR…受信代理(XFF 信任范围)
cors.allowOrigin*跨域来源
file.uploadDir随环境(当前为开发机绝对路径)上传物理根;建议相对项目根,容器部署用 GF_FILE_UPLOADDIR 覆盖
file.domainUrlhttp://file.goframe.elevue文件访问域名(空=相对 /upload/ 路径)
file.tempDirtemp临时目录名
file.imageExtgif,jpg,jpeg,png,bmp,webp,svg图片白名单
file.fileExt(含 doc/xls/pdf/zip/js/css/sql 等)文件白名单(公网收紧)
file.maxSize10单文件 MB
file.tempExpireDays7temp 保留天数(0=不清理)
generator.parentMenuId189新模块菜单父级 ID
generator.overwritetrue覆盖开关(唯一入口;true=生成即覆盖,false=缺失补生成、存在跳过)
ip2region.pathmanifest/data/ip2region.xdb归属地库

环境变量覆盖示例 ​

sh
GF_SERVER_ADDRESS=":9000"
GF_DATABASE_DEFAULT_LINK="mysql:root:secret@tcp(db:3306)/easygoadmin?charset=utf8mb4&parseTime=true"
GF_REDIS_DEFAULT_ADDRESS="redis:6379"
GF_JWT_SECRET="random"
GF_APP_DEMO="false"
GF_FILE_MAXSIZE="20"

新增配置键规范 ​

text
1. config.yaml 增加键 + 注释说明
2. 代码用 cfgBool/cfgInt 带默认值读取(缺失不 panic)
3. 本文档同步
4. 影响限流/日志/上传/调度的键变更后跑对应回归

小蚂蚁云团队 · 提供技术支持