aboutsummaryrefslogtreecommitdiff
path: root/docs/configuration/cheatsheet.md
diff options
context:
space:
mode:
authorlain <lain@soykaf.club>2020-10-12 15:03:08 +0200
committerlain <lain@soykaf.club>2020-10-12 15:03:08 +0200
commit346a59aee68d71af5d7ab6cfb9ff89008a032f2b (patch)
treea3b47a0fdba667cef77a6a65c5551d02c051ba08 /docs/configuration/cheatsheet.md
parentc13c924ccb877d91068982f3a0ca9690c948a29c (diff)
parentbc3cf0fee0b93eb3cf8d2ba0f9a0dcc09b01331d (diff)
downloadpleroma-346a59aee68d71af5d7ab6cfb9ff89008a032f2b.tar.gz
Merge branch 'develop' of git.pleroma.social:pleroma/pleroma into 2061-chat-deletion
Diffstat (limited to 'docs/configuration/cheatsheet.md')
-rw-r--r--docs/configuration/cheatsheet.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/configuration/cheatsheet.md b/docs/configuration/cheatsheet.md
index 42e5fe808..ea7dfec98 100644
--- a/docs/configuration/cheatsheet.md
+++ b/docs/configuration/cheatsheet.md
@@ -426,9 +426,9 @@ This will make Pleroma listen on `127.0.0.1` port `8080` and generate urls start
Available options:
* `enabled` - Enable/disable the plug. Defaults to `false`.
-* `headers` - A list of strings naming the `req_headers` to use when deriving the `remote_ip`. Order does not matter. Defaults to `["x-forwarded-for"]`.
-* `proxies` - A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Defaults to `[]`.
-* `reserved` - Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network).
+* `headers` - A list of strings naming the HTTP headers to use when deriving the true client IP address. Defaults to `["x-forwarded-for"]`.
+* `proxies` - A list of upstream proxy IP subnets in CIDR notation from which we will parse the content of `headers`. Defaults to `[]`. IPv4 entries without a bitmask will be assumed to be /32 and IPv6 /128.
+* `reserved` - A list of reserved IP subnets in CIDR notation which should be ignored if found in `headers`. Defaults to `["127.0.0.0/8", "::1/128", "fc00::/7", "10.0.0.0/8", "172.16.0.0/12", "192.168.0.0/16"]`.
### :rate_limit