https://github.com/nerosoftdev/starfish
A lightweight powerful distributed configuration server for .NET application.
https://github.com/nerosoftdev/starfish
appsettings asp-net asp-net-core aspnet-core configuration configuration-center configuration-management configuration-server configuration-service net netcore
Last synced: 3 months ago
JSON representation
A lightweight powerful distributed configuration server for .NET application.
- Host: GitHub
- URL: https://github.com/nerosoftdev/starfish
- Owner: NerosoftDev
- License: agpl-3.0
- Created: 2023-11-07T15:29:29.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-09-14T00:34:57.000Z (9 months ago)
- Last Synced: 2025-02-15T21:33:57.056Z (4 months ago)
- Topics: appsettings, asp-net, asp-net-core, aspnet-core, configuration, configuration-center, configuration-management, configuration-server, configuration-service, net, netcore
- Language: C#
- Homepage:
- Size: 1.58 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Overview/概览 ⚡
[](https://github.com/NerosoftDev/Starfish/actions)
[](LICENSE)
[](https://github.com/NerosoftDev/Starfish/releases)
[](https://github.com/NerosoftDev/Starfish/stargazers)
Starfish is a lightweight powerful distributed configuration server for .NET application.
Starfish是一个轻量但功能强大的分布式 .NET 应用程序配置中心。
## ⌨️ Features/功能
> 💚 Completed/已完成 ⌛ In progress/进行中 🕝 Planned/计划中
- [ ] ⌛ Support multiple data sources/支持多种数据源
- [x] 💚 MySQL
- [x] 💚 SqlServer
- [x] 💚 PostgreSQL
- [ ] 🕝 MongoDB
- [x] 💚 Sqlite
- [x] 💚 Support multiple platforms/支持多种平台
- [x] 💚 Web API/Web Application/gRPC Service in .NET6/7/8
- [x] 💚 .NET MAUI
- [x] 💚 WPF application
- [ ] 🕝 Support multiple node deployment/支持多节点部署
- [x] 💚 Support multiple environments/支持多环境
- [ ] ⌛ Deploy with docker/支持Docker部署
- [x] 💚 Support client cache/支持客户端缓存
- [ ] ⌛ Multiple protocols support/支持多种协议
- [x] 💚 HTTP
- [ ] 🕝 gRPC
- [x] 💚 WebSocket
- [x] 💚 Sync configuration to Redis server. / 同步配置到Redis服务器。
- [ ] 🕝 Rollback to history version/回滚到历史版本
- [ ] 🕝 Role-based access control/基于角色的访问控制
- [x] 💚 Support multiple languages admin panel/支持多语言管理面板
- [x] 💚 en/英语
- [x] 💚 zh-Hans/简体中文
- [x] 💚 zh-Hant/繁体中文
## 💰 Donate/捐助
**Paypal**
[](https://www.paypal.me/realzhaorong)
[https://www.paypal.me/realzhaorong](https://www.paypal.me/realzhaorong)
---
> If you like my work, you can support me by donation. / 如果您喜欢我的工作，可以通过捐赠来支持我。
## 📨 Contact and Suggestions/联系与建议
Any feedback is welcome, you can create a issue, or contact us by email, thank you.
非常乐意收到您的任何反馈，您可以创建一个 issue，或通过邮件联系我们，谢谢。
> [[email protected]](mailto:[email protected])
## 🔑 License/许可证
This project is licensed under the AGPL-3.0 License - see the [LICENSE](LICENSE) file for details.
本项目采用 AGPL-3.0 协议，可查看 [LICENSE](LICENSE) 了解更详细内容。
# Getting Started/快速开始 ⚡
## Solution structure/解决方案结构
```
Starfish
├──Source
├ ├──Starfish.Client
├ ├──~~Starfish.Agent~~
├ ├──Starfish.Common
├ ├──Starfish.Service
├ ├──Starfish.Transit
├ ├──Starfish.Webapi
├ ├──Starfish.Webapp
├──Tests
├ ├──Starfish.Client.Tests
├ ├──Starfish.Service.Tests
```
## Depdenencies Structure/依赖关系结构
```mermaid
graph TD
Starfish.Webapi --> Starfish.Service
Starfish.Service --> Starfish.Transit
Starfish.Service --> Starfish.Common
Starfish.Client --> Starfish.Common
Starfish.Webapp --> Starfish.Client
Starfish.Webapp --> Starfish.Common
Starfish.Webapp --> Starfish.Transit
```
## Requirements/环境要求
### Development/开发环境
IDE/开发环境
- Windows/Linux/MacOS
- Visual Studio/Visual Studio Code/Rider. Visual Studio for Mac is retired, so it's not recommended./Visual Studio for Mac 已经被微软弃用，所以不推荐使用。
- .NET 8 SDK.
Dependencies/依赖服务
- Redis 6 and above. It's required for distributed cache and distributed lock. / 如果您需要使用分布式缓存和分布式锁，那么Redis是必须的。
- MySQL/SQL Server/PostgreSQL/MongoDB, latest version recommended. The database service is used to store configuration data. Choose one that you are about to use for production. / 数据库服务用于存储配置数据。请选择您将要在生产环境中使用的数据库。
- RabbitMQ
Deploy & Run/部署与运行
- Docker & Docker Compose
### Production/生产环境
Runtime/运行环境
- Windows/Linux, CentOS/Ubuntu recommended.
- .NET 8 Runtime. It's not needed if running in container./如果您在容器中运行，那么您不需要安装.NET 8 Runtime。
Dependencies/依赖服务
- Redis 6 and above. It's required for distributed cache and distributed lock. / 如果您需要使用分布式缓存和分布式锁，那么Redis是必须的。
- MySQL/SQL Server/PostgreSQL/MongoDB, latest version recommended. The database service is used to store configuration data. Choose one that you are about to use for production. / 数据库服务用于存储配置数据。请选择您将要在生产环境中使用的数据库。
- RabbitMQ
Deploy & Run/部署与运行
- Docker & Docker Compose. As you can see, we recommend you to run Starfish in container. / 如您所见，我们建议您在容器中运行Starfish。
## Server/服务端
### Deploy/部署
```bash
```
### Configuration/配置
```json
{
"ConnectionStrings": {
"Default": ""
},
"DatabaseType": "",
"JwtBearerOptions": {
"Scheme": "Bearer",
"RequireHttpsMetadata": false,
"ApiName": "starfish_api",
"AuthorityUrl": "http://localhost:5229",
"TokenIssuer": "localhost",
"TokenKey": "NEROSOFT-STARFISH-WEBAPI"
},
"CorsOrigins": [
"https://localhost"
],
"ServiceBus": {
"Provider": "inmemory",
"InMemory": {
"MultipleSubscriberInstance": false
}
},
"InitializeUser": {
"UserName": "admin",
"Password": "Starfish.8888"
},
"ReservedUsernames": [
"starfish",
"admin",
"administrator",
"root"
],
"FeatureManagement": {
"UserRegistration": true
},
"Logging": {
"LogLevel": {
"Default": "Information",
"Microsoft.AspNetCore": "Warning"
}
},
"AllowedHosts": "*"
}
```
|Key|Description|Type|Options|
|---|---|---|---|
|ConnectionStrings|Database connection string|Object|N/A|
| - Default|Default database connection string|String|N/A|
|DatabaseType|Database type|String|mysql/sqlite/sqlserver/mongo/postgresql|
|JwtBearerOptions|JWT Bearer options|Object|N/A|
| - Scheme|Scheme|String|Bearer|
| - RequireHttpsMetadata|Require HTTPS metadata|Boolean|true/false|
| - ApiName|API name|String|starfish_api|
| - AuthorityUrl|Authority URL|String|http://localhost:5229|
| - TokenIssuer|Token issuer|String|localhost|
| - TokenKey||String|N/A|
|CorsOrigins|CORS origins|String array|N/A|
|ServiceBus|Service bus options|Object|N/A|
| - Provider|Message transport provider|String|inmemory/rabbitmq|
| - InMemory|InMemory options|Object|N/A|
| - - MultipleSubscriberInstance|N/A|Boolean|true/false|
|InitializeUser|Options to initialize user|Object|N/A|
| - UserName|Username|String|N/A|
| - Password|Password|String|N/A|
|ReservedUsernames|Reserved usernames|String array|N/A|
|FeatureManagement|Feature management|Object|N/A|
| - UserRegistration|A value indicate whether user registration is enabled or not|Boolean|true/false|
## Client/客户端
### Install/安装
```bash
dotnet add package Starfish.Client
```
or
```powershell
Install-Package Starfish.Client
```
or
```xml
```
### Configuration/配置
1. Add Starfish as a configuration source in Program.cs/在 Program.cs 中添加 Starfish 作为配置源
```csharp
// .NET 5
public static IHostBuilder CreateHostBuilder(string[] args) =>
Host.CreateDefaultBuilder(args)
.ConfigureAppConfiguration((hostingContext, config) =>
{
config.AddStarfish(ConfigurationClientOptions.Load(config));
})
.ConfigureWebHostDefaults(webBuilder =>
{
webBuilder.UseStartup();
});
```
```csharp
// .NET 6 and above
var builder = WebApplication.CreateBuilder(args);
builder.Configuration.AddStarfish(ConfigurationClientOptions.Load(builder.Configuration));
// ...
var app = builder.Build();
// ...
app.Run();
```
2. Add configuration in appsettings.json/在 appsettings.json 中添加配置
```json
{
"Starfish": {
"Host": "http://localhost:5000",
"Id": "5lNc9zQGdG7",
"Secret": "123456"
}
}
```
# Documentation/文档 ⚡
## API
See the Swagger UI at [http://localhost:5229/swagger](http://localhost:5229/swagger) after running the server.
## Scripts/脚本
- MySQL: [SCRIPTS_MYSQL.md](Documents/SCRIPTS_MYSQL.md)
- SQL Server: [SCRIPTS_MSSQL.md](Documents/SCRIPTS_MSSQL.md)
- PostgreSQL: [SCRIPTS_PGSQL.md](Documents/SCRIPTS_PGSQL.md)
- Sqlite: [SCRIPTS_SQLITE.md](Documents/SCRIPTS_SQLITE.md)
- ~~Mongo: *not needed. / 不需要*~~
## Resources/资源
## Release Notes/发布日志
## FAQ/常见问题
# Roadmap/路线图 ⚡
## v1.0
- Basic configuration management/基础配置管理
- Web API
- Basic admin panel/基础管理面板
- Configuration client/配置客户端
- WebSockets protocol support of Client. / 客户端支持WebSockets协议。
## v1.1
- gRPC protocol support of Client. / 客户端支持gRPC协议。
- Rollback to history version. / 回滚到历史版本。
- Role-based access control. / 基于角色的访问控制。
## v1.2
- Docker support. / 支持Docker部署。
- MongoDB support. / 支持MongoDB。
- User registration. / 用户注册。
- Yaml support. / 支持Yaml。
## v1.3
- Multiple node deployment. / 支持多节点部署。
- Common configuration. / 公共配置。
- Real-time connections refreshing. / 实时连接信息刷新。
## v2.0
- Service discovery. / 服务发现。
## v3.0
- Service insights. / 服务监控。
- Service tracing. / 服务追踪。
- Log management. / 日志管理。
# Contributing/贡献 ⚡
# Acknowledgements/鸣谢 ⚡
[](https://www.jetbrains.com/)
Thanks to JetBrains for supporting the project through All Products Packs within their Free Open Source License program.
感谢JetBrains通过其免费开源许可计划中的所有产品包支持该项目。