Lgd.Yarp.Studio
1.0.1
dotnet add package Lgd.Yarp.Studio --version 1.0.1
NuGet\Install-Package Lgd.Yarp.Studio -Version 1.0.1
<PackageReference Include="Lgd.Yarp.Studio" Version="1.0.1" />
<PackageVersion Include="Lgd.Yarp.Studio" Version="1.0.1" />
<PackageReference Include="Lgd.Yarp.Studio" />
paket add Lgd.Yarp.Studio --version 1.0.1
#r "nuget: Lgd.Yarp.Studio, 1.0.1"
#:package Lgd.Yarp.Studio@1.0.1
#addin nuget:?package=Lgd.Yarp.Studio&version=1.0.1
#tool nuget:?package=Lgd.Yarp.Studio&version=1.0.1
YARP Studio
A modern, visual administrative dashboard and designer for YARP (Yet Another Reverse Proxy). YARP Studio allows developers and administrators to manage reverse proxy configurations (routes, clusters, destinations) dynamically through a web interface, persisting changes to a lightweight embedded database with zero-downtime hot-reloads.
โจ Features
- ๐ Live Topology Visualizer: Trace traffic flow from public routes through authentication, CORS, and transforms to target clusters.
- ๐ฃ๏ธ Route Builder & Editor: Define routing matchers (paths, methods, host headers), configure policies, and add path/header transforms.
- ๐ฅ๏ธ Cluster & Destination Manager: Configure load-balancing, active/passive health checks, and manage backend destination addresses.
- ๐งช Routing Playground: Test and dry-run HTTP requests to verify routing matches and transformations.
- โก Hot-Reload Integration: Save configuration updates instantly into the running gateway without restarting the application.
๐ Getting Started
1. Installation
Install the NuGet package to your ASP.NET Core gateway host project:
dotnet add package Lgd.Yarp.Studio
2. Configure Services & Middleware
Register YARP Studio in your Program.cs file:
using Lgd.Yarp.Studio.Extensions;
var builder = WebApplication.CreateBuilder(args);
// Add YARP and integrate Lgd.Yarp.Studio configuration provider
builder.Services.AddReverseProxy()
.AddYarpStudio();
var app = builder.Build();
app.UseHttpsRedirection();
// Map visual designer dashboard REST APIs and UI files
// By default, the UI is served at `/yarp-designer`
app.UseYarpVisualDashboard();
// Map active proxy routes
app.MapReverseProxy();
app.Run();
3. Run the Dashboard
Start your gateway application and navigate to http://localhost:<port>/yarp-designer in your browser. The application will automatically initialize the database yarp-studio.db in your runtime directory.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
-
net10.0
- LiteDB (>= 5.0.21)
- Microsoft.AspNetCore.SpaServices.Extensions (>= 10.0.8)
- Yarp.ReverseProxy (>= 2.3.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.