Re-applied corrections to configuration YAML files that were merged directly into kamal-site

lib/kamal/configuration/docs/proxy.yml

@@ -5,16 +5,16 @@
 # application container.
 #
 # The proxy is configured in the root configuration under `proxy`. These are
-# options that are set when deploying the application, not when booting the proxy
+# options that are set when deploying the application, not when booting the proxy.
 #
-# They are application specific, so are not shared when multiple applications
+# They are application-specific, so they are not shared when multiple applications
 # run on the same proxy.
 #
-# The proxy is enabled by default on the primary role, but can be disabled by
+# The proxy is enabled by default on the primary role but can be disabled by
 # setting `proxy: false`.
 #
-# It is disabled by default on all other roles, but can be enabled by setting
-# `proxy: true`, or providing a proxy configuration.
+# It is disabled by default on all other roles but can be enabled by setting
+# `proxy: true` or providing a proxy configuration.
 proxy:
 
   # Host
@@ -25,34 +25,36 @@ proxy:
   # If no hosts are set, then all requests will be forwarded, except for matching
   # requests for other apps deployed on that server that do have a host set.
   host: foo.example.com
+  # If multiple hosts are needed, these can be specified by comma-separating the hosts.
+  host: foo.example.com,bar.example.com
 
   # App port
   #
-  # The port the application container is exposed on
+  # The port the application container is exposed on.
   #
-  # Defaults to 80
+  # Defaults to 80:
   app_port: 3000
 
   # SSL
   #
   # kamal-proxy can provide automatic HTTPS for your application via Let's Encrypt.
   #
-  # This requires that we are deploying to a one server and the host option is set.
-  # The host value must point to the server we are deploying to and port 443 must be
+  # This requires that we are deploying to one server and the host option is set.
+  # 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.
   #
-  # Defaults to false
+  # Defaults to `false`:
   ssl: true
 
   # Response timeout
   #
-  # How long to wait for requests to complete before timing out, defaults to 30 seconds
+  # How long to wait for requests to complete before timing out, defaults to 30 seconds:
   response_timeout: 10
 
   # Healthcheck
   #
-  # When deploying, the proxy will by default hit /up once every second until we hit
-  # the deploy timeout, with a 5 second timeout for each request.
+  # When deploying, the proxy will by default hit `/up` once every second until we hit
+  # the deploy timeout, with a 5-second timeout for each request.
   #
   # Once the app is up, the proxy will stop hitting the healthcheck endpoint.
   healthcheck:
@@ -62,12 +64,12 @@ proxy:
 
   # Buffering
   #
-  # Whether to buffer request and response bodies in the proxy
+  # Whether to buffer request and response bodies in the proxy.
   #
-  # By default buffering is enabled with a max request body size of 1GB and no limit
+  # By default, buffering is enabled with a max request body size of 1GB and no limit
   # for response size.
   #
-  # You can also set the memory limit for buffering, which defaults to 1MB, anything
+  # You can also set the memory limit for buffering, which defaults to 1MB; anything
   # larger than that is written to disk.
   buffering:
     requests: true
@@ -78,9 +80,9 @@ proxy:
 
   # Logging
   #
-  # Configure request logging for the proxy
+  # Configure request logging for the proxy.
   # You can specify request and response headers to log.
-  # By default, Cache-Control, Last-Modified and User-Agent request headers are logged
+  # By default, `Cache-Control`, `Last-Modified`, and `User-Agent` request headers are logged:
   logging:
     request_headers:
       - Cache-Control
@@ -91,10 +93,10 @@ proxy:
 
   # Forward headers
   #
-  # Whether to forward the X-Forwarded-For and X-Forwarded-Proto 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.
+  # 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 the ssl option is set to true, and
-  # will forward them if it is set to false.
+  # 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