ConfigHub.Client
0.1.0-beta.1
This is a prerelease version of ConfigHub.Client.
dotnet add package ConfigHub.Client --version 0.1.0-beta.1
NuGet\Install-Package ConfigHub.Client -Version 0.1.0-beta.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="ConfigHub.Client" Version="0.1.0-beta.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="ConfigHub.Client" Version="0.1.0-beta.1" />
<PackageReference Include="ConfigHub.Client" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add ConfigHub.Client --version 0.1.0-beta.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: ConfigHub.Client, 0.1.0-beta.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package ConfigHub.Client@0.1.0-beta.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=ConfigHub.Client&version=0.1.0-beta.1&prerelease
#tool nuget:?package=ConfigHub.Client&version=0.1.0-beta.1&prerelease
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
ConfigHub.Client
Official .NET client SDK for ConfigHub — enterprise configuration management with real-time updates.
Multi-targeted: net8.0 / net9.0 / net10.0.
Features
- Configuration provider — plug ConfigHub directly into
IConfigurationwith live reload (IConfiguration,IOptions<T>,IOptionsMonitor<T>) - ETag-based caching — automatic
If-None-Matchhandling, server responds304 Not Modified - Polling refresh — background service that reloads configuration on an interval
- SignalR real-time updates — push notifications (MessagePack) trigger instant refresh
- Resilience — built-in retry, circuit breaker, and timeout policies
- Strongly-typed exceptions —
ConfigHubNotFoundException,ConfigHubUnauthorizedException,ConfigHubRateLimitException,ConfigHubConnectionException
Installation
dotnet add package ConfigHub.Client
Quick start
Option 1 — Configuration provider (recommended)
ConfigHub values become part of IConfiguration and refresh automatically:
var builder = WebApplication.CreateBuilder(args);
builder.Configuration.AddConfigHub(options =>
{
options.Endpoint = "https://confighub.example.com";
options.ApiKey = "<your-api-key>";
options.AppId = "my-app";
options.Environment = "production";
options.EnablePollingRefresh = true; // optional
options.PollingInterval = TimeSpan.FromMinutes(1);
options.EnableSignalR = true; // optional, real-time push
});
builder.Services.AddConfigHubRefresh(builder.Configuration);
var app = builder.Build();
// Read values like any other configuration source
var maxRetries = app.Configuration["MaxRetries"];
Option 2 — appsettings.json
{
"ConfigHub": {
"Endpoint": "https://confighub.example.com",
"ApiKey": "<your-api-key>",
"AppId": "my-app",
"Environment": "production",
"Version": "1.0",
"Profile": "default",
"EnablePollingRefresh": true,
"PollingInterval": "00:01:00",
"EnableSignalR": false
}
}
builder.Configuration.AddConfigHub(builder.Configuration);
builder.Services.AddConfigHubRefresh(builder.Configuration);
Options
| Option | Default | Description |
|---|---|---|
Endpoint |
required | Base URL of the ClientApi |
ApiKey |
required | API key (sent as Bearer token) |
AppId |
required | Application identifier |
Environment |
required | Environment name |
Version |
"1.0" |
Configuration version |
Profile |
"default" |
Profile for instance-level differentiation |
EnablePollingRefresh |
false |
Enable polling background service |
PollingInterval |
5 min |
Minimum 10 seconds |
EnableSignalR |
false |
Enable real-time SignalR updates |
AutoRefreshOnSignalRUpdate |
true |
Refresh when a notification arrives |
SignalRReconnectIntervalSeconds |
5 |
Delay between SignalR reconnection attempts |
SignalRMaxReconnectAttempts |
0 |
Max reconnection attempts (0 = infinite) |
SkipCertificateValidation |
false |
Dev only — skip TLS validation |
Error handling
| Exception | When |
|---|---|
ConfigHubNotFoundException |
Key or config set does not exist |
ConfigHubUnauthorizedException |
Invalid or revoked API key |
ConfigHubRateLimitException |
Rate limited (exposes RetryAfter) |
ConfigHubConnectionException |
Network failure or timeout |
License
Licensed under the GNU Affero General Public License v3.0 — see LICENSE in the repository.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net10.0
- Microsoft.AspNetCore.SignalR.Client (>= 10.0.11)
- Microsoft.AspNetCore.SignalR.Protocols.MessagePack (>= 10.0.11)
- Microsoft.Extensions.Configuration (>= 10.0.11)
- Microsoft.Extensions.Configuration.Binder (>= 10.0.11)
- Microsoft.Extensions.Hosting.Abstractions (>= 10.0.11)
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.11)
- Microsoft.Extensions.Options (>= 10.0.11)
-
net8.0
- Microsoft.AspNetCore.SignalR.Client (>= 10.0.11)
- Microsoft.AspNetCore.SignalR.Protocols.MessagePack (>= 10.0.11)
- Microsoft.Extensions.Configuration (>= 10.0.11)
- Microsoft.Extensions.Configuration.Binder (>= 10.0.11)
- Microsoft.Extensions.Hosting.Abstractions (>= 10.0.11)
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.11)
- Microsoft.Extensions.Options (>= 10.0.11)
- System.Text.Json (>= 10.0.11)
-
net9.0
- Microsoft.AspNetCore.SignalR.Client (>= 10.0.11)
- Microsoft.AspNetCore.SignalR.Protocols.MessagePack (>= 10.0.11)
- Microsoft.Extensions.Configuration (>= 10.0.11)
- Microsoft.Extensions.Configuration.Binder (>= 10.0.11)
- Microsoft.Extensions.Hosting.Abstractions (>= 10.0.11)
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.11)
- Microsoft.Extensions.Options (>= 10.0.11)
- System.Text.Json (>= 10.0.11)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last Updated |
|---|---|---|
| 0.1.0-beta.1 | 77 | 8/28/2026 |