Welcome to the YARP project
YARP (which stands for "YARP: A 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.
For the latest status updates, see our Status Report thread. Subscribe to notifications on that issue and we'll comment regularly with status updates.
To build the repo, you should only need to run
build.cmd (on Windows) or
Linux or macOS). The script will download the .NET SDK and build
For VS on Windows, you can run the
script to launch Visual Studio on Windows 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 5 and
installs it to a
.dotnet directory within
We provide some scripts to set all this up for you. Just follow these steps:
- Run the
restore.shscript to fetch the required .NET SDK locally (to the
.dotnetdirectory within this repo)
- "Dot-source" the
activatescript to put the local .NET SDK on the PATH
- For PowerShell, run:
. .\activate.ps1(note the leading
., it is required!)
- For Linux/macOS/WSL, run:
- For CMD, there is no supported script. You can manually add the
.dotnetdirectory within this repo to your
where dotnetshows a path within this repository!
- For PowerShell, run:
- Launch VS, VS for Mac, or VS Code!
When you're done, you can run the
function to undo the changes to your
If you're having trouble building the project, or developing in Visual Studio, please file an issue to let us know and we'll help out (and fix our scripts/tools as needed)!
Take a look at the sample apps, for some examples of how to use YARP. We'll be publishing more docs and tutorials as the project develops!
Reporting security issues and bugs
YARP is a preview project, and as such we expect all users to take responsibility for evaluating the security of their own applications.
Security issues and bugs should be reported privately, via
email, to the Microsoft Security Response Center (MSRC) at
[email protected]. You should receive a response
within 24 hours. If for some reason you do not, please follow up
via email to ensure we received your original message. Further
information, including the
MSRC PGP key, can be found at the Microsoft Security
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.