docs for the X-Forwarded-Proto or $scheme behavior, #11

schmunk42 · Dec 12, 2018 · 2ff5218 · 2ff5218
1 parent 3452fdc
commit 2ff5218
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -16,7 +16,8 @@ A very simple container to redirect HTTP traffic to another server, based on `ng
 - `SERVER_REDIRECT_PATH` - optionally define path to redirect all requests eg. `/landingpage`
    - if not set nginx var `$request_uri` is used
 - `SERVER_REDIRECT_SCHEME` - optionally define scheme to redirect to 
-   - if not set nginx var `$scheme` is used
+   - if not set but X-Forwarded-Proto is send as request header with value 'https' this will be used. 
+     In all other cases nginx var `$scheme` is used
 - `SERVER_REDIRECT_CODE` - optionally define the http status code to use for redirection
    - if not set or not in list of allowed codes 301 is used as default
    - allowed Codes are: 301, 302, 303, 307, 308

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -8,7 +8,8 @@ to:
     # if not set nginx var $request_uri is used
     #- SERVER_REDIRECT_PATH=/landingpage
     # optionally define schema to redirect all requests
-    # if not set nginx var $scheme is used
+    # if not set but X-Forwarded-Proto is send as request header with value 'https' this will be used.
+    # In all other cases nginx var `$scheme` is used
     #- SERVER_REDIRECT_SCHEME=https
     # optionally define the http code to use for redirection
     # allowed Codes are: 301, 302, 303, 307, 308, default is 301