|
| 1 | +# Cofoundry.Plugins.BackgroundTasks.Hangfire |
| 2 | + |
| 3 | +[](https://ci.appveyor.com/project/Cofoundry/cofoundry-plugins-backgroundtasks-hangfire) |
| 4 | +[](https://www.nuget.org/packages/Cofoundry.Plugins.BackgroundTasks.Hangfire/) |
| 5 | +[](https://gitter.im/cofoundry-cms/cofoundry) |
| 6 | + |
| 7 | + |
| 8 | +This library is a plugin for [Cofoundry](http://cofoundry.org/). For more information on getting started with Cofoundry check out the [Cofoundry repository](https://github.com/cofoundry-cms/cofoundry). |
| 9 | + |
| 10 | +## Overview |
| 11 | + |
| 12 | +> HangFire is an easy way to perform background processing in .NET and .NET Core applications. No Windows Service or separate process required. |
| 13 | +Backed by persistent storage. Open and free for commercial use. |
| 14 | +> |
| 15 | +> — [hangfire.io](http://hangfire.io/) |
| 16 | +
|
| 17 | +This [Hangfire](http://hangfire.io/) imlpementation of [Cofoundry.Core.BackgroundTasks](https://github.com/cofoundry-cms/cofoundry/wiki/Background-Tasks) includes: |
| 18 | + |
| 19 | +- A HangFire implementation of `IBackgroundTaskScheduler` |
| 20 | +- Automatically initializes HangFire using a [Startup Task](https://github.com/cofoundry-cms/cofoundry/wiki/Startup-Tasks) |
| 21 | +- Sets up HangFire to use SqlServer storage using the Cofoundry connection string. |
| 22 | +- Optionally sets up to the HangFire dashboard for admin users at **/admin/hangfire** |
| 23 | + |
| 24 | +Cofoundry does not include a background task runner by default so it is recommended that you use this library if you need to run background tasks. |
| 25 | + |
| 26 | +## Settings |
| 27 | + |
| 28 | +- **Cofoundry.Plugins.Hangfire.DisableHangfire:** Prevents the HangFire server being configuted and started. Defaults to false. |
| 29 | +- **Cofoundry.Plugins.Hangfire.EnableHangfireDashboard:** Enables the HangFire dashboard for Cofoundry admin users at */admin/hangfire*. Defaults to false. |
| 30 | + |
| 31 | +## Customizing the HangFire Initialization Process |
| 32 | + |
| 33 | +We use an automatic boostrapper to make HangFire integration simple for most scenarios, but if you want to customize the process you can override the default `IHangfireServerInitializer` implementation using the [Cofoundry DI system](https://github.com/cofoundry-cms/cofoundry/wiki/Dependency-Injection#overriding-registrations). |
| 34 | + |
| 35 | +This might be required if you want to configure a faster storage engine like [reddis](http://docs.hangfire.io/en/latest/configuration/using-redis.html) for scaling up your deployment. |
| 36 | + |
| 37 | + |
| 38 | + |
| 39 | + |
| 40 | + |
| 41 | + |
| 42 | + |
0 commit comments