Hangfire README

The project's README from github.com/HangfireIO/Hangfire. As one markdown file: README.md.

Hangfire

Official Site Latest version Downloads License LGPLv3 Coverity Scan

Build Status

  main dev
AppVeyor Windows Build Status Windows Build Status

Overview

Incredibly easy way to perform fire-and-forget, delayed and recurring jobs in .NET applications. CPU and I/O intensive, long-running and short-running jobs are supported. No Windows Service / Task Scheduler required. Backed by Redis, SQL Server, SQL Azure and MSMQ.

Hangfire provides a unified programming model to handle background tasks in a reliable way and run them on shared hosting, dedicated hosting or in cloud. You can start with a simple setup and grow computational power for background jobs with time for these scenarios:

Hangfire is a .NET alternative to Resque, Sidekiq, delayed_job, Celery.

Hangfire Dashboard

Installation

Hangfire is available as a NuGet package. You can install it using the NuGet Package Console window:

PM> Install-Package Hangfire

After installation, update your existing OWIN Startup file with the following lines of code. If you do not have this class in your project or don't know what is it, please read the Quick start guide to learn about how to install Hangfire.

public void Configuration(IAppBuilder app)
{
    GlobalConfiguration.Configuration.UseSqlServerStorage("<connection string or its name>");
    
    app.UseHangfireServer();
    app.UseHangfireDashboard();
}

Usage

This is an incomplete list of features; to see all of them, check the official site and the documentation.

Fire-and-forget tasks

Dedicated worker pool threads execute queued background jobs as soon as possible, shortening your request's processing time.

BackgroundJob.Enqueue(() => Console.WriteLine("Simple!"));

Delayed tasks

Scheduled background jobs are executed only after a given amount of time.

BackgroundJob.Schedule(() => Console.WriteLine("Reliable!"), TimeSpan.FromDays(7));

Recurring tasks

Recurring jobs have never been simpler; just call the following method to perform any kind of recurring task using the CRON expressions.

RecurringJob.AddOrUpdate(() => Console.WriteLine("Transparent!"), Cron.Daily);

Continuations

Continuations allow you to define complex workflows by chaining multiple background jobs together.

var id = BackgroundJob.Enqueue(() => Console.WriteLine("Hello, "));
BackgroundJob.ContinueWith(id, () => Console.WriteLine("world!"));

Process background tasks inside a web application…

You can process background tasks in any OWIN-compatible application framework, including ASP.NET MVC, ASP.NET Web API, FubuMvc, Nancy, etc. Forget about AppDomain unloads, Web Garden & Web Farm issues – Hangfire is reliable for web applications from scratch, even on shared hosting.

app.UseHangfireServer();

… or anywhere else

In console applications, Windows Service, Azure Worker Role, etc.

using (new BackgroundJobServer())
{
    Console.WriteLine("Hangfire Server started. Press ENTER to exit...");
    Console.ReadLine();
}

Questions? Problems?

Open-source projects develop more smoothly when discussions are public.

If you have any questions, problems related to Hangfire usage or if you want to discuss new features, please visit the discussion forum. You can sign in there using your existing Google or GitHub account, so it's very simple to start using it.

If you've discovered a bug, please report it to the Hangfire GitHub Issues. Detailed reports with stack traces, actual and expected behaviours are welcome.

Please see the Extensions page on the official site.

Building the sources

Prerequisites:

Then, create an environment variable with Variable name Hangfire_SqlServer_ConnectionStringTemplate and put your connection string in the Variable value field. Example:

To build a solution and get assembly files, just run the following command. All build artifacts, including *.pdb files, will be placed into the build folder. Before proposing a pull request, please use this command to ensure everything is ok. Btw, you can execute this command from the Package Manager Console window.

build

To build NuGet packages as well as an archive file, use the pack command as shown below. You can find the result files in the build folder.

build pack

To see the full list of available commands, pass the -docs switch:

build -docs

Hangfire uses psake build automation tool. All psake tasks and functions defined in psake-build.ps1 (for this project) and psake-common.ps1 (for other Hangfire projects) files. Thanks to the psake project, they are very simple to use and modify!

Razor templates are compiled upon save with the Razor Generator Visual Studio extension. You will need this installed if you want to modify the Dashboard UI.

Reporting security issues

In order to give the community time to respond and upgrade we strongly urge you report all security issues privately. Please email us at [email protected] with details and we will respond ASAP. Security issues always take precedence over bug fixes and feature work. We can and do mark releases as "urgent" if they contain serious security fixes.

License

Copyright © 2013-2026 Hangfire OÜ.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this program. If not, see https://www.gnu.org/licenses/.

By submitting a Pull Request, you disavow any rights or claims to any changes submitted to the Hangfire project and assign the copyright of those changes to Hangfire OÜ.

If you cannot or do not want to reassign those rights (your employment contract for your employer may not allow this), you should not submit a PR. Open an issue and someone else can do the work.

This is a legal way of saying "If you submit a PR to us, that code becomes ours". 99.9% of the time that's what you intend anyways; we hope it doesn't scare you away from contributing.

Hangfire (HangfireIO/Hangfire)

Searching Database…

10.2K ·GitHub
Hangfire
What is this?Hangfire is a library for .NET and .NET Core that lets you run fire-and-forget, delayed, and recurring background jobs inside your application, without needing a Windows Service or a separate worker process.
Is this a library I add to my app, or a standalone service?It's a library you install via NuGet into your existing .NET application; it runs inside your app's process (web app, console app, Windows Service, etc.) rather than as a separate daemon.
How do I add it to my project?Install the Hangfire NuGet package, then update your OWIN Startup class with the Hangfire initialization code shown in the quick start guide.
What storage backend do I need?Hangfire needs a persistent storage backend to keep track of jobs; it supports Redis, SQL Server, SQL Azure, and MSMQ.
Does it only work in web apps?No, it can run in ASP.NET MVC/Web API apps, but also console applications, Windows Services, Azure Worker Roles, and other process types.
Who is this aimed at?It's aimed at .NET developers who need reliable background processing (notifications, imports, reports, image/video processing, etc.) without managing a separate scheduler process.
How does it compare to Celery or Sidekiq?Hangfire is described as the .NET equivalent of Resque, Sidekiq, delayedjob, and Celery, bringing the same background-job pattern to the .NET ecosystem.
Can I chain jobs together?Yes, Hangfire supports continuations, letting you define complex workflows by chaining multiple background jobs so one job runs after another completes.
How do recurring jobs get scheduled?Recurring jobs are defined with a single method call using standard CRON expressions to control their schedule.
Does it work on shared hosting?Yes, since jobs run inside worker pool threads within your existing app process, Hangfire works reliably even on shared, dedicated, or cloud hosting without extra server-level permissions.
What are similar projects?nopCommerce, rq, server, efcore, effect-mq, celery, bull, Dapper
Which topics is it in?sqlserver, background-jobs, sql-server, dotnet-core, cron, scheduler, async, dotnet, c#, mysql, redis, gplv3
Creator
HangfireIO
Size
40.7 MB
Stars
10.2K
Updated
CommitOct 15Releasev1.8.25Aug 28
Age
13y
Commits · 90 Days