From 4c9e8ef6253542e06160b587a1dbb9b4d5908305 Mon Sep 17 00:00:00 2001 From: Alex Auvolat Date: Sat, 24 Aug 2024 13:04:38 +0200 Subject: doc: clarify quick start on using docker --- doc/book/quick-start/_index.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) 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 \ -- cgit v1.2.3