Installation

Install the package

.NET CLI

dotnet add package Zeridion.Flare --prerelease

Package Manager

Install-Package Zeridion.Flare -Pre

PackageReference

<PackageReference Include="Zeridion.Flare" Version="0.1.0-beta.1" />

Framework compatibility

The package multi-targets net10.0 and netstandard2.1, so it works across all modern .NET versions without conditional compilation on your side.

Target Framework	Supported .NET Versions	Notes
net10.0	.NET 10	Full feature support, recommended
netstandard2.1	.NET 6, 7, 8, 9	Full feature support

Supported project types

Zeridion Flare works in any .NET project that uses Microsoft.Extensions.Hosting:

• ASP.NET Core Web API / Minimal API — most common
• ASP.NET Core MVC / Razor Pages
• Worker Services (Host.CreateDefaultBuilder)
• Console apps (with HostBuilder)
• Blazor Server

note

Blazor WebAssembly is not supported because jobs execute server-side and require the hosting infrastructure.

Configuration

Add your API key to appsettings.json:

{
  "Zeridion": {
    "ApiKey": "zf_live_sk_xxxxxxxxxxxxxxxxxxxx"
  }
}

Then bind it in Program.cs:

builder.Services.AddZeridionFlare(options =>
{
    options.ApiKey = builder.Configuration["Zeridion:ApiKey"]!;
});

Local development

For local development against the Flare API running in Docker, override ApiBaseUrl in appsettings.Development.json:

{
  "Zeridion": {
    "ApiKey": "zf_test_sk_local_development_key",
    "ApiBaseUrl": "http://localhost:5000"
  }
}

Verify installation

Run your application and look for the Flare worker startup log in the console output:

dotnet run

You should see log output indicating the worker has started and is polling for jobs. If the API key is valid and the API is reachable, the worker will begin its poll loop immediately.

danger

If ApiKey is missing or empty, the app throws an ArgumentException at startup. This is by design — configuration errors are caught before your app accepts traffic.

For a full list of configuration options (queues, retries, timeouts, concurrency), see Configuration.