Improve reverse proxy documentation in default.settings.php

Thanks for the issue and patch! The patch needs some work before we can commit it though:

1. +++ b/sites/default/default.settings.php
   @@ -373,32 +373,33 @@
   + * Set this value if your proxy server sends the original client IP in a header
   + * other than X_FORWARDED_FOR.
     */
   -# $settings['reverse_proxy_header'] = 'X_CLUSTER_CLIENT_IP';
   +# $settings['reverse_proxy_header'] = 'X_FORWARDED_FOR';
   

   I don't understand the code (or commented-out code) change here. The docs say that you should only set this value if you are not using X_FORWARDED_FOR, so the line that was previously in this file gave an example of something you might set it to. I don't think we should change it, since setting it to X_FORWARDED_FOR is not something anyone would ever set it to, right???

2. +++ b/sites/default/default.settings.php
   @@ -373,32 +373,33 @@
   + * Set this value if your proxy server sends the original client protocol in a header
   

   This line is now over 80 characters, so you need to rewrap it.

   I also don't understand why you felt it was necessary to add "original" to all of these lines. I think it should probably just be taken out, but if it *is* necessary, you need to rewrap the docs so they don't go over 80 character lines.

3. +++ b/sites/default/default.settings.php
   @@ -373,32 +373,33 @@
   + * Set this value if your proxy server sends the original client host in a header
   

   remove "original" or rewrap here too.

4. +++ b/sites/default/default.settings.php
   @@ -373,32 +373,33 @@
   + * Set this value if your proxy server sends the original client port in a header
   

   here too

5. +++ b/sites/default/default.settings.php
   @@ -373,32 +373,33 @@
   + * Set this value if your proxy server sends standard combined forwarding information
   

   This is over 80 characters too.

6. +++ b/sites/default/default.settings.php
   @@ -373,32 +373,33 @@
   + * @link https://tools.ietf.org/html/rfc7239
   

   This is not how @link works. See
   https://www.drupal.org/node/1354#link
   for more information. Probably rather than @link you either want @see or just the URL in a sentence anyway?

Fair enough! So the latest patch looks good, except one small nitpick:

+++ b/sites/default/default.settings.php
@@ -374,31 +374,32 @@
+ * @see https://tools.ietf.org/html/rfc7239

Thanks -- @see works better here. But you need to leave a blank line before an @see line.

Almost there!

+++ b/sites/default/default.settings.php
@@ -374,31 +374,33 @@
+ * ¶

There is an extra space at the end of this line.

You should be able to set your code editor or IDE to either remove or highlight end-of-line spaces.

Fixed #9, good work guys!

Looks good now, thanks everyone!

These are the actual header names, which is what's referred to in the docs, I don't think we should just switch to referring to the constants here.

Thanks all,
Here is a new patch suggestion.

I still think the comments should match the actual HTTP headers rather than the constants here since that's what they're referring to.

Thanks Catch,
I try to understand. As we speak about custom proxy headers, we can't use the ones from https://tools.ietf.org/html/rfc7239.

Do you mean something like the following?
+# $settings['reverse_proxy_header'] = 'Your-Customized-X-Forwarded-For';
or
+# $settings['reverse_proxy_header'] = 'X-Forwarded-For-Customized';

@Catch can you clarify what is the problem? I'm not sure what fix is needed. See #21.

Not a functional bug, but it's not good for Drupal to have such errors in the official example configuration file.

There's another issue about this wording: https://www.drupal.org/project/drupal/issues/3017957

- For X_FORWARDED_HOST, I suggest to use "the original host requested by the client" instead of "the client host"
- For X_FORWARDED_PORT, I suggest to use "the original port requested by the client" instead of "the client port"

This issue is probably outdated now because of #3030501

As part of #3030501:
Following settings were deprecated and their documentation was removed from default.settings.php

1. reverse_proxy_header
2. reverse_proxy_proto_header
3. reverse_proxy_host_header
4. reverse_proxy_port_heade
5. reverse_proxy_forwarded_header

Which fixes the all the documentation issues mentioned here.

Closing because of the above comment. Feel free to reopen if you disagree.