From 208f9b26679f7604528b57a0a909ded2c5f55f99 Mon Sep 17 00:00:00 2001 From: Donal McBreen Date: Thu, 31 Oct 2024 09:20:02 +0000 Subject: [PATCH] Update docs for Kamal 2.3.0 --- _data/github.yml | 2 +- _data/nav.yml | 2 +- docs/commands/proxy.md | 3 ++- docs/commands/version.md | 2 +- docs/configuration/accessories.md | 10 ++++++++++ docs/configuration/builders.md | 9 +++++++++ 6 files changed, 24 insertions(+), 4 deletions(-) diff --git a/_data/github.yml b/_data/github.yml index fc0beca..4869346 100644 --- a/_data/github.yml +++ b/_data/github.yml @@ -1,3 +1,3 @@ -tag_name: 2.2.2 +tag_name: 2.3.0 v1: tag_name: 1.9.2 diff --git a/_data/nav.yml b/_data/nav.yml index 9b5f09e..4b16529 100644 --- a/_data/nav.yml +++ b/_data/nav.yml @@ -1,7 +1,7 @@ - title: "Documentation" url: /docs/ options: - - title: "Version 2.2.2" + - title: "Version 2.3.0" url: /docs/ - title: "Version 1.9.2" url: /v1/docs/ diff --git a/docs/commands/proxy.md b/docs/commands/proxy.md index ee33281..7c49d52 100644 --- a/docs/commands/proxy.md +++ b/docs/commands/proxy.md @@ -43,7 +43,8 @@ Options: # Default: 80 [--https-port=N] # HTTPS port to publish on the host # Default: 443 - [--docker-options=option=value option2=value2] # Docker options to pass to the proxy container + [--log-max-size=LOG_MAX_SIZE] # Max size of proxy logs + # Default: 10m ``` When set, the config will be stored on the server the proxy runs on. diff --git a/docs/commands/version.md b/docs/commands/version.md index 43f4c25..283dd27 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.2.2 +2.3.0 ``` diff --git a/docs/configuration/accessories.md b/docs/configuration/accessories.md index ef753e1..4a757fa 100644 --- a/docs/configuration/accessories.md +++ b/docs/configuration/accessories.md @@ -132,3 +132,13 @@ They are not created or copied before mounting: volumes: - /path/to/mysql-logs:/var/log/mysql ``` + +## [Network](#network) + +The network the accessory will be attached to. + +Defaults to kamal: + +```yaml + network: custom +``` diff --git a/docs/configuration/builders.md b/docs/configuration/builders.md index 206e3ce..e270e42 100644 --- a/docs/configuration/builders.md +++ b/docs/configuration/builders.md @@ -144,3 +144,12 @@ The build driver to use, defaults to `docker-container`: ```yaml driver: docker ``` + +## [Provenance](#provenance) + +It is used to configure provenance attestations for the build result. +The value can also be a boolean to enable or disable provenance attestations. + +```yaml + provenance: mode=max +```