jannikbuschke/glow-module-template

ef-configuration-provider

An ASP.NET Core configuration provider backed by EF core

This library allows to use a sql database table for configuration values in an ASP.NET Core project.

Install

https://www.nuget.org/packages/EfConfigurationProvider/

dotnet add package EfConfigurationProvider.Core
dotnet add package EfConfigurationProvider.Ui

// add one of the following database providers
dotnet add package EfConfigurationProvider.Core.SqlServer
dotnet add package EfConfigurationProvider.Core.Sqlite

Configure

in Program cs

using EfConfigurationProvider.Core;
using EfConfigurationProvider.Core.SqlServer;
using EfConfigurationProvider.Core.Sqlite;

public static IWebHostBuilder CreateWebHostBuilder(string[] args)
{
    return WebHost.CreateDefaultBuilder(args)
        .ConfigureAppConfiguration((context, conf) =>
        {
            // depending on the database you want to use, pick one of the following configurations

            // SQL Server
            var cs = "Data Source=(localdb)\\MSSQLLocalDB;Initial Catalog=config-test;Integrated Security=True;Connect Timeout=30;Encrypt=False;TrustServerCertificate=False;ApplicationIntent=ReadWrite;MultiSubnetFailover=False";
            conf.AddEFConfiguration(options => options.UseSqlServer(cs, options =>
            {
                options.MigrationsAssembly("EfConfigurationProvider.Core.SqlServer");
            }));

            // SQLite
            var cs = "Data Source=sample.sqlite";
            conf.AddEFConfiguration(options => options.UseSqlite(cs, options =>
            {
                options.MigrationsAssembly("EfConfigurationProvider.Core.Sqlite");
            }));
        })
        .UseStartup<Startup>();
}

in Startup.cs

using EfConfigurationProvider.Core;
using EfConfigurationProvider.Ui;


public void ConfigureServices(IServiceCollection services)
{
    services.AddAuthorization(options =>
    {
        options.AddPolicy("admin", policy =>
        {
            policy.RequireRole("admin");
        });
    });
    services.AddMvc();
    services.AddEfConfiguration(options =>
    {
        options.GlobalPolicy = "admin";
    });
    services.AddEfConfigurationUi(new[] { GetType().Assembly });

    // if you are using strongly typed options, configure them in Startup.cs as usual
    services.Configure<MyStronglyTypedOptions>(configuration.GetSection("myoptions"));
}

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }

    app.UseMvc();
    app.UseEfConfigurationUi(); // enables a ui served under  /__configuration/index.html
}

To enable configuration and validation support for strongly typed options, provide the GeneratedController attribute to your class:

[GeneratedController("some-unique-id", Title = "My Options")]
public class MyStronglyTypedOptions
{
    [Required]
    public int Value1 { get; set; }
    public bool Flag { get; set; }
    [EmailAddress]
    public string Email { get; set; }
}

Features / Roadmap

• ✅ Simple table based edit of all key/values
• ✅ MS SQL provider
• ✅ SQLite provider
• ✅ Embedded frontend
• ✅ Configurable authorization
• ✅ Save history
• 🔲 Allow rollbacks
• 🔲 Configurable routes (for frontend and backend)
• 🔲 Postgresql, MySQL provider