Don't leak internal variables in the docs. They're useless to users.

diff --git a/config/description.exs b/config/description.exs
index 2c7d91ccc8b877e1506fc404e43c38daa40125eb..71cb5d9135f5914b1fbb5486e9e3051571e059c8 100644 (file)
--- a/config/description.exs
+++ b/config/description.exs
@@ -3263,7 +3263,7 @@ config :pleroma, :config_description, [
         key: :headers,
         type: {:list, :string},
         description: """
-          A list of strings naming the `req_headers` to use when deriving the `remote_ip`. Default: `["x-forwarded-for"]`.
+          A list of strings naming the HTTP headers to use when deriving the true client IP. Default: `["x-forwarded-for"]`.
         """
       },
       %{

diff --git a/docs/configuration/cheatsheet.md b/docs/configuration/cheatsheet.md
index 22333c4f82c982c09e2943e7746c274d8e1f6951..7f1dc0fe64e6900f0880b22d6f2c7ab8354bd596 100644 (file)
--- a/docs/configuration/cheatsheet.md
+++ b/docs/configuration/cheatsheet.md
@@ -426,7 +426,7 @@ 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`. Defaults to `["x-forwarded-for"]`.
+* `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. 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"]`.