Document log x-forwarded-for

Signed-off-by: Laurent Bercot <ska@appnovation.com>

1 files changed, 8 insertions, 0 deletions

diff --git a/doc/tipidee.conf.html b/doc/tipidee.conf.html
index 182c206..d75af1b 100644
--- a/doc/tipidee.conf.html
+++ b/doc/tipidee.conf.html
@@ -419,6 +419,14 @@ This keyword has no effect when given without the <tt>request</tt> keyword. </dd
 requests that include a <tt>User-Agent:</tt> header. <em>user-agent</em> is quoted like <em>path</em>, to avoid
 malicious clients messing with log lines.
 This keyword has no effect when given without the <tt>request</tt> keyword. </dd>
+ <dt> <tt>x-forwarded-for</tt> </dt> <dd> Add a <tt>x-forwarded-for "<em>xff</em>"</tt> field to the <tt>request</tt> line, for
+requests that include an <tt>X-Forwarded-For:</tt> header. <em>xx</em> is quoted like <em>path</em> and <em>user-agent</em>,
+for the same reasons.
+This keyword has no effect when given without the <tt>request</tt> keyword. <br>
+Note that if the connection is proxied, the <tt>start</tt> line, if any, will only have information about
+the proxy, and only <tt>x-forwarded-for</tt> will have information about the client. Also note that
+the information in an <tt>X-Forwarded-For:</tt> header is potentially PII, so make sure to stay
+compliant with your local laws if you activate the option. </dd>
  <dt> <tt>resource</tt> </dt> <dd> Log a <tt>resource</tt> line when <a href="tipideed.html">tipideed</a>
 has found a resource corresponding to the URI and is willing to serve it. The line looks like
 <tt>resource <em>file</em> type <em>type</em></tt>.