LINGYUN.Abp.Hangfire.Dashboard

1. Introduction

LINGYUN.Abp.Hangfire.Dashboard is an ABP module for integrating the Hangfire dashboard, providing a user-friendly web interface for monitoring and managing Hangfire background jobs. This module supports permission control and authentication to ensure secure access to the dashboard.

2. Features

Integration with Hangfire dashboard
Access control based on ABP permission system
Support for loading dashboard in iframe
Access token authentication support
Dashboard permission caching mechanism

3. Installation

dotnet add package LINGYUN.Abp.Hangfire.Dashboard

4. Usage

Add AbpHangfireDashboardModule to your module dependencies:

[DependsOn(typeof(AbpHangfireDashboardModule))]
public class YourModule : AbpModule
{
}

Configure middleware:

public override void OnApplicationInitialization(ApplicationInitializationContext context)
{
    var app = context.GetApplicationBuilder();
    
    // Add Hangfire authentication middleware
    app.UseHangfireAuthorication();
}

Configure dashboard options:

public override void ConfigureServices(ServiceConfigurationContext context)
{
    PreConfigure<DashboardOptions>(options =>
    {
        options.Authorization = new[]
        {
            new DashboardAuthorizationFilter("YourPermissionName")
        };
    });
}

5. Authentication and Authorization

5.1 Authentication Methods

The module supports the following authentication methods:

Pass access token via URL parameter: ?access_token=your_token
Pass access token via Cookie
Pass access token via Authorization Header

5.2 Permission Caching

Permission check results are cached for 5 minutes to improve performance.

6. Dependencies

Volo.Abp.Authorization
Volo.Abp.Hangfire
Microsoft.Extensions.Caching.Memory

2.0 KiB Raw Blame History