diff --git a/_data/github.yml b/_data/github.yml index 4869346..21ddac4 100644 --- a/_data/github.yml +++ b/_data/github.yml @@ -1,3 +1,3 @@ -tag_name: 2.3.0 +tag_name: 2.4.0 v1: tag_name: 1.9.2 diff --git a/_data/nav.yml b/_data/nav.yml index 4b16529..d25cc0f 100644 --- a/_data/nav.yml +++ b/_data/nav.yml @@ -1,7 +1,7 @@ - title: "Documentation" url: /docs/ options: - - title: "Version 2.3.0" + - title: "Version 2.4.0" url: /docs/ - title: "Version 1.9.2" url: /v1/docs/ diff --git a/docs/commands/version.md b/docs/commands/version.md index 283dd27..0a42886 100644 --- a/docs/commands/version.md +++ b/docs/commands/version.md @@ -8,5 +8,5 @@ Returns the version of Kamal you have installed. ```bash $ kamal version -2.3.0 +2.4.0 ``` diff --git a/docs/configuration/accessories.md b/docs/configuration/accessories.md index 249bbd5..a9d21c4 100644 --- a/docs/configuration/accessories.md +++ b/docs/configuration/accessories.md @@ -64,8 +64,8 @@ You can set a custom command to run in the container if you do not want to use t ## [Port mappings](#port-mappings) -See [https://docs.docker.com/network/](https://docs.docker.com/network/), and especially note the warning about the security -implications of exposing ports publicly. +See [https://docs.docker.com/network/](https://docs.docker.com/network/), and +especially note the warning about the security implications of exposing ports publicly. ```yaml port: "127.0.0.1:3306:3306" @@ -142,3 +142,11 @@ Defaults to kamal: ```yaml network: custom ``` + +## [Proxy](#proxy) + + +```yaml + proxy: + ... +``` diff --git a/docs/configuration/aliases.md b/docs/configuration/aliases.md index 04cf851..8739cfe 100644 --- a/docs/configuration/aliases.md +++ b/docs/configuration/aliases.md @@ -18,7 +18,7 @@ By defining an alias, like this: ```yaml aliases: - console: app exec --reuse -i "bin/rails console" + console: app exec -i --reuse "bin/rails console" ``` You can now open the console with: diff --git a/docs/configuration/builders.md b/docs/configuration/builders.md index e270e42..358915a 100644 --- a/docs/configuration/builders.md +++ b/docs/configuration/builders.md @@ -153,3 +153,12 @@ The value can also be a boolean to enable or disable provenance attestations. ```yaml provenance: mode=max ``` + +## [SBOM (Software Bill of Materials)](#sbom-(software-bill-of-materials)) + +It is used to configure SBOM generation for the build result. +The value can also be a boolean to enable or disable SBOM generation. + +```yaml + sbom: true +``` diff --git a/docs/configuration/docker-registry.md b/docs/configuration/docker-registry.md index 87c58b7..851f285 100644 --- a/docs/configuration/docker-registry.md +++ b/docs/configuration/docker-registry.md @@ -8,7 +8,9 @@ title: Registry The default registry is Docker Hub, but you can change it using `registry/server`. -By default, Docker Hub creates public repositories. To avoid making your images public, set up a private repository before deploying, or change the default repository privacy settings to private in your [Docker Hub settings](https://hub.docker.com/repository-settings/default-privacy). +By default, Docker Hub creates public repositories. To avoid making your images public, +set up a private repository before deploying, or change the default repository privacy +settings to private in your [Docker Hub settings](https://hub.docker.com/repository-settings/default-privacy). A reference to a secret (in this case, `DOCKER_REGISTRY_TOKEN`) will look up the secret in the local environment: diff --git a/docs/configuration/proxy.md b/docs/configuration/proxy.md index 0ccb2f3..07c00c2 100644 --- a/docs/configuration/proxy.md +++ b/docs/configuration/proxy.md @@ -61,13 +61,27 @@ 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. +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`: ```yaml ssl: true ``` -If you set `ssl` to `true`, `kamal-proxy` will stop forwarding headers to your app, unless you explicitly set `forward_headers: true`, as documented in [Forward Headers](#forward-headers). +## [Forward headers](#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`. + +```yaml + forward_headers: true +``` ## [Response timeout](#response-timeout) @@ -125,16 +139,3 @@ By default, `Cache-Control`, `Last-Modified`, and `User-Agent` request headers a - X-Request-ID - X-Request-Start ``` - -## [Forward headers](#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`. - -```yaml - forward_headers: true -```