mirror of
https://github.com/dotnetcore/AgileConfig.git
synced 2026-10-18 13:11:08 +08:00
kami-poi
259 lines
7.9 KiB
Markdown
259 lines
7.9 KiB
Markdown
<p align="center">
|
||
<img height="130" src="https://ftp.bmp.ovh/imgs/2021/04/5162f8595d9c6a99.png" style="height: 130px">
|
||
</p>
|
||
|
||
<h1 align="center">AgileConfig</h1>
|
||
|
||
|
||
|
||
[](https://github.com/dotnetcore)
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
# [English](https://github.com/kklldog/AgileConfig/blob/master/README_EN.md) | [中文](https://github.com/kklldog/AgileConfig/blob/master/README.md)
|
||
|
||
This is a lightweight configuration center based on .net core . It is easy to deploy , easy to learn , easy to use .
|
||
## Features
|
||
1. easy to deploy (docker or IIS)
|
||
2. support distributed deploy
|
||
3. multiple environments support
|
||
4. configuration changes takes effect in real time
|
||
5. support IConfiguration , IOptions patten to read configurations
|
||
6. restful api
|
||
7. version management
|
||
|
||
Demo Project ：[AgileConfig Server Demo](http://agileconfig_server.xbaby.xyz) username ：admin password ：123456
|
||
client project ：[AgileConfig_Client](https://github.com/kklldog/AgileConfig_Client)
|
||
samples ：
|
||
[AgileConfigMVCSample](https://github.com/kklldog/AgileConfig_Client/tree/master/AgileConfigMVCSample)
|
||
[AgileConfig WPFSample](https://github.com/kklldog/AgileConfig_Client/tree/master/AgileConfigWPFSample)
|
||
[AgileConfig ConsoleSample](https://github.com/kklldog/AgileConfig_Client/tree/master/AgileConfigConsoleSample)
|
||
|
||
API:
|
||
[restful api](https://github.com/kklldog/AgileConfig/wiki/Restful-API)
|
||
## ChangeLog
|
||
[Changelog](https://github.com/kklldog/AgileConfig/blob/master/CHANGELOG.md)
|
||
## architecture
|
||
|
||
### client
|
||
A .net client to read configurations from server node .
|
||
### node
|
||
Node is just a .net core app . Client connect to the node to read configurations . Any node can be an admin console to manage configuration .
|
||
### database
|
||
AgileConfig can use many database to persist configurations .
|
||
dbprovider :
|
||
sqlserver = SqlServer
|
||
mysql = MySql
|
||
sqlite = Sqlite
|
||
npgsql = PostgreSql
|
||
oracle = Oracle
|
||
|
||
## useage
|
||
### run node
|
||
``` shell
|
||
sudo docker run \
|
||
--name agile_config \
|
||
-e TZ=Asia/Shanghai \
|
||
-e adminConsole=true \
|
||
-e db__provider=sqlite \
|
||
-e db__conn="Data Source=agile_config.db" \
|
||
-p 5000:5000 \
|
||
-v /etc/localtime:/etc/localtime \
|
||
#-v /your_host_dir:/app/db \
|
||
-d kklldog/agile_config:latest
|
||
```
|
||
## use client
|
||
install client lib from nuget：
|
||
```
|
||
Install-Package AgileConfig.Client
|
||
```
|
||
add a agileconfig section in appsettings.json：
|
||
``` json
|
||
{
|
||
"Logging": {
|
||
"LogLevel": {
|
||
"Default": "Information",
|
||
"Microsoft": "Warning",
|
||
"Microsoft.Hosting.Lifetime": "Information"
|
||
}
|
||
},
|
||
"AllowedHosts": "*",
|
||
|
||
//agile_config
|
||
"AgileConfig": {
|
||
"appId": "app",
|
||
"secret": "xxx",
|
||
"nodes": "http://localhost:5000,http://localhost:5001",
|
||
"name": "client_name",
|
||
"tag": "tag1",
|
||
"env": "dev"
|
||
}
|
||
}
|
||
|
||
```
|
||
appsettings.json
|
||
``` c#
|
||
public static IHostBuilder CreateHostBuilder(string[] args) =>
|
||
Host.CreateDefaultBuilder(args)
|
||
.ConfigureAppConfiguration((context, config) =>
|
||
{
|
||
//default appsettings.json
|
||
config.AddAgileConfig(arg => Console.WriteLine($"config changed , action:{arg.Action} key:{arg.Key}"));
|
||
})
|
||
.ConfigureWebHostDefaults(webBuilder =>
|
||
{
|
||
webBuilder.UseStartup<Startup>();
|
||
});
|
||
-----or------
|
||
|
||
public static IHostBuilder CreateHostBuilder(string[] args) =>
|
||
Host.CreateDefaultBuilder(args)
|
||
.UseAgileConfig(e => Console.WriteLine($"configs {e.Action}"))
|
||
.ConfigureWebHostDefaults(webBuilder =>
|
||
{
|
||
webBuilder.UseStartup<Startup>();
|
||
});
|
||
```
|
||
appsettings.{env}.json
|
||
``` c#
|
||
public static IHostBuilder CreateHostBuilder(string[] args) =>
|
||
Host.CreateDefaultBuilder(args)
|
||
.ConfigureAppConfiguration((context, config) =>
|
||
{
|
||
var envName = context.HostingEnvironment.EnvironmentName;
|
||
var configClient = new ConfigClient($"appsettings.{envName}.json");
|
||
config.AddAgileConfig(configClient, arg => Console.WriteLine($"config changed , action:{arg.Action} key:{arg.Key}"));
|
||
})
|
||
.ConfigureWebHostDefaults(webBuilder =>
|
||
{
|
||
webBuilder.UseStartup<Startup>();
|
||
});
|
||
```
|
||
|
||
|
||
## read configuration
|
||
|
||
``` c#
|
||
public class HomeController : Controller
|
||
{
|
||
private readonly ILogger<HomeController> _logger;
|
||
private readonly IConfiguration _IConfiguration;
|
||
private readonly IOptions<DbConfigOptions> _dbOptions;
|
||
|
||
public HomeController(ILogger<HomeController> logger, IConfiguration configuration, IOptions<DbConfigOptions> dbOptions)
|
||
{
|
||
_logger = logger;
|
||
_IConfiguration = configuration;
|
||
_dbOptions = dbOptions;
|
||
}
|
||
|
||
public IActionResult Index()
|
||
{
|
||
return View();
|
||
}
|
||
|
||
/// <summary>
|
||
/// By IConfiguration to read
|
||
/// </summary>
|
||
/// <returns></returns>
|
||
public IActionResult ByIConfiguration()
|
||
{
|
||
var userId = _IConfiguration["userId"];
|
||
var dbConn = _IConfiguration["db:connection"];
|
||
|
||
ViewBag.userId = userId;
|
||
ViewBag.dbConn = dbConn;
|
||
|
||
return View();
|
||
}
|
||
|
||
/// <summary>
|
||
/// By Options to read
|
||
/// </summary>
|
||
/// <returns></returns>
|
||
public IActionResult ByOptions()
|
||
{
|
||
var dbConn = _dbOptions.Value.connection;
|
||
ViewBag.dbConn = dbConn;
|
||
|
||
return View("ByOptions");
|
||
}
|
||
}
|
||
```
|
||
|
||
dependency injection
|
||
``` c#
|
||
public class Startup
|
||
{
|
||
public void ConfigureServices(IServiceCollection services)
|
||
{
|
||
services.AddAgileConfig();
|
||
}
|
||
}
|
||
```
|
||
|
||
``` c#
|
||
public class HomeController : Controller
|
||
{
|
||
private readonly IConfigClient _configClient
|
||
|
||
public HomeController(IConfigClient configClient)
|
||
{
|
||
_configClient = configClient;
|
||
}
|
||
|
||
public IActionResult Index()
|
||
{
|
||
return View();
|
||
}
|
||
|
||
/// <summary>
|
||
/// By IConfigClient to read
|
||
/// </summary>
|
||
/// <returns></returns>
|
||
public IActionResult ByIConfigClient()
|
||
{
|
||
var userId = _configClient["userId"];
|
||
var dbConn = _configClient["db:connection"];
|
||
|
||
foreach (var item in _configClient.Data)
|
||
{
|
||
Console.WriteLine($"{item.Key} = {item.Value}");
|
||
}
|
||
|
||
ViewBag.userId = userId;
|
||
ViewBag.dbConn = dbConn;
|
||
|
||
return View();
|
||
}
|
||
}
|
||
```
|
||
|
||
## screenshots
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
## donate
|
||
If this project is helpful to you, please scan the QR code below for a cup of coffee.
|
||
<img src="https://ftp.bmp.ovh/imgs/2021/07/c0146fa995e8074d.jpg" width="300">
|
||
<img src="https://ftp.bmp.ovh/imgs/2021/07/1c8748c5732b8fbe.jpg" width="300">
|
||
|
||
## thanks 💖💖💖
|
||
大鹏￥66.66 , 瘦草￥6.66 + 88 , ziana￥10.0 , Nullable￥9.99 , *三 ￥6.66 , HHM ￥6.66 , *。 ￥6.66 , 微笑刺客 ￥6.66 ,飞鸟与鱼 ￥38.88, *航 ￥9.9, *啦 ￥6.66, *海 ￥6.66, Dyx 邓杨喜 ￥30
|
||
## contact me
|
||
mail：minj.zhou@gmail.com
|
||
qq group：1022985150
|
||
|