Added number of hops to function example for "behind-proxies" page #1434
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
`proxy-addr` not only passes the ip but also the index of the hop to the callback. This could be noted in the documentation, as it's useful for private servers behind a public load balancer which, in theory, is accessible to the public internet but should be proxied by a CDN. In this example the first hop can always be trusted (LoadBalancer -> API) but the second hop would depend on the IP of the incoming request (either CDN -> LB or internet -> LB).
crandmck
added
the
needs tech review
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
proxy-addrnot only passes the ip but also the index of the hop to the callback. This could be noted in the documentation, as it's useful for private servers behind a public load balancer which, in theory, is accessible to the public internet but should be proxied by a CDN. In this example the first hop can always be trusted (LoadBalancer -> API) but the second hop would depend on the IP of the incoming request (eitherCDN -> LBorinternet -> LB).I'm aware that in general network access to the LoadBalancer should be restricted for these cases, however that might not always be feasible short-term +
proxy-addrsupports this so it might as well be mentioned in the examples 👍