Skip to content

Latest commit

 

History

History
345 lines (260 loc) · 10.4 KB

README.md

File metadata and controls

345 lines (260 loc) · 10.4 KB

Overview/概览 ⚡

Build Status License GitHub release GitHub stars

Starfish is a lightweight powerful distributed configuration server for .NET application.

Starfish是一个轻量但功能强大的分布式 .NET 应用程序配置中心。

⌨️ Features/功能

💚 Completed/已完成 ⌛ In progress/进行中 🕝 Planned/计划中

  • ⌛ Support multiple data sources/支持多种数据源
    • 💚 MySQL
    • 💚 SqlServer
    • 💚 PostgreSQL
    • 🕝 MongoDB
    • 💚 Sqlite
  • 💚 Support multiple platforms/支持多种平台
    • 💚 Web API/Web Application/gRPC Service in .NET6/7/8
    • 💚 .NET MAUI
    • 💚 WPF application
  • 🕝 Support multiple node deployment/支持多节点部署
  • 💚 Support multiple environments/支持多环境
  • ⌛ Deploy with docker/支持Docker部署
  • 💚 Support client cache/支持客户端缓存
  • ⌛ Multiple protocols support/支持多种协议
    • 💚 HTTP
    • 🕝 gRPC
    • 💚 WebSocket
  • 💚 Sync configuration to Redis server. / 同步配置到Redis服务器。
  • 🕝 Rollback to history version/回滚到历史版本
  • 🕝 Role-based access control/基于角色的访问控制
  • 💚 Support multiple languages admin panel/支持多语言管理面板
    • 💚 en/英语
    • 💚 zh-Hans/简体中文
    • 💚 zh-Hant/繁体中文

💰 Donate/捐助

Paypal

Donate

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,或通过邮件联系我们,谢谢。

zhaorong@outlook.com

🔑 License/许可证

This project is licensed under the AGPL-3.0 License - see the LICENSE file for details.

本项目采用 AGPL-3.0 协议,可查看 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/依赖关系结构

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
Loading

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/部署

Configuration/配置

{
    "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/安装

dotnet add package Starfish.Client

or

Install-Package Starfish.Client

or

<PackageReference Include="Starfish.Client" Version="1.0.0" />

Configuration/配置

  1. Add Starfish as a configuration source in Program.cs/在 Program.cs 中添加 Starfish 作为配置源
// .NET 5
public static IHostBuilder CreateHostBuilder(string[] args) =>
    Host.CreateDefaultBuilder(args)
        .ConfigureAppConfiguration((hostingContext, config) =>
        {
            config.AddStarfish(ConfigurationClientOptions.Load(config));
        })
        .ConfigureWebHostDefaults(webBuilder =>
        {
            webBuilder.UseStartup<Startup>();
        });
// .NET 6 and above
var builder = WebApplication.CreateBuilder(args);
builder.Configuration.AddStarfish(ConfigurationClientOptions.Load(builder.Configuration));
// ...
var app = builder.Build();
// ...
app.Run();
  1. Add configuration in appsettings.json/在 appsettings.json 中添加配置
{
    "Starfish": {
        "Host": "http://localhost:5000",
        "Id": "5lNc9zQGdG7",
        "Secret": "123456"
    }
}

Documentation/文档 ⚡

API

See the Swagger UI at http://localhost:5229/swagger after running the server.

Scripts/脚本

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/鸣谢 ⚡

JetBrains

Thanks to JetBrains for supporting the project through All Products Packs within their Free Open Source License program.

感谢JetBrains通过其免费开源许可计划中的所有产品包支持该项目。