dotnet /yarp
A toolkit for developing high-performance HTTP reverse proxy applications.
★ 9,656⑂ 936👁 259⑃ 1,457● 1,171▤ 29
+1
Daily
9,656
stars
936
forks
259
watchers
1,457
prs
1,171
issues
29
releases
README
!YARP Icon
Welcome to the YARP project
YARP (which stands for "Yet Another Reverse Proxy") is a project to create a reverse proxy server. We found a bunch of internal teams at Microsoft who were either building a reverse proxy for their service or had been asking about APIs and tech for building one, so we decided to get them all together to work on a common solution, this project.
YARP is a reverse proxy toolkit for building fast proxy servers in .NET using the infrastructure from ASP.NET and .NET. The key differentiator for YARP is that it's been designed to be easily customized and tweaked to match the specific needs of each deployment scenario.
We expect YARP to ship as a library and project template that together provide a robust, performant proxy server. Its pipeline and modules are designed so that you can then customize the functionality for your needs. For example, while YARP supports configuration files, we expect that many users will want to manage the configuration programmatically based on their own backend configuration management system, YARP will provide a configuration API to enable that customization in-proc. YARP is designed with customizability as a primary scenario, rather than requiring you to break out to script or having to rebuild from source.
Getting started
- See our Getting Started docs.
- Try our previews.
- Try our latest daily build.
- See our support policy.
Updates
For regular updates, see our releases page. Subscribe to release notifications on this repository to be notified of future updates (Watch - Custom - Releases).
If you want to live on the bleeding edge, you can pickup the daily builds.
Build
To build the repo, you should only need to run build.cmd (on Windows) or build.sh (on Linux or macOS). The script will download the .NET SDK and build the solution.
For VS on Windows, install the latest VS 2022 release and then run the startvs.cmd script to launch Visual Studio using the appropriate local copy of the .NET SDK.
To set up local development with Visual Studio, Visual Studio for Mac or Visual Studio Code, you need to put the local copy of the .NET SDK in your PATH environment variable. Our Restore script fetches the latest build of .NET and installs it to a .dotnet directory within this repository.
We provide some scripts to set all this up for you. Just follow these steps:
1. Run the restore.cmd/restore.sh script to fetch the required .NET SDK locally (to the .dotnet directory within this repo)
1. "Dot-source" the activate script to put the local .NET SDK on the PATH
1. For PowerShell, run: . .\activate.ps1 (note the leading . , it is required!)
1. For Linux/macOS/WSL, run: . ./activate.sh
1. For CMD, there is no supported script. You can manually add the .dotnet directory within this repo to your PATH. Ensure where dotnet shows a path within this repository!
1. Launch VS, VS for Mac, or VS Code!
When you're done, you can run the deactivate function to undo the changes tTop issues
#1618Tunneling with YARP37 comments · 2022-03-24#1789How to add Swagger for Gateway?33 comments · 2022-07-01#56Retry of "Safe" HTTP requests33 comments · 2020-04-15#2427YARP has a higher cpu usage than Nginx28 comments · 2024-03-04#1158Proxy SignalR -- document how25 comments · 2021-07-20#2721"Stream was already consumed" exception thrown even with enabled buffering.18 comments · 2025-01-22#247Proxy is supplied as a pre-built docker image18 comments · 2020-06-16#120Are you planning a disk-backed cache?17 comments · 2020-04-28
Discussions
#3046Yarp behind Traefik - [Cache-Control] header overriden1 comments · 2026-07-27#3034YARPad - a browser-based admin UI for YARP0 comments · 2026-05-29#2977OperationCanceledException1 comments · 2025-11-21#2974Use YARP to intercept all outbound requests of an app for testing purposes1 comments · 2025-11-16#2968YARP returns 502 without waiting for a response when upstream closes the stream without reading to end.1 comments · 2025-10-24#2966YARP Redis OutputCaching is not working.1 comments · 2025-10-16#2965How to Forward User Claims to DownStream-Apis ?1 comments · 2025-10-15#2957Yarp Windows Container1 comments · 2025-09-25
Latest release
2.3.0 v2.3.0 2025-02-27This 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, Re