Skip to content

docs(aisix): document PROXY protocol support on trusted_proxies #416

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

Closed
jarvis9443 wants to merge 1 commit into from
Closed

docs(aisix): document PROXY protocol support on trusted_proxies #416

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion charts/aisix/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -569,7 +569,7 @@ rejects. New installs set the value in its own key in `values.yaml` or under
| config.outbound.ssrf_protection.enabled | bool | `true` | Only reach publicly routable addresses when fetching a URL an API caller supplied (today the media download). false turns the check off and ignores `allowed_hosts` |
| config.proxy.real_ip.header | string | `"x-forwarded-for"` | Header carrying the client IP |
| config.proxy.real_ip.recursive | bool | `false` | Walk the header right to left past every trusted proxy |
| config.proxy.real_ip.trusted_proxies | list | `[]` | CIDRs (or bare IPs) of proxies trusted to set the client-IP header |
| config.proxy.real_ip.trusted_proxies | list | `[]` | CIDRs (or bare IPs) of proxies trusted to set the client-IP header. A peer in this list may also open the connection with a PROXY protocol v1/v2 header (an L4 load balancer that rewrites the source address); the header's source address then stands in for the TCP peer, including for the client-IP header trust check. Detection is automatic on every proxy listener; a header from any other peer closes the connection |
| config.proxy.request_body_limit_bytes | int | `0` | Request-body size cap in bytes. 0 means no cap |
| config.proxy.request_id.accept_headers | list | `["x-aisix-request-id"]` | Headers a caller may supply its own request id in. Add `x-request-id` only when no proxy in front stamps it |
| config.proxy.thread_per_core | bool | `nil` | Thread-per-core serving topology. Null uses the gateway default (on for Linux) |
Expand Down
7 changes: 6 additions & 1 deletion charts/aisix/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,12 @@ config:
# -- Request-body size cap in bytes. 0 means no cap
request_body_limit_bytes: 0
real_ip:
# -- CIDRs (or bare IPs) of proxies trusted to set the client-IP header
# -- CIDRs (or bare IPs) of proxies trusted to set the client-IP header.
# A peer in this list may also open the connection with a PROXY protocol
# v1/v2 header (an L4 load balancer that rewrites the source address); the
# header's source address then stands in for the TCP peer, including for
# the client-IP header trust check. Detection is automatic on every proxy
# listener; a header from any other peer closes the connection
trusted_proxies: []
# -- Walk the header right to left past every trusted proxy
recursive: false
Expand Down
Loading