gsadmin/garage
1
0
Fork 0
mirror of https://github.com/deuxfleurs-org/garage.git synced 2026-07-26 07:58:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: quick-start: rework flag description (#1496)

Browse Source 
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
This commit is contained in:
Agathe Porte
2026-07-25 14:48:53 +00:00
committed by Alex
parent ad78b9ee5c
commit c3c8af9a66
1 changed files with 11 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/book/quick-start/_index.md
+11 -6
View File
@@ -133,12 +133,17 @@ Use the following command to launch the Garage server:
garage server --single-node --default-bucket garage server --single-node --default-bucket
``` ```
The `--single-node` flag instructs Garage to automatically configure a single-node cluster without data replication. - the `--single-node` flag instructs Garage to automatically configure a
The `--default-bucket` flag instructs Garage to create a default access key and a default bucket using the environment variables we defined above. single-node cluster without data replication;
Both flags are optional and can be omitted, in which case you will have to follow manual configuration steps described below. - 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 can refer to the [manual configuration
you must follow the manual configuration steps. > 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, 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: 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 This section provides instructions that are equivalent to using the
`--single-node` and `--default-bucket` flags for automatic configuration. If `--single-node` and `--default-bucket` flags for automatic configuration. If