Skip to content
使用指南

配置说明

完整配置参考:存储、JWT 认证、文件路径、数据库迁移配置与配置优先级。

更新于 2026-11-17MIT 开源

配置说明 ​

1. 配置文件位置 ​

Chet.QuartzNet.UI 读取宿主应用的 ASP.NET Core 配置系统,因此可以使用:

  • appsettings.json
  • appsettings.{Environment}.json
  • 环境变量
  • 命令行参数

所有配置集中在 QuartzUI 节下;数据库连接字符串放在 ConnectionStrings 节。

2. 最小配置 ​

json
{
  "QuartzUI": {
    "JwtSecret": "Y2V0aFF1YXJ6TmV0VUlBdXRoZW50aWNhdGlvblNlY3JldA==",
    "JwtExpiresInMinutes": 360,
    "JwtIssuer": "Chet.QuartzNet.UI",
    "JwtAudience": "Chet.QuartzNet.UI",
    "UserName": "Admin",
    "Password": "123456"
  }
}

3. 配置项说明 ​

3.1 认证 ​

配置项类型说明
JwtSecretstringJWT 签名密钥,生产环境务必替换
JwtExpiresInMinutesintToken 有效期(分钟),默认 360
JwtIssuerstringJWT 签发者
JwtAudiencestringJWT 接收方
UserNamestring登录用户名
Passwordstring登录密码

安全提示

内置认证是单账号的轻量方案,用于保护管理界面,不等同于完整的用户体系。若需要多用户、角色、审计等能力,应在网关或宿主应用中接入统一的身份认证。

3.2 存储 ​

配置项类型默认值说明
StorageTypestringFile存储类型:File / Database
DatabaseProviderstring空数据库提供程序:mysql、postgresql、sqlserver、sqlite
FileStoragePathstringApp_Data/QuartzJobs文件存储目录;数据库模式下仍作为文件迁移的默认路径

数据库存储还需要:

json
{
  "ConnectionStrings": {
    "QuartzUI": "你的数据库连接字符串"
  }
}

3.3 数据迁移 ​

QuartzUI:Migration 用于配置迁移面板中可选的数据库与文件来源:

json
{
  "QuartzUI": {
    "Migration": {
      "BatchSize": 500,
      "ContinueOnError": false,
      "MaxErrorSamples": 20,
      "PauseSchedulerDuringMigration": false,
      "AllowReplace": false,
      "AllowAdHocConnectionString": false,
      "AdditionalStore": {
        "Provider": "MySQL",
        "ConnectionString": "Server=127.0.0.1;Port=3306;Database=quartzui;User=root;Password=***;"
      },
      "FileSources": [
        {
          "Name": "历史文件数据",
          "Path": "D:\\QuartzBackup\\QuartzJobs"
        }
      ]
    }
  }
}
配置项默认值说明
AdditionalStore空可选,配置后可在当前存储与该数据库之间双向迁移
Profiles空旧版数据库配置档,仍然兼容,推荐改用 AdditionalStore
FileSources空额外允许迁移的文件源目录
BatchSize500每批读写条数(1–2000)
ContinueOnErrorfalse写入失败时是否继续后续批次
MaxErrorSamples20错误样本上限(1–200)
PauseSchedulerDuringMigrationfalse迁移期间是否暂停调度器
AllowReplacefalse是否允许「替换」写入模式
AllowAdHocConnectionStringfalse是否允许 API 直接提交连接字符串

迁移的完整操作与安全建议见 数据迁移。

4. 文件存储配置 ​

json
{
  "QuartzUI": {
    "StorageType": "File",
    "FileStoragePath": "App_Data/QuartzJobs",
    "JwtSecret": "Y2V0aFF1YXJ6TmV0VUlBdXRoZW50aWNhdGlvblNlY3JldA==",
    "JwtExpiresInMinutes": 360,
    "UserName": "Admin",
    "Password": "123456"
  }
}
  • 相对路径按应用工作目录解析;
  • 目录不存在时自动创建;
  • 作业、日志、通知、系统设置分别以 JSON 文件形式保存。

5. 数据库存储配置 ​

json
{
  "ConnectionStrings": {
    "QuartzUI": "Server=localhost;Database=quartzui;User=root;Password=123456;"
  },
  "QuartzUI": {
    "StorageType": "Database",
    "DatabaseProvider": "mysql",
    "JwtSecret": "Y2V0aFF1YXJ6TmV0VUlBdXRoZW50aWNhdGlvblNlY3JldA==",
    "JwtExpiresInMinutes": 360,
    "UserName": "Admin",
    "Password": "123456"
  }
}
提供程序DatabaseProvider连接字符串示例
MySQLmysqlServer=localhost;Database=quartzui;User=root;Password=123456;
PostgreSQLpostgresqlHost=localhost;Port=5432;Database=quartzui;Username=postgres;Password=123456;
SQL ServersqlserverData Source=localhost;Initial Catalog=quartzui;User Id=sa;Password=123456;TrustServerCertificate=true;
SQLitesqliteData Source=quartzui.db

存储选型建议见 存储模式。

6. 界面中的系统配置 ​

以下内容不在 appsettings.json 中,而是保存在存储里,可在「系统配置」页修改:

  • 服务名称、环境标识、服务描述;
  • 停机策略:停机模式、排水超时;
  • 中断恢复:补偿开关与延迟、心跳间隔、租约时长、补偿策略、最大执行次数、中断日志保留;
  • 数据迁移入口。

日志清理配置(保留天数 / 最大条数 / 清理间隔)已迁移到「日志管理」页的「日志配置」。

其中停机与中断恢复属于启动期配置,保存后需重启应用生效;租约时长必须不小于心跳间隔的 2 倍。详见 中断恢复与排水调度。

这些配置会随数据迁移一起复制,详见 系统配置。

让 Quartz.Net 调度,从未如此简单