From b7e4a7a5fce70d9fc2a2634d885bb77f64739f62 Mon Sep 17 00:00:00 2001 From: Yin Guanhao Date: Wed, 25 Oct 2023 13:52:57 +0800 Subject: [PATCH] chore: update readme --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1908219..53220f9 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,19 @@ A reverse proxy / load balancer for axon. - HTTP and WebSocket. Subscription is supported on WebSocket connections. - P2C least requests or client ip consistent hashing load balancing. - Filter id sticky load balancing. + + E.g. an `eth_getFilterChanges` request will be forwarded to the node that creates the filter. + - Health check and failover. -- Per-ip (and per-ip-per-method) rate limiting with redis. -- Caching with redis. +- Per-ip (and per-ip-per-method) JSONRPC rate limiting with redis. +- JSONRPC caching with redis. - High availability: running multiple instances of this proxy is supported. - Metrics. +# Not Planned + +Features like https, http/2, http/3 or more complicated CORS configurations. These should be supported by a dedicated http proxy in front of axon-proxy if necessary. + # Building Install rust and