From 907df9dc1f4e8d8511db9b8f2e71e302389921bf Mon Sep 17 00:00:00 2001 From: Kumi Date: Thu, 26 Sep 2024 07:45:52 +0200 Subject: [PATCH] fix(docs): clarify proxy fix usage with reverse proxies Added additional context to the explanation of the ProxyFix middleware in the README. It now details how to recognize issues with the `X-Forwarded-Host` header, such as the URL displaying internal IP and port instead of the domain name. This improvement helps users better understand when to enable the `PROXY_FIX` environment variable. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5f0e8a0..07e07f8 100644 --- a/README.md +++ b/README.md @@ -107,7 +107,7 @@ This is a basic guide to deploy Small using uWSGI and Caddy. #### Proxy Fix -If you are using a reverse proxy like Nginx, and it is setting the `X-Forwarded-Host` header instead of passing the `Host` header, you can use the `ProxyFix` middleware to fix the issue. To enable it, simply set the `PROXY_FIX` environment variable to `1`. +If you are using a reverse proxy like Nginx, and it is setting the `X-Forwarded-Host` header instead of passing the `Host` header (you will notice this if the URL displayed on the landing page shows the internal IP and port instead of the domain name), you can use the `ProxyFix` middleware to fix the issue. To enable it, simply set the `PROXY_FIX` environment variable to `1`. For uWSGI, you can add the following line to the `small.ini` file: ```