Starfish Download - Starfish Source code download

Starfish

Other categories

1.0.6

Download

Overview/Overview

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

Starfish is a lightweight but powerful distributed .NET application configuration center.

⌨ Features/Function

Completed/Completed⌛ In progress/Planned

Donate/Donate

Paypal

https://www.paypal.me/realzharong

If you like my work, you can support me by donation. / 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.

Wonderful to receive any feedback from you, you can create an issue, or contact us by email, thank you.

[email protected]

License/Limit

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

This project adopts the AGPL-3.0 protocol, you can view LICENSE for more details.

Getting Started/Start quickly

Solution structure/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/Dependency 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

Requirements/Environmental Requirements

Development/Development Environment

IDE/Development Environment

Windows/Linux/MacOS
Visual Studio/Visual Studio Code/Rider. Visual Studio for Mac is retired, so it's not recommended./Visual Studio for Mac has been deprecated by Microsoft, so it's not recommended.
.NET 8 SDK.

Dependencies/Dependencies

Redis 6 and above. It's required for distributed cache and distributed lock. / Redis is a must.
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. / The database service is used to store configuration data. Please select the database you will use in a production environment.
RabbitMQ

Deploy & Run/Deploy & Run

Docker & Docker Compose

Production/production environment

Runtime/runtime environment

Windows/Linux, CentOS/Ubuntu recommended.
.NET 8 Runtime. It's not needed if running in container./ If you run in a container, you don't need to install .NET 8 Runtime.

Dependencies/Dependencies

Redis 6 and above. It's required for distributed cache and distributed lock. / Redis is a must.
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. / The database service is used to store configuration data. Please select the database you will use in a production environment.
RabbitMQ

Deploy & Run/Deploy & Run

Docker & Docker Compose. As you can see, we recommend you to run Starfish in container. / As you can see, we recommend you to run Starfish in container.

Server/Server

Deploy/Deployment

Configuration/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	income/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 indicates whether user registration is enabled or not	Boolean	true/false

Client/Client

Install/install

dotnet add package Starfish.Client

or

 Install-Package Starfish.Client

or

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

Configuration/Configuration

Add Starfish as a configuration source in Program.cs/Add Starfish as a configuration source in Program.cs

 // .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 ( ) ;

Add configuration in appsettings.json/Add configuration in appsettings.json

{
    "Starfish" : {
        "Host" : " http://localhost:5000 " ,
        "Id" : " 5lNc9zQGdG7 " ,
        "Secret" : " 123456 "
    }
}

Documentation/Documentation

API

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

Scripts/Scripts

MySQL: SCRIPTS_MYSQL.md
SQL Server: SCRIPTS_MSSQL.md
PostgreSQL: SCRIPTS_PGSQL.md
Sqlite: SCRIPTS_SQLITE.md
Mongo: not needed. / Not required

Resources/Resources

Release Notes/Publish Log

FAQ/FAQ

Roadmap/Roadmap

v1.0

Basic configuration management/basic configuration management
Web API
Basic admin panel/Basic management panel
Configuration client/Configure client
WebSockets protocol support of Client. / The client supports the WebSockets protocol.

v1.1

gRPC protocol support of Client. / The client supports the gRPC protocol.
Rollback to history version. / Rollback to history version.
Role-based access control. / Role-based access control.

v1.2

Docker support. / Supports Docker deployment.
MongoDB support. / supports MongoDB.
User registration. / User registration.
Yaml support. / Support Yaml.

v1.3

Multiple node deployment. / Supports multi-node deployment.
Common configuration. / Public configuration.
Real-time connections refreshing. / Real-time connection information refreshing.