NuGet · #701 most downloaded on NuGet

Yarp.ReverseProxy

2.3.081M downloads/modotnet/yarp ↗New releases in your daily digest, changelog included.

Reverse proxy toolkit for building fast proxy servers in .NET using the infrastructure from ASP.NET and .NET

Last release 2 years ago
no release in 18 months
Ships fairly regularly
a new release about every 5 months
Most releases are documented
notes for 7 of 10 stable releases
Nothing withdrawn
no release was ever pulled
5 years old
10 releases · first in 2021

Release timeline

10 releases since 2021

202120222023202420252026

20212026

One column per quarter.

Releases

2.3.027 Feb 2025
This release supports .NET 8.0 and newer. See Getting Started . Note that while this version also includes targets for .NET 6 and .NET 7, those runtim
This release supports .NET 8.0 and newer. See Getting Started.
Note that while this version also includes targets for .NET 6 and .NET 7, those runtimes are no longer supported.

The Yarp.ReverseProxy packages are available on NuGet.org.

Breaking changes

More errors triggered by the client disconnecting are now logged under a Debug severity (#2765 by @MihaZupan).

ForwarderError.ResponseBodyCanceled and UpgradeResponseCanceled are no longer logged with a Warning severity.

This is a continuation of a change we've made in 2.2 where we've done the same with RequestCanceled, RequestBodyCanceled, and UpgradeRequestCanceled.

Replacing the HttpRequestMessage.Content property in a request transform will throw an exception (#2722 by @MihaZupan).

While setting the property may have appeared to work during limited testing, it could lead to various issues as YARP internally relies on the property remaining unchanged. See the pull request for more context on this change.

We now always enforce the HttpVersionPolicy during HTTP version negotiation (#2729 by @MihaZupan).

It was previously possible for YARP to initiate HTTP/1.1 connections for WebSocket and SPDY requests even if the specified HttpVersionPolicy disallowed it. This was breaking scenarios such as outgoing HTTP/2 WebSockets without TLS.

If the policy disallows the use of outbound HTTP/1.1, SPDY requests will not be proxied and will instead return a RequestCreation error.

This does not affect the default YARP configuration, which is Version=2.0, Policy=RequestVersionOrLower.

Major changes

YARP has always logically been a part of .NET and we have now moved the repository from the microsoft to the dotnet organization.

The license has been updated to the .NET foundation, but remains MIT as before (#2738 by @adityamandaleeka).

As part of the repository move, we have moved the documentation to learn.microsoft.com.

We've created a JSON schema for YARP configuration! Editing now comes with validation and autocompletions (#2758 by @MihaZupan).

The change is automatic when referencing the 2.3.0 version of the YARP package and editing the ReverseProxy section in appsettings.json.

If you encounter any issues with the schema, please let us know by opening an issue.

False positives can be safely ignored until we're able to update the schema. Runtime interpretation of the configuration remains unchanged and is unaffected by schema validation.

You can manually reference the latest version of the schema without changing the package by pointing Visual Studio at https://raw.githubusercontent.com/dotnet/yarp/refs/heads/main/src/ReverseProxy/ConfigurationSchema.json.

We've started shipping a minimal YARP container image at mcr.microsoft.com (#2710 by @benjaminpetit).

More functionality will be added to the image over time.

Other changes

We've added optional parameters to AddForwarded and AddXForwarded request transforms that allow you to opt-out of removing the other variant of the header (#2728 by @rkargMsft).
ctx.AddForwarded(removeAllXForwardedHeaders: false); ctx.AddXForwarded(removeForwardedHeader: false);

Improved HttpSysDelegator logging and retry logic (#2671 by @NGloreous).

YARP can now be published with NativeAOT when targetting .NET 8.0 again (#2759 by @MihaZupan).

We've added a workaround for an error in .NET builds from the Ubuntu package feed (#2673 by @MihaZupan).

See dotnet/aspnetcore#59166 for more information.

New Contributors

@xtqqczze made their first contribution in #2748

For a full list of changes see here.

2.2.03 Sept 2024Breaking

There are no breaking changes between YARP 2.2.0-preview.1 and 2.2.0.

This release supports .NET 6.0 and .NET 8.0. See Getting Started.

The Yarp.ReverseProxy packages are available on NuGet.org.

Breaking changes

There are no breaking changes between YARP 2.2.0-preview.1 and 2.2.0.
See 2.2.0-preview.1 release notes for the list of breaking changes between YARP 2.1 and 2.2.

Other changes

The Forwarded transform now prefers the IPv4 form for dual-mode sockets (#2509 by @rkargMsft).
- E.g. 127.0.0.1 is used instead of ::ffff:127.0.0.1.
- A similar change was already made for X-Forwarded-For in 2.2.0-preview.1 (#2400).
Added a missing WebSocketCloseReason.ActivityTimeout enum value (#2571 by @MihaZupan).
Added a TlsFrameHelper.ParsingStatus API (#2587 by @wfurt).
- This information can be used to distinguish between Invalid and Incomplete frames.
Removed one async state machine allocation when forwarding a request (#2586 by @MihaZupan).
Several documentation improvements.

New Contributors

@rkargMsft made their first contribution in #2509
@nigma143 made their first contribution in #2535
@mroberts91 made their first contribution in #2530
@t0mll made their first contribution in #2547
@fnuttens made their first contribution in #2558

For a full list of changes see here.

Open source →

Additional notes

2.2.0

Compare

Choose a tag to compare

Open source →

2.1.017 Nov 2023Breaking

There are no breaking changes between YARP 2.1.0-preview.1 and 2.1.0.

This release supports .NET 6.0, 7.0, and 8.0. See Getting Started.

The Yarp.ReverseProxy packages are available on NuGet.org.

Breaking changes

There are no breaking changes between YARP 2.1.0-preview.1 and 2.1.0.
See 2.1.0-preview.1 release notes for the list of breaking changes between YARP 2.0 and 2.1.

Other changes

Set IsPackable to true for the k8s project on non rtw builds by @benjaminpetit in #2286
Conditionally copy Strict-Transport-Security by @Tratcher in #2306
fix: typo in prometheus sample metrics by @asafdl in #2309
Add NuGet feed to get daily builds of Yarp.Kubernetes.Controller package. by @benjaminpetit in #2312
[main] Update dependencies from dotnet/arcade by @dotnet-maestro in #2318
Update config-files.md by @YehudaKremer in #2319
Make RequestTransformContext.DestinationPrefix read-write by @benjaminpetit in #2311
failing tests for rate limiter policy validation when 'default' or 'disable' used by @jakebanks in #2283
Update dependencies to rtw by @benjaminpetit in #2326
chore: fix prometheus sample metric typos in description by @asafdl in #2308
Timeout integration by @Tratcher in #2307
Clarify websocket activity failure by @Tratcher in #2325
Minimal APIs for docs and samples by @Tratcher in #2327

New Contributors

@asafdl made their first contribution in #2309
@YehudaKremer made their first contribution in #2319
@jakebanks made their first contribution in #2283

Full Changelog: v2.1.0-preview.1...v2.1.0

Open source →

Additional notes

2.1.0

Compare

Choose a tag to compare

Open source →

2.0.013 Feb 2023Breaking

See 2.0.0-RC.1 release notes for the rest of the breaking changes between YARP 1.1 and 2.0.

This release supports .NET 6.0 and .NET 7.0. See Getting Started.

The Yarp.ReverseProxy packages are available on NuGet.org.

Breaking changes

Existing HttpTransformer overloads that don't accept a CancellationToken have been marked as obsolete (#2016).
- If you have created a custom class that derives from HttpTransformer, you should update the implementation to override the overloads which accept the CancellationToken instead.
- Existing implementations that only override the obsolete overloads will continue working for the time being, but these overloads may be removed in a future major release.
See 2.0.0-RC.1 release notes for the rest of the breaking changes between YARP 1.1 and 2.0.

Other changes

Added a new enum value ForwarderError.RequestCreation that is reported if a request transform throws an exception (#2016).
Fixed a bug introduced in RC1 where custom response transform callbacks were not called on errors (when ProxyResponse is null) (#2016).
Fixed a bug where a request cancellation triggered by the manual CancellationToken (parameter to IHttpForwarder.SendAsync) was reported as RequestTimedOut instead of RequestCanceled (#2016).

For a full list of changes see here.

Open source →

Additional notes

2.0.0

Compare

Choose a tag to compare

Open source →

Yarp.ReverseProxy

Release timeline

Releases

Breaking changes

Major changes

Other changes

New Contributors

Choose a tag to compare

Breaking changes

Other changes

New Contributors

Choose a tag to compare

Breaking changes

Other changes

New Contributors

Choose a tag to compare

Choose a tag to compare

Breaking changes

Other changes

Choose a tag to compare

Choose a tag to compare

Choose a tag to compare