spacebar/kamal
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Formatting fixes for docs

Browse Source
This commit is contained in:
Donal McBreen
2025-06-17 15:34:27 +01:00
parent 9244247389
commit aed77a78fb
2 changed files with 9 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
lib/kamal/configuration/docs/builder.yml
View File

@@ -8,6 +8,7 @@
# #
# Options go under the builder key in the root configuration. # Options go under the builder key in the root configuration.
builder: builder:
# Arch # Arch
# #
# The architectures to build for — you can set an array or just a single value. # The architectures to build for — you can set an array or just a single value.

15
lib/kamal/configuration/docs/proxy.yml
View File

@@ -11,6 +11,7 @@
# run on the same proxy. # run on the same proxy.
# #
proxy: proxy:
# Hosts # Hosts
# #
# The hosts that will be used to serve the app. The proxy will only route requests # The hosts that will be used to serve the app. The proxy will only route requests
@@ -48,9 +49,9 @@ proxy:
# Custom SSL certificate # Custom SSL certificate
# #
# In some cases, using Let's Encrypt for automatic certificate management is not an # In some cases, using Let's Encrypt for automatic certificate management is not an
# option, or you may already have SSL certificates issued by a different # option, or you may already have SSL certificates issued by a different
# Certificate Authority (CA). Kamal supports loading custom SSL certificates # Certificate Authority (CA). Kamal supports loading custom SSL certificates
# directly from secrets. # directly from secrets.
# #
# Examples: # Examples:
@@ -84,12 +85,12 @@ proxy:
# Path-based routing # Path-based routing
# #
# For applications that split their traffic to different services based on the request path, # For applications that split their traffic to different services based on the request path,
# you can use path-based routing to mount services under different path prefixes. # you can use path-based routing to mount services under different path prefixes.
path_prefix: '/api' path_prefix: '/api'
# By default, the path prefix will be stripped from the request before it is forwarded upstream. # By default, the path prefix will be stripped from the request before it is forwarded upstream.
# So in the example above, a request to /api/users/123 will be forwarded to web-1 as /users/123. # So in the example above, a request to /api/users/123 will be forwarded to web-1 as /users/123.
# To instead forward the request with the original path (including the prefix), # To instead forward the request with the original path (including the prefix),
# specify --strip-path-prefix=false # specify --strip-path-prefix=false
strip_path_prefix: false strip_path_prefix: false