Skip to content

Commit 77c202e

Browse files
committed
Highlight ssl/forward_headers behaviour
Pulled in from: basecamp/kamal-site#141
1 parent 063dfd9 commit 77c202e

File tree

1 file changed

+13
-10
lines changed

1 file changed

+13
-10
lines changed

lib/kamal/configuration/docs/proxy.yml

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,22 @@ proxy:
4646
# The host value must point to the server we are deploying to, and port 443 must be
4747
# open for the Let's Encrypt challenge to succeed.
4848
#
49+
# If you set `ssl` to `true`, `kamal-proxy` will stop forwarding headers to your app,
50+
# unless you explicitly set `forward_headers: true`
51+
#
4952
# Defaults to `false`:
5053
ssl: true
5154

55+
# Forward headers
56+
#
57+
# Whether to forward the `X-Forwarded-For` and `X-Forwarded-Proto` headers.
58+
#
59+
# If you are behind a trusted proxy, you can set this to `true` to forward the headers.
60+
#
61+
# By default, kamal-proxy will not forward the headers if the `ssl` option is set to `true`, and
62+
# will forward them if it is set to `false`.
63+
forward_headers: true
64+
5265
# Response timeout
5366
#
5467
# How long to wait for requests to complete before timing out, defaults to 30 seconds:
@@ -93,13 +106,3 @@ proxy:
93106
response_headers:
94107
- X-Request-ID
95108
- X-Request-Start
96-
97-
# Forward headers
98-
#
99-
# Whether to forward the `X-Forwarded-For` and `X-Forwarded-Proto` headers.
100-
#
101-
# If you are behind a trusted proxy, you can set this to `true` to forward the headers.
102-
#
103-
# By default, kamal-proxy will not forward the headers if the `ssl` option is set to `true`, and
104-
# will forward them if it is set to `false`.
105-
forward_headers: true

0 commit comments

Comments
 (0)