Add `X-Forwarded-Host` section to the README
To ensure the plugin works correctly in various network setups the
section about `X-Forwarded-Host` was added to the README.md file.
Change-Id: Ib27aefca39c5be6767d258145a39a2f9d0b4e7c2
diff --git a/README.md b/README.md
index de12059..e94a03e 100644
--- a/README.md
+++ b/README.md
@@ -27,6 +27,13 @@
filterClass = com.gerritforge.gerrit.modules.virtualhost.VirtualHostFilter
```
+## Propagation of the `X-Forwarded-Host` Header:
+
+When Gerrit is hidden behind multiple service layers (eg. reverse-proxy and
+load balancer), it is essential to ensure the propagation from the upstream
+proxy of the header [X-Forwarded-Host](https://www.rfc-editor.org/rfc/rfc7239.html)
+from the upstream proxy.
+
## How to define virtual hosts
/etc/virtualhost.config contains the definition of the virtual
