Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update readme #10

Merged
merged 1 commit into from
Oct 26, 2023
Merged

chore: update readme #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions README.md
View file
Open in desktop
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
Loading