FluxConfig.Provider 1.0.0-rc.3

This is a prerelease version of FluxConfig.Provider.
dotnet add package FluxConfig.Provider --version 1.0.0-rc.3
                    
NuGet\Install-Package FluxConfig.Provider -Version 1.0.0-rc.3
                    
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="FluxConfig.Provider" Version="1.0.0-rc.3" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="FluxConfig.Provider" Version="1.0.0-rc.3" />
                    
Directory.Packages.props
<PackageReference Include="FluxConfig.Provider" />
                    
Project file
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 FluxConfig.Provider --version 1.0.0-rc.3
                    
#r "nuget: FluxConfig.Provider, 1.0.0-rc.3"
                    
#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.
#addin nuget:?package=FluxConfig.Provider&version=1.0.0-rc.3&prerelease
                    
Install FluxConfig.Provider as a Cake Addin
#tool nuget:?package=FluxConfig.Provider&version=1.0.0-rc.3&prerelease
                    
Install FluxConfig.Provider as a Cake Tool

FluxConfig Provider

FluxConfig Microsoft.Extensions.Configuration custom Provider.

Introduces a .NET platform-integrated client for interacting with the FluxConfig system. Provides automated retrieval and updating of the application's running configuration without the need to restart the application or interact with the deployment environment.

Supported runtimes

  • .NET 6+
  • .NET Core 3+

Getting Started

0. Prerequisites

FluxConfig service complex, including

deployed and ready on your system.

To learn more about deployment visit Deployment Guidance

1. Install NuGet package

dotnet add package FluxConfig.Provider

or

Install-Package FluxConfig.Provider

2. Visit FluxConfig.WebClient to get an api key for your application configuration

TBA.

3. Add FluxConfig Provider to your application

Add FluxConfig Provider to your application IConfiguration via IConfigurationBuilder

IConfigurationRoot config = new ConfigurationBuilder()
            .AddFluxConfig(options =>
            {
                options.ConnectionOptions = new ConnectionOptions
                {
                    Address = new Uri("https://your-fluxconfig-storage-url"),
                    ApiKey = "Your application configuration api key"
                };
            
                options.ConfigurationTag = "Your application configuration tag";           
            }).Build();

4. Configure FluxConfig Provider if needed

Configure data polling behaviour

options.PollingOptions = new FluxPollingOptions
        {
            ExceptionBehavior = PollingExceptionBehavior.Ignore,
            RefreshInterval = TimeSpan.FromSeconds(10)
        };

Configure Logging

options.LoggerFactory = LoggerFactory.Create(optionsBuilder =>
                {
                    optionsBuilder.AddConsole();
                    optionsBuilder.SetMinimumLevel(LogLevel.Information);
                });

Configure custom FluxConfig Exception handler if

ExceptionBehavior = PollingExceptionBehavior.Throw

is selected

// Example of application termination handler
configurationBuilder.SetFluxConfigExceptionHandler(ctx =>
    {
        ctx.Logger.LogWarning("Handler: Exception occured while fetching config data: {message}", ctx.Exception?.Message);
        Environment.Exit(-1);
    });
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  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 was computed.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

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
1.0.0-rc.3 53 4/4/2025
1.0.0-rc.2 59 4/4/2025
1.0.0-rc.1 65 4/4/2025

Release candidate build including core functionality. Fixed XML and project documentation.