Skip to content

Commit

Permalink
Merge pull request #10 from axonweb3/update-readme
Browse files Browse the repository at this point in the history
chore: update readme
  • Loading branch information
blckngm authored Oct 26, 2023
2 parents ef90d77 + b7e4a7a commit 805a033
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 805a033

Please sign in to comment.