Skip to content

Commit 7b1439c

Browse files
committed
Update per-role proxy docs
Clarify that proxy: true/proxy: false only belong in the role config, not at the root level.
1 parent b9e5ce7 commit 7b1439c

File tree

1 file changed

+27
-5
lines changed

1 file changed

+27
-5
lines changed

lib/kamal/configuration/docs/proxy.yml

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,6 @@
1010
# They are application-specific, so they are not shared when multiple applications
1111
# run on the same proxy.
1212
#
13-
# The proxy is enabled by default on the primary role but can be disabled by
14-
# setting `proxy: false`.
15-
#
16-
# It is disabled by default on all other roles but can be enabled by setting
17-
# `proxy: true` or providing a proxy configuration.
1813
proxy:
1914

2015
# Hosts
@@ -113,3 +108,30 @@ proxy:
113108
response_headers:
114109
- X-Request-ID
115110
- X-Request-Start
111+
112+
# Enabling/disabling the proxy on roles
113+
#
114+
# The proxy is enabled by default on the primary role but can be disabled by
115+
# setting `proxy: false` in the primary role's configuration.
116+
#
117+
# ```yaml
118+
# servers:
119+
# web:
120+
# hosts:
121+
# - ...
122+
# proxy: false
123+
# ```
124+
#
125+
# It is disabled by default on all other roles but can be enabled by setting
126+
# `proxy: true` or providing a proxy configuration for that role.
127+
#
128+
# ```yaml
129+
# servers:
130+
# web:
131+
# hosts:
132+
# - ...
133+
# web2:
134+
# hosts:
135+
# - ...
136+
# proxy: true
137+
# ```

0 commit comments

Comments
 (0)