aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAlex Auvolat <alex@adnab.me>2024-08-24 13:04:38 +0200
committerAlex Auvolat <alex@adnab.me>2024-08-24 13:07:02 +0200
commit4c9e8ef6253542e06160b587a1dbb9b4d5908305 (patch)
tree22201a86af1c09c1f74c32d5e444a3bc33464a02 /doc
parent0c3b198b226ebb9dabee7bcd3c8a6da7aa5afea4 (diff)
downloadgarage-4c9e8ef6253542e06160b587a1dbb9b4d5908305.tar.gz
garage-4c9e8ef6253542e06160b587a1dbb9b4d5908305.zip
doc: clarify quick start on using docker
Diffstat (limited to 'doc')
-rw-r--r--doc/book/quick-start/_index.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/doc/book/quick-start/_index.md b/doc/book/quick-start/_index.md
index de627cbb..5f17447b 100644
--- a/doc/book/quick-start/_index.md
+++ b/doc/book/quick-start/_index.md
@@ -42,6 +42,13 @@ If a binary of the last version is not available for your architecture,
or if you want a build customized for your system,
you can [build Garage from source](@/documentation/cookbook/from-source.md).
+If none of these option work for you, you can also run Garage in a Docker
+container. When using Docker, the commands used in this guide will not work
+anymore. We recommend reading the tutorial on [configuring a
+multi-node cluster](@/documentation/cookbook/real-world.md) to learn about
+using Garage as a Docker container. For simplicity, a minimal command to launch
+Garage using Docker is provided in this quick start guide as well.
+
## Configuring and starting Garage
@@ -114,7 +121,8 @@ garage -c path/to/garage.toml server
If you have placed the `garage.toml` file in `/etc` (its default location), you can simply run `garage server`.
-To create a Docker container of Garage from an image, run:
+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:
```bash
docker run \