Ape-Volo-Admin 系统配置文档
开发环境配置文件
开发环境请优先修改 appsettings.Development.json，该文件用于本地开发环境的专属配置。
生产环境请使用 appsettings.json 或 appsettings.Production.json为生产环境基线及覆盖配置。
请避免误改生产配置文件。
1. 服务基础配置
| 参数 | 说明 | 示例/默认值 |
|---|---|---|
| urls | 项目监听地址 | http://*:8002 |
| AllowedHosts | 允许的主机名 | * |
2. JWT 认证配置
| 参数 | 说明 | 示例/默认值 |
|---|---|---|
| Audience | JWT 接收方 | http://localhost |
| Issuer | JWT 签发方 | http://localhost |
| SecurityKey | JWT 密钥 | 5ixKD0BkJxYYroZTvdPs3w9NWRoiUacN |
| Expires | Token 有效期（小时） | 12 |
| RefreshTokenExpires | 刷新 Token 缓冲有效期（小时） | 168 |
| LoginPath | 登录 API 路径 | /auth/login |
3. 系统配置
| 参数 | 说明 | 示例/默认值 |
|---|---|---|
| IsInitTable | 启动时初始化表结构 | true |
| IsInitData | 启动时初始化数据 | true |
| IsCqrs | 是否启用 CQRS 架构 | false |
| IsQuickDebug | 是否快速调试模式 | true |
| UserDefaultPassword | 新用户默认密码 | 123456 |
| FileLimitSize | 上传文件大小限制（MB） | 10 |
| HmacSecret | HMAC 密钥 | z2sCIB2PDuXNcgLRDKvACkL89VgH3iRw |
| MasterDataBase | 主数据库名 | Ape.Volo.Sqlite.Master |
| LogDataBase | 日志数据库名 | Ape.Volo.Log |
| UseRedisCache | 是否启用 Redis 缓存 | true |
4. 多租户配置
| 参数 | 说明 | 示例/默认值 |
|---|---|---|
| Enabled | 是否启用多租户 | false |
| Type | 多租户模式类型 | 2 |
5. 数据库连接配置
- 支持 MySQL、SQL Server、SQLite、Oracle 等。
Enabled为true表示启用，HitRate为负载均衡权重- 系统默认使用
SQLite作为主库与日志库
| ConnId | DBType | Enabled | HitRate | ConnectionString |
|---|---|---|---|---|
| Ape.Volo.Mysql.Master | 0 | false | 100 | MySQL 主库连接字符串 |
| Ape.Volo.Mysql.Slave | 0 | false | 20/10 | MySQL 从库连接字符串 |
| Ape.Volo.SqlServer.Master | 1 | false | 20 | SQL Server 主库连接字符串 |
| Ape.Volo.Sqlite.Master | 2 | true | 0 | apevoloMaster.db |
| Ape.Volo.Oracle.Master | 3 | false | 20 | Oracle 主库连接字符串 |
| Ape.Volo.Log | 2 | true | 0 | ApeVoloLog.db |
6. 日志 Serilog 配置
| 参数 | 说明 | 示例/默认值 |
|---|---|---|
| RecordSqlEnabled | 是否记录 SQL 日志 | true |
- 日志输出目的地
| 输出类型 | 说明 | 是否启用 |
|---|---|---|
| ToDb | 写入数据到数据库 | true |
| ToFile | 输出内容到文件 | true |
| ToConsole | 在控制台打印输出 | true |
| ToElasticsearch | 是否推送到 Elasticsearch 搜索引擎 | false |
7. 事件总线 EventBus
| 参数 | 说明 | 示例/默认值 |
|---|---|---|
| Enabled | 是否启用事件总线 | false |
| SubscriptionClientName | 客户端名称 | Ape.Volo |
8. RabbitMQ 配置
| 参数 | 说明 | 示例/默认值 |
|---|---|---|
| Connection | 服务器地址 | localhost |
| Username | 用户名 | Ape.Volo |
| Password | 密码 | 123456 |
| RetryCount | 重试次数 | 3 |
9. 中间件配置
| 中间件 | 说明 | 是否启用 |
|---|---|---|
| QuartzNetJob | 定时任务调度中间件 | true |
| IpLimit | IP 访问限制中间件 | true |
| MiniProfiler | 性能分析和诊断中间件 | true |
| RabbitMq | 消息队列中间件（RabbitMQ） | false |
| RedisMq | 消息队列中间件（Redis） | false |
| Elasticsearch | 分布式搜索与分析引擎中间件 | false |
10. AOP 配置
| 功能 | 说明 | 是否启用 |
|---|---|---|
| Tran | 事务管理功能 | true |
| Cache | 缓存加速功能 | true |
11. 跨域 CORS 配置
| 参数 | 说明 | 示例/默认值 |
|---|---|---|
| Name | 策略名称 | CorsIpAccess |
| EnableAll | 允许所有域 | false |
- 策略列表：
| 策略名称 | 域名 |
|---|---|
| Default | http://127.0.0.1:8001 |
| Default | http://localhost:8001 |
12. Redis 配置
| 参数 | 说明 | 示例/默认值 |
|---|---|---|
| Host | 主机 | localhost |
| Port | 端口 | 6379 |
| Password | 密码 | "" |
| Index | 数据库索引 | 0 |
| ConnectTimeout | 连接超时(ms) | 10000 |
| SyncTimeout | 同步超时(ms) | 10000 |
| KeepAlive | 保持活动 | 20 |
| ConnectRetry | 重试次数 | 10 |
| AbortOnConnectFail | 连接失败是否中断 | true |
| AllowAdmin | 允许管理操作 | true |
| SuspendTime | 挂起时间(ms) | 10000 |
| MaxQueueConsumption | 最大队列消费数 | 100 |
| ShowLog | 显示日志 | false |
13. RSA 加密配置
PrivateKey
多行 RSA 私钥（PEM 格式）PublicKey
多行 RSA 公钥（PEM 格式）
14. Swagger 文档配置
| 参数 | 说明 | 示例/默认值 |
|---|---|---|
| Enabled | 是否启用 | true |
| Name | 名称 | v1 |
| Version | 版本 | 3.5.1 |
| Title | 文档标题 | Ape.Volo.Admin Api 文档 |
15. 验证码配置
| 参数 | 说明 | 示例/默认值 |
|---|---|---|
| KeyLength | 字符长度 | 0 |
| ImgWidth | 图片宽度 | 111 |
| ImgHeight | 图片高度 | 36 |
| FontSize | 字体大小 | 25 |
| Threshold | 触发验证码的失败次数阈值(0 表示总是需要) | 0 |
| TimeOut | 验证码阈值超时时间(秒) | 3600 |
16. 登录失败限制
| 参数 | 说明 | 示例/默认值 |
|---|---|---|
| Enabled | 是否启用 | true |
| MaxAttempts | 最大尝试次数 | 3 |
| Lockout | 锁定时长（秒） | 7200 |