Question 1

Should I use ProxyKit or YARP for my new ASP.NET Core proxy?

Accepted Answer

For new projects, YARP is recommended as it's actively maintained by Microsoft and is the successor to ProxyKit. ProxyKit is obsolescent, so migration to YARP ensures long-term support and updates.

Question 2

How do I add custom headers when proxying requests with ProxyKit?

Accepted Answer

You can customize the upstream request by modifying the ForwardContext before sending. For example, use extension methods to add headers like X-Correlation-ID, as demonstrated in the README's customising section with ApplyCorrelationId.

Question 3

Can ProxyKit handle WebSocket connections effectively?

Accepted Answer

Yes, ProxyKit supports WebSocket proxying. You need to add UseWebSockets() in your pipeline and then use UseWebSocketProxy with the appropriate URI and options, such as adding X-Forwarded headers.

Question 4

Is ProxyKit suitable for use in Azure Functions or AWS Lambda?

Accepted Answer

While it can run in serverless environments, ProxyKit may buffer and encode messages, so it's best suited for API proxying in dev or quick setups. For production with large or binary payloads, consider alternatives due to performance constraints.

Question 5

How does ProxyKit compare to Ocelot for API gateways?

Accepted Answer

ProxyKit is stream-based and better for general reverse proxying with low overhead, while Ocelot is message-based and designed as an API gateway with more transformation features. They can be combined, but for heavy message manipulation, Ocelot might be more appropriate.

Question 6

What are the performance implications of using ProxyKit compared to nginx?

Accepted Answer

ProxyKit is fast for most use cases, leveraging ASP.NET Core's performance, but for absolute maximum throughput on Linux, dedicated proxies like nginx are faster. The README notes it's ~3x faster than nginx on Windows, but nginx has known performance issues on that platform.

ProxyKit

What is ProxyKit?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions