Files
easygoadmin-wiki/EasyGoAdmin_Beego_Layui/zh/appendix/config-reference.md
T
2026-10-20 21:19:44 +08:00

146 lines
5.3 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. 配置项速查
## 后端 .env 配置
:::tip 格式说明
`.env` 文件采用 INI 分组格式,`[SECTION]` 表示分组,分组下的 `KEY = value` 对应该分组的配置项。
:::
### 全局变量
| 变量 | 默认值 | 说明 |
|------|--------|------|
| `APP_DEBUG` | `true` | 调试模式(生产环境设为 false) |
### 应用配置 `[APP]`
| 变量 | 默认值 | 说明 |
|------|--------|------|
| `DEFAULT_TIMEZONE` | `Asia/Shanghai` | 默认时区 |
| `DEMO` | `false` | 演示模式(开启后拦截写操作) |
| `SHOW_ERROR_MSG` | `true` | 显示错误详情(生产环境设为 false) |
### 数据库配置 `[DATABASE]`
| 变量 | 默认值 | 说明 |
|------|--------|------|
| `TYPE` | `mysql` | 数据库类型:mysql / pgsql / sqlsrv / oracle / sqlite |
| `HOSTNAME` | `127.0.0.1` | 数据库主机 |
| `DATABASE` | - | 数据库名(SQLite 为文件路径) |
| `USERNAME` | `root` | 数据库用户 |
| `PASSWORD` | - | 数据库密码 |
| `HOSTPORT` | `3306` | 数据库端口 |
| `CHARSET` | `utf8mb4` | 字符集 |
| `DEBUG` | `true` | 是否开启 SQL 调试 |
| `PREFIX` | `think_` | 表前缀 |
各数据库默认端口:
| 数据库 | 默认端口 | 默认用户 |
|--------|----------|----------|
| MySQL | 3306 | root |
| PostgreSQL | 5432 | postgres |
| SQL Server | 1433 | sa |
| Oracle | 1521 | - |
| SQLite | - | - |
### JWT 配置 `[JWT]`
| 变量 | 默认值 | 说明 |
|------|--------|------|
| `SECRET` | 内置默认 | 签名密钥(**生产环境务必修改**) |
| `ACCESS_TTL` | `7200` | access_token 有效期(秒) |
| `REFRESH_TTL` | `604800` | refresh_token 有效期(秒) |
| `ISSUER` | `rxthinkcmf` | 签发者标识 |
### 文件上传配置 `[FILE]`
| 变量 | 默认值 | 说明 |
|------|--------|------|
| `UPLOAD_DIR` | - | 上传根目录(绝对路径) |
| `DOMAIN_URL` | - | 文件访问域名 |
| `IMAGE_EXT` | `gif,jpg,jpeg,png,bmp,webp,svg` | 图片允许后缀 |
| `FILE_EXT` | 多种后缀 | 文件允许后缀 |
| `MAX_SIZE` | `10` | 最大文件大小(MB) |
### 缓存配置 `[CACHE]`
| 变量 | 默认值 | 说明 |
|------|--------|------|
| `DRIVER` | `file` | 缓存驱动:file / redis |
| `REDIS_HOST` | `127.0.0.1` | Redis 主机(driver=redis 时生效) |
| `REDIS_PORT` | `6379` | Redis 端口(driver=redis 时生效) |
| `REDIS_PASSWORD` | - | Redis 密码 |
| `REDIS_DB` | `0` | Redis 数据库编号 |
| `REDIS_PREFIX` | `rx:` | 缓存键前缀 |
### CORS 配置 `[CORS]`
| 变量 | 默认值 | 说明 |
|------|--------|------|
| `ALLOW_ORIGIN` | `*` | 允许的跨域来源 |
### API 配置 `[API]`
| 变量 | 默认值 | 说明 |
|------|--------|------|
| `CAMEL_SNAKE_CONVERT` | `true` | 驼峰/下划线自动转换 |
| `PROXY_IPS` | (空) | 受信代理 IP 列表(逗号分隔,支持 CIDR)。部署在 CDN/负载均衡后面时配置,中间件会从 `X-Forwarded-For` / `X-Real-IP` 头提取真实客户端 IP。未配置时默认信任 `127.0.0.1` 和 `::1`。 |
### 验证码配置 `[CAPTCHA]`
| 变量 | 默认值 | 说明 |
|------|--------|------|
| `CAPTCHA_BYPASS_CODE` | (空) | 万能验证码,仅开发调试用,**生产环境务必留空** |
| `CAPTCHA_LENGTH` | `6` | 验证码字符长度(4-6位) |
| `CAPTCHA_EXPIRE` | `300` | 过期时间(秒) |
| `CAPTCHA_RATE_WINDOW` | `60` | 防刷窗口期(秒) |
| `CAPTCHA_RATE_LIMIT` | `20` | 窗口期内最大获取次数 |
| `CAPTCHA_CHARS` | `ABCDEFGHJKLMNPQRSTUVWXYZ2346789` | 字符集 |
| `CAPTCHA_FONT_PATH` | `static/fonts/Vera.ttf` | 字体路径 |
| `CAPTCHA_IMAGE_WIDTH` | `160` | 图片宽度(像素) |
| `CAPTCHA_IMAGE_HEIGHT` | `50` | 图片高度(像素) |
| `CAPTCHA_FONT_SIZE` | `28` | 字体大小 |
| `CAPTCHA_NOISE_LINES` | `8` | 干扰线数量 |
| `CAPTCHA_NOISE_DOTS` | `500` | 噪点数量 |
### 代码生成器配置 `[GENERATOR]`
| 变量 | 默认值 | 说明 |
|------|--------|------|
| `PARENT_MENU_ID` | `189` | 生成模块的父菜单ID |
| `APP_NAME` | `tool` | 模块应用名(路由前缀) |
### 国际化配置 `[LANG]`
| 变量 | 默认值 | 说明 |
|------|--------|------|
| `default_lang` | `zh-cn` | 默认语言 |
## 前端环境变量
| 变量 | 说明 |
|------|------|
| `VITE_GLOB_API_URL` | API 基础路径(如 `/api`) |
| `VITE_GLOB_API_URL_PREFIX` | API 前缀 |
## 配置文件对照
| .env 分组 | 配置文件 | 主要配置键 |
|-----------|---------|-----------|
| `[DATABASE]` | `config/database.php` | `type` / `hostname` / `database` / `username` / `password` |
| `[JWT]` | `config/jwt.php` | `secret` / `access_ttl` / `refresh_ttl` |
| `[FILE]` | `config/file.php` | `upload_dir` / `domain_url` / `max_size` |
| `[CACHE]` | `config/cache.php` | `driver` / `redis_host` / `redis_port` |
| `[CORS]` | `config/cors.php` | `allow_origin` |
| `[API]` | `config/api.php` | `camel_snake_convert` |
| `[CAPTCHA]` | 无配置文件,`CaptchaService` 直接读取 `env()` | `captcha_bypass_code` / `captcha_length` / `captcha_expire` |
| `[LANG]` | `config/lang.php` | `default_lang` |
| — | `config/tenant.php` | `default_tenant_id` |
### 租户配置
| 配置文件 | 配置键 | 默认值 | 说明 |
|----------|--------|--------|------|
| `config/tenant.php` | `default_tenant_id` | `1` | 默认租户ID,超管操作租户隔离表时自动代入 |