Dashboard Host

The dashboard as a program of its own, configured from settings alone (4.8). It fronts schedulers over their HTTP API, reads every scheduler in a database, and accepts workers that dial in as agents. One program, two distributions:

From an Aspire AppHost, use Aspire Hosting, which runs the image and writes its settings.

Running it

quartz-dashboard --urls http://localhost:5000 \
  --Quartz:Dashboard:Authentication:Mode=Token \
  --Quartz:Dashboard:Authentication:Tokens:Administrator=<32 random characters> \
  --Quartz:Dashboard:Targets:orders:ConnectionString="Host=db;Database=quartz;Username=quartz;Password=…"

docker run -p 8080:8080 \
  -e Quartz__Dashboard__Authentication__Mode=Token \
  -e Quartz__Dashboard__Authentication__Tokens__Administrator=<32 random characters> \
  -e Quartz__Dashboard__Targets__orders__ConnectionString="Host=db;Database=quartz;Username=quartz;Password=…" \
  ghcr.io/quartznet/quartz-dashboard:4.8.0

Open /quartz and sign in with the token. Every key below is under Quartz:Dashboard, written Quartz__Dashboard__… as an environment variable.

Authentication

Authentication:Mode is required. Without it the host refuses to start: it logs event 9402 and exits with code 1, as it does for any other mistake in its settings.

• The roles are the operator roles. A viewer reads, an operator also pauses, resumes, triggers and interrupts, an administrator also adds, edits and deletes. The host builds the policy with RequireSchedulerRoles.
• Token mode compares tokens in constant time and signs the visitor in with an HttpOnly, SameSite=Strict cookie for eight hours, renewed while in use. AllowTokenInUrl=true also accepts /login?t=<token>, and moves the browser on to an address without it. Off by default; Aspire Hosting sets it for its sign-in link.
• OpenIdConnect mode needs Roles:Viewers, Roles:Operators or Roles:Administrators, the provider's role values; without them the host refuses to start. Its cookie is SameSite=Lax: the provider sends the browser back from another site. Register {host}/signin-oidc as the redirect URI.
• Unsecured mode logs warning 9401 at every start. Use it on a network where every visitor is already trusted.
• Roles:Operations:<operation> moves an operation to Operate or Administer in every mode: Roles:Operations:AddCalendar=Operate. A name the HTTP API does not publish refuses the start. In Unsecured mode the host also refuses to start when an entry lowers an operation that is Administer by default (AddJob, DeleteJob, Shutdown) to Operate: an anonymous visitor is never given an Administer operation. Raising an operation to Administer stays allowed.

The host never logs a token: the hosting layer's request lines, which carry the address and its query, are held at Warning whatever Logging says, per-provider settings such as Logging:Console:LogLevel included.

Targets

Targets:<name> is one target, and <name> is the first half of each scheduler's identity on the dashboard (orders/OrdersScheduler). It cannot contain / or +. A target is a scheduler's HTTP API or a database; saying both refuses the start.

• The provider is inferred from the connection string's keywords, by the rules Quartz.Aspire uses. An ambiguous string refuses the start; set Provider. MySql and SQLite are read with MySqlConnector and Microsoft.Data.Sqlite, the drivers the host carries.
• A store-attached target reads the job data types Quartz writes itself. The host does not have the application's types, so a job data map holding one is shown as unreadable.
• What a store-attached target can and cannot do is in Store-attached targets.

Agents

Agents:Tokens:Primary makes the host accept agents at {DashboardPath}/agents. A worker calls UseDashboardAgent() with Quartz:DashboardAgent:Endpoint, Token and Target set.

Run one instance while the host accepts agents. Their connections and the answers in flight are in that process's memory.

The dashboard and the process

• Telemetry: with OTEL_EXPORTER_OTLP_ENDPOINT set, Quartz's spans and instruments, ASP.NET Core's instruments and the logs go to that collector. ASP.NET Core's request spans are not exported: a span carries the address, and an address can carry a token.
• Logs: events 9400 to 9409, listed in Log Events. 9400 says at start what the host serves, and 9402 each reason it will not start.
• Behind a reverse proxy, set ASPNETCORE_FORWARDEDHEADERS_ENABLED=true so the cookie and the OpenID Connect redirect see the original scheme and host.

The container image

Every image carries a GitHub build provenance attestation. To check one:

gh attestation verify oci://ghcr.io/quartznet/quartz-dashboard:4.8.0 --owner quartznet

Limitations

• One instance while it accepts agents, as above.
• Store-attached targets read Quartz's own job data types, as above.
• No HTTP API. The host serves the dashboard only; the fleet API through the host is #4218.
• The operator's identity is not forwarded. An HTTP target sees the target's BearerToken, and an agent the agent token, whoever is signed in. A visitor's rights are the lower of their role and what the target allows.