Add documentation for geoip2_proxy commands

Fixes #60
This commit is contained in:
Lee 2020-12-01 17:48:13 -06:00 committed by GitHub
parent 1cabd8a1f6
commit 1f216031a9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -128,3 +128,18 @@ This translates to:
``` ```
$country_name "default=United States" source=$remote_addr country names en $country_name "default=United States" source=$remote_addr country names en
``` ```
##### Additional Commands:
These commands works the same as the original ngx_http_geoip_module documented here: http://nginx.org/en/docs/http/ngx_http_geoip_module.html#geoip_proxy.
However, if you provide the `source=$variable_with_ip` option on a variable, these settings will be ignored for that particular variable.
```
geoip2_proxy < cidr >
```
Defines trusted addresses. When a request comes from a trusted address, an address from the "X-Forwarded-For" request header field will be used instead.
```
geoip2_proxy_recursive < on | off >
```
If recursive search is disabled then instead of the original client address that matches one of the trusted addresses, the last address sent in "X-Forwarded-For" will be used. If recursive search is enabled then instead of the original client address that matches one of the trusted addresses, the last non-trusted address sent in "X-Forwarded-For" will be used.