From 5a186be363ca5225a40bb4ecffb97b342e840269 Mon Sep 17 00:00:00 2001 From: Alex Auvolat Date: Wed, 14 Jun 2023 11:09:31 +0200 Subject: Doc: update goals, add docker alias Fix #235 --- doc/book/cookbook/real-world.md | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'doc/book/cookbook/real-world.md') diff --git a/doc/book/cookbook/real-world.md b/doc/book/cookbook/real-world.md index 08266b23..0b9e016c 100644 --- a/doc/book/cookbook/real-world.md +++ b/doc/book/cookbook/real-world.md @@ -197,6 +197,12 @@ The `garage` binary has two purposes: Ensure an appropriate `garage` binary (the same version as your Docker image) is available in your path. If your configuration file is at `/etc/garage.toml`, the `garage` binary should work with no further change. +You can also use an alias as follows to use the Garage binary inside your docker container: + +```bash +alias garage="docker exec -ti /garage" +``` + You can test your `garage` CLI utility by running a simple command such as: ```bash -- cgit v1.2.3 From dd7533a260291a25d69b8e7afa423df9e0d6a30c Mon Sep 17 00:00:00 2001 From: Alex Auvolat Date: Wed, 14 Jun 2023 12:08:02 +0200 Subject: doc: add an operations&maintenance section and move some pages there --- doc/book/cookbook/real-world.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/book/cookbook/real-world.md') diff --git a/doc/book/cookbook/real-world.md b/doc/book/cookbook/real-world.md index 0b9e016c..7061069f 100644 --- a/doc/book/cookbook/real-world.md +++ b/doc/book/cookbook/real-world.md @@ -345,7 +345,7 @@ garage layout apply ``` **WARNING:** if you want to use the layout modification commands in a script, -make sure to read [this page](@/documentation/reference-manual/layout.md) first. +make sure to read [this page](@/documentation/operations/layout.md) first. ## Using your Garage cluster -- cgit v1.2.3