Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hangfire-postgres/Hangfire.PostgreSql
PostgreSql Storage Provider for Hangfire
https://github.com/hangfire-postgres/Hangfire.PostgreSql
hangfire postgresql storage
Last synced: 1 day ago
JSON representation
PostgreSql Storage Provider for Hangfire
- Host: GitHub
- URL: https://github.com/hangfire-postgres/Hangfire.PostgreSql
- Owner: hangfire-postgres
- License: other
- Created: 2014-11-02T00:51:12.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2024-03-04T10:24:33.000Z (9 months ago)
- Last Synced: 2024-03-05T11:05:51.695Z (8 months ago)
- Topics: hangfire, postgresql, storage
- Language: C#
- Homepage:
- Size: 3.64 MB
- Stars: 329
- Watchers: 18
- Forks: 131
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: COPYING
- Security: SECURITY.md
Awesome Lists containing this project
README
# Hangfire.PostgreSql
[](https://github.com/hangfire-postgres/Hangfire.PostgreSql/actions/workflows/pack.yml) [](https://github.com/hangfire-postgres/Hangfire.PostgreSql/releases/latest) [](https://www.nuget.org/packages/Hangfire.PostgreSql)
This is an plugin to the Hangfire to enable PostgreSQL as a storage system.
Read about hangfire here: https://github.com/HangfireIO/Hangfire#overview
and here: http://hangfire.io/
## Instructions
### For .NET
Install Hangfire, see https://github.com/HangfireIO/Hangfire#installation
Download all files from this repository, add the Hangfire.PostgreSql.csproj to your solution.
Reference it in your project, and you are ready to go by using:
```csharp
app.UseHangfireServer(new BackgroundJobServerOptions(),
new PostgreSqlStorage(""));
app.UseHangfireDashboard();
```
### For ASP.NET Core
First, NuGet package needs installation.
- Hangfire.AspNetCore
- Hangfire.PostgreSql (Uses Npgsql 6)
- Hangfire.PostgreSql.Npgsql5 (Uses Npgsql 5)
Historically both packages were functionally the same up until the package version 1.9.11, the only difference was the underlying Npgsql dependency version. Afterwards, the support for Npgsql v5 has been dropped and now minimum required version is 6.0.0.
In `Startup.cs` _ConfigureServices(IServiceCollection services)_ method add the following line:
```csharp
services.AddHangfire(config =>
config.UsePostgreSqlStorage(c =>
c.UseNpgsqlConnection(Configuration.GetConnectionString("HangfireConnection"))));
```
In Configure method, add these two lines:
```csharp
app.UseHangfireServer();
app.UseHangfireDashboard();
```
And... That's it. You are ready to go.
If you encounter any issues/bugs or have idea of a feature regarding Hangfire.Postgresql, [create us an issue](https://github.com/hangfire-postgres/Hangfire.PostgreSql/issues/new). Thanks!
### Enabling SSL support
SSL support can be enabled for Hangfire.PostgreSql library using the following mechanism:
```csharp
config.UsePostgreSqlStorage(c =>
c.UseNpgsqlConnection(
Configuration.GetConnectionString("HangfireConnection"), // connection string,
connection => // connection setup - gets called after instantiating the connection and before any calls to DB are made
{
connection.ProvideClientCertificatesCallback += clientCerts =>
{
clientCerts.Add(X509Certificate.CreateFromCertFile("[CERT_FILENAME]"));
};
}
)
);
```
### License
Copyright © 2014-2024 Frank Hommers https://github.com/hangfire-postgres/Hangfire.PostgreSql.
Collaborators:
Frank Hommers (frankhommers), Vytautas Kasparavičius (vytautask), Žygimantas Arūna (azygis)
Contributors:
Andrew Armstrong (Plasma), Burhan Irmikci (barhun), Zachary Sims(zsims), kgamecarter, Stafford Williams (staff0rd), briangweber, Viktor Svyatokha (ahydrax), Christopher Dresel (Dresel), Vincent Vrijburg, David Roth (davidroth) and Ivan Tiniakov (Tinyakov).
Hangfire.PostgreSql is an Open Source project licensed under the terms of the LGPLv3 license. Please see http://www.gnu.org/licenses/lgpl-3.0.html for license text or COPYING.LESSER file distributed with the source code.
This work is based on the work of Sergey Odinokov, author of Hangfire.
### Related Projects
- [Hangfire.Core](https://github.com/HangfireIO/Hangfire)