From: Mark Felder <feld@FreeBSD.org>
Date: Tue, 6 Oct 2020 20:47:11 +0000 (-0500)
Subject: Fix docs for default headers used by RemoteIp. We only use X-Forwarded-For by default.
X-Git-Url: https://git.squeep.com/?a=commitdiff_plain;h=7aff2b47c56c5b41620445b7d49c429eb1866164;p=akkoma

Fix docs for default headers used by RemoteIp. We only use X-Forwarded-For by default.
---

diff --git a/config/description.exs b/config/description.exs
index ac3dfbb2b..f6331dd30 100644
--- a/config/description.exs
+++ b/config/description.exs
@@ -3262,8 +3262,9 @@ 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`. Order does not matter. Default: `~w[forwarded x-forwarded-for x-client-ip x-real-ip]`."
+        description: """
+          A list of strings naming the `req_headers` to use when deriving the `remote_ip`. Default: `["x-forwarded-for"]`.
+        """
       },
       %{
         key: :proxies,
diff --git a/docs/configuration/cheatsheet.md b/docs/configuration/cheatsheet.md
index 42e5fe808..e0194525d 100644
--- 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`. Order does not matter. Defaults to `["x-forwarded-for"]`.
+* `headers` - A list of strings naming the `req_headers` to use when deriving the `remote_ip`. 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).