Quartz.Dashboard

Quartz.Dashboard

Quartz.Dashboard is a Blazor dashboard for Quartz.NET that runs inside your ASP.NET Core application and drives the schedulers registered in that same application.

Installation

It builds on Quartz.AspNetCore, which this package brings along, so one reference is enough:

dotnet add package Quartz.Dashboard

Usage

WebApplicationBuilder builder = WebApplication.CreateBuilder(args);

builder.AddQuartz();
builder.Services.AddQuartzHttpApi();
builder.Services.AddQuartzDashboard();
builder.AddQuartzHostedService(options => options.WaitForJobsToComplete = true);

WebApplication app = builder.Build();

app.UseAntiforgery();
app.MapStaticAssets();
app.MapQuartzHttpApi().RequireAuthorization();
app.MapQuartzDashboard().RequireAuthorization();

The UI is then at /quartz. MapQuartzDashboard("/ops/quartz") serves it somewhere else — pages, assets and the Blazor circuit all move with it — and AddQuartzDashboard(options => …) takes an authorization policy, which is what a deployment reachable by anyone but you needs.

The RequireAuthorization() on both map calls is not decoration. The dashboard and the API add no authentication of their own, both are fully mutating, and a job scheduled through either names its type as a string the request supplies — which, with Quartz.Jobs on the host's probing path, reaches NativeJob and its process. A mapping that says nothing about authorization refuses to start; say AllowAnonymous() where you mean it.

app.MapStaticAssets() is what serves the dashboard's stylesheet and scripts; without it the pages render unstyled and inert. A project with no .razor files of its own also needs <RequiresAspNetWebAssets>true</RequiresAspNetWebAssets>, or the Blazor framework script is missing too. app.UseAuthentication() needs an authentication scheme the application registered — the dashboard authorizes, and something else authenticates.

Execution history needs nothing installed: AddQuartzDashboard() registers the history plugin itself, and the History page fills as jobs run. The q.UseJobHistoryLogging() and q.UseTriggerHistoryLogging() plugins from Quartz.Plugins are a separate thing — they write the same events to your application's log, and the dashboard does not read them.

Trimming

This package is deliberately not trimmable, and does not declare IsTrimmable. Blazor Server is a reflective framework: a component's [Parameter] properties are set by name from the render tree, the router finds page components by type, and grids, event callbacks and the SignalR hub proxy all bind members that nothing statically references. That is the framework's model rather than anything this package could resolve, and the Blazor packages themselves are not marked trimmable either.

An application that publishes trimmed or native AOT therefore does so without the dashboard. Quartz, Quartz.AspNetCore and Quartz.HttpClient are trimmable, so a trimmed service can still be driven remotely over the HTTP API.

Hosting the dashboard itself in another process is not something this package does today: the client it registers reads the schedulers in its own container. A supported remote dashboard is designed in #3387.

Documentation

The full guide covers custom paths and reverse proxies, authorization, integrating into an existing Blazor application, and production hardening:

https://www.quartz-scheduler.net/documentation/quartz-4.x/packages/dashboard.html