From c3c8af9a66714c5697f6fd123d2e9b5b32027772 Mon Sep 17 00:00:00 2001 From: Agathe Porte Date: Sat, 25 Jul 2026 14:48:53 +0000 Subject: [PATCH] doc: quick-start: rework flag description (#1496) Add a link to the manual install procedure, use a quote to make the manual install path more visible and mention the --default-access-key option. Closes: #1446 Rendered output: ![image](/attachments/84bbe650-daff-40d1-b4bd-629abece27b0) Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/1496 --- doc/book/quick-start/_index.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/doc/book/quick-start/_index.md b/doc/book/quick-start/_index.md index a50e92f5..83131cf0 100644 --- a/doc/book/quick-start/_index.md +++ b/doc/book/quick-start/_index.md @@ -133,12 +133,17 @@ Use the following command to launch the Garage server: garage server --single-node --default-bucket ``` -The `--single-node` flag instructs Garage to automatically configure a single-node cluster without data replication. -The `--default-bucket` flag instructs Garage to create a default access key and a default bucket using the environment variables we defined above. -Both flags are optional and can be omitted, in which case you will have to follow manual configuration steps described below. +- the `--single-node` flag instructs Garage to automatically configure a + single-node cluster without data replication; +- the `--default-bucket` flag instructs Garage to create a default access key + and a default bucket using the environment variables we defined above (it + implies `--default-access-key`). -**For older versions of Garage (before v2.3.0):** automatic configuration using `--single-node` and `--default-bucket` is not available, -you must follow the manual configuration steps. +> You can refer to the [manual configuration +> steps](#manual-configuration) if: +> +> - you decide to no use these optional flags; +> - you are running an **older version of Garage (before v2.3.0)**. Alternatively, if you cannot or do not wish to run the Garage binary directly, you may use Docker to run Garage in a container using the following command: @@ -292,7 +297,7 @@ An exhaustive list is maintained in the ["Integrations" > "Browsing tools" secti -## Manual configuration +## Manual configuration {#manual-configuration} This section provides instructions that are equivalent to using the `--single-node` and `--default-bucket` flags for automatic configuration. If