Skip to content

Commit

Permalink
Highlight ssl/forward_headers behaviour
Browse files Browse the repository at this point in the history
Pulled in from: basecamp/kamal-site#141
  • Loading branch information
djmb committed Dec 13, 2024
1 parent 063dfd9 commit 77c202e
Showing 1 changed file with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions lib/kamal/configuration/docs/proxy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,22 @@ proxy:
# The host value must point to the server we are deploying to, and port 443 must be
# open for the Let's Encrypt challenge to succeed.
#
# If you set `ssl` to `true`, `kamal-proxy` will stop forwarding headers to your app,
# unless you explicitly set `forward_headers: true`
#
# Defaults to `false`:
ssl: true

# Forward headers
#
# Whether to forward the `X-Forwarded-For` and `X-Forwarded-Proto` headers.
#
# If you are behind a trusted proxy, you can set this to `true` to forward the headers.
#
# By default, kamal-proxy will not forward the headers if the `ssl` option is set to `true`, and
# will forward them if it is set to `false`.
forward_headers: true

# Response timeout
#
# How long to wait for requests to complete before timing out, defaults to 30 seconds:
Expand Down Expand Up @@ -93,13 +106,3 @@ proxy:
response_headers:
- X-Request-ID
- X-Request-Start

# Forward headers
#
# Whether to forward the `X-Forwarded-For` and `X-Forwarded-Proto` headers.
#
# If you are behind a trusted proxy, you can set this to `true` to forward the headers.
#
# By default, kamal-proxy will not forward the headers if the `ssl` option is set to `true`, and
# will forward them if it is set to `false`.
forward_headers: true

0 comments on commit 77c202e

Please sign in to comment.