Dashboard Setup

The TickerQ.Dashboard package provides a ready-to-use, real-time interface to monitor and manage your background jobs. It supports both CronTicker and TimeTicker entries and displays live job status, execution history, concurrency levels, and more.

---

Install the Dashboard Package

You can install it with:

.NET CLI

> dotnet add package TickerQ.Dashboard

Package Manager

PM> NuGet\Install-Package TickerQ.Dashboard

Package Reference

<PackageReference Include="TickerQ.Dashboard" Version="*" />

Basic Configuration

Update your Program.cs to register the dashboard support:

builder.Services.AddTickerQ(options =>
{
    options.AddOperationalStore<WebAppDbContext>();
    options.SetInstanceIdentifier("TickerQ");
    // ...
    
    // Dashboard configuration
    options.AddDashboard(dbopt =>
    {                                                                              
        // Mount path for the dashboard UI (default: "/tickerq-dashboard").
        dbopt.BasePath = "/tickerq-dashboard";                                     

        // Allowed CORS origins for dashboard API (default: ["*"]).
        dbopt.CorsOrigins = new[] { "https://arcenox.com" };                       

        // Backend API domain (scheme/SSL prefix supported).
        dbopt.BackendDomain = "ssl:arcenox.com";                                   

        // Authentication
        dbopt.EnableBuiltInAuth = true;  // Use TickerQ’s built-in auth (default).
        dbopt.UseHostAuthentication = false; // Use host auth instead (off by default).
        dbopt.RequiredRoles = new[] { "Admin", "Ops" };                            
        dbopt.RequiredPolicies = new[] { "TickerQDashboardAccess" };               

        // Basic auth toggle (default: false).
        dbopt.EnableBasicAuth = true;                                              

        // Pipeline hooks
        dbopt.PreDashboardMiddleware = app => { /* e.g., request logging */ };     
        dbopt.CustomMiddleware      = app => { /* e.g., extra auth/rate limits */ }; 
        dbopt.PostDashboardMiddleware = app => { /* e.g., metrics collection */ }; 
    });                                                                            
});

This exposes the dashboard at /tickerq-dashboard by default.

---

Securing the Dashboard (Optional)

You can control access to the dashboard using built-in Basic Auth.

Add the following to your appsettings.json:

"TickerQBasicAuth": {
  "Username": "admin",
  "Password": "admin"
}

This enables a login form at the dashboard endpoint using the credentials above.

By default, AddDashboardBasicAuth() enables a simple login screen with username/password from appsettings.

---

Features

The dashboard includes:

• Job execution logs and history
• Visual breakdown of job statuses (success, failed, pending)
• Concurrency insights (running threads, queued jobs)
• Real-time refresh via SignalR
• Manual job trigger support
• Cancel running jobs directly from the dashboard
• Add new jobs (CronTicker or TimeTicker) from the dashboard
• Edit existing jobs and reschedule them
• Delete or disable jobs manually
• Duplicate existing jobs with a new schedule or name

Summary

• Install TickerQ.Dashboard
• Register it with .AddDashboard() and .AddDashboardBasicAuth()
• Use middleware app.UseTickerQDashboard()
• Secure and customize as needed