Skip to content

Update YARP NuGet references in Getting Started #34868

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
guardrex merged 3 commits into from
Mar 3, 2025
Merged

Update YARP NuGet references in Getting Started #34868

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
97e9815
Update YARP NuGet references in Getting Started
MihaZupan Mar 3, 2025
c1046b2
Quick edit
guardrex Mar 3, 2025
e9d2c82
Updates
guardrex Mar 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 25 additions & 23 deletions aspnetcore/fundamentals/servers/yarp/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,43 +12,43 @@ ai-usage: ai-assisted

# Getting Started with YARP

YARP is designed as a library that provides the core proxy functionality which you can then customize by adding or replacing modules.
YARP is currently provided as a NuGet package and code snippets.
We plan on providing a project template and pre-built exe in the future.
YARP is designed as a library that provides the core proxy functionality which you can then customize by adding or replacing modules. YARP is currently provided as a NuGet package and code snippets. We plan on providing a project template and prebuilt executable (`.exe`) in the future.

YARP is implemented on top of .NET Core infrastructure and is usable on Windows, Linux or MacOS.
Development can be done with the SDK and your favorite editor, [Microsoft Visual Studio](https://visualstudio.microsoft.com/vs/) or [Visual Studio Code](https://code.visualstudio.com/).
YARP is implemented on top of .NET Core infrastructure and is usable on Windows, Linux or MacOS. Development can be done with the SDK and your favorite editor, [Microsoft Visual Studio](https://visualstudio.microsoft.com/vs/) or [Visual Studio Code](https://code.visualstudio.com/).

YARP 2.3.0 supports ASP.NET Core 8.0 and newer.

YARP 2.1.0 supports ASP.NET Core 6.0 and newer, including ASP.NET Core 8.0.
You can download the .NET SDK from https://dotnet.microsoft.com/download/dotnet/.

Visual Studio support for .NET 8 is included in Visual Studio 2022 17.8.

### Create a new project
## Create a new project

A complete version of the project built using the steps below can be found at [Basic YARP Sample](https://github.com/microsoft/reverse-proxy/tree/release/latest/samples/BasicYarpSample).

Start by creating an "Empty" ASP.NET Core application using the command line:

```Console
```dotnetcli
dotnet new web -n MyProxy -f net8.0
```

Or create a new ASP.NET Core web application in Visual Studio 2022, and choose "Empty" for the project template.
Alternatively, create a new ASP.NET Core web application in Visual Studio 2022, choosing "Empty" for the project template.

## Add the package reference

### Add the project reference
Add a package reference for [`Yarp.ReverseProxy`](https://www.nuget.org/packages/Yarp.ReverseProxy), version 2.3.0 or later.

```XML
<ItemGroup>
<PackageReference Include="Yarp.ReverseProxy" Version="2.1.0" />
</ItemGroup>
```dotnetcli
dotnet add package Yarp.ReverseProxy
```

### Add the YARP Middleware
[!INCLUDE[](~/includes/package-reference.md)]

Update Program.cs to use the YARP middleware:
## Add the YARP Middleware

```C#
Update the `Program` file to use the YARP Middleware:

```csharp
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddReverseProxy()
.LoadFromConfig(builder.Configuration.GetSection("ReverseProxy"));
Expand All @@ -59,13 +59,13 @@ app.Run();

## Configuration

The configuration for YARP is defined in the appsettings.json file. See [Configuration Files](xref:fundamentals/servers/yarp/config-files) for details.
The configuration for YARP is defined in the `appsettings.json` file. For more information, see <xref:fundamentals/servers/yarp/config-files>.

The configuration can also be provided programmatically. See [Configuration Providers](xref:fundamentals/servers/yarp/config-providers) for details.
The configuration can also be provided programmatically. For more information, see <xref:fundamentals/servers/yarp/config-providers>.

You can find out more about the available configuration options by looking at [RouteConfig](xref:Yarp.ReverseProxy.Configuration.RouteConfig) and [ClusterConfig](xref:Yarp.ReverseProxy.Configuration.ClusterConfig).
Learn more about the available configuration options by looking at <xref:Yarp.ReverseProxy.Configuration.RouteConfig> and <xref:Yarp.ReverseProxy.Configuration.ClusterConfig>.

```JSON
```json
{
"Logging": {
"LogLevel": {
Expand Down Expand Up @@ -97,6 +97,8 @@ You can find out more about the available configuration options by looking at [R
}
```

### Running the project
## Run the project

When using the .NET CLU, use `dotnet run` called within the sample's directory or `dotnet run --project <path to .csproj file>`.

Use `dotnet run` called within the sample's directory or `dotnet run --project <path to .csproj file>`
In Visual Studio, start the app with the **Run** button.