aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlex Auvolat <alex@adnab.me>2023-06-14 11:09:31 +0200
committerAlex Auvolat <alex@adnab.me>2023-06-14 11:09:31 +0200
commit5a186be363ca5225a40bb4ecffb97b342e840269 (patch)
treed9dee65648cad0182e1772c930b74d639fd4b6bd
parent01346143ca09eab262f0d8f8a0a744c2f6d667cc (diff)
downloadgarage-5a186be363ca5225a40bb4ecffb97b342e840269.tar.gz
garage-5a186be363ca5225a40bb4ecffb97b342e840269.zip
Doc: update goals, add docker alias
Fix #235
-rw-r--r--doc/book/cookbook/real-world.md6
-rw-r--r--doc/book/design/goals.md12
2 files changed, 11 insertions, 7 deletions
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 <container name> /garage"
+```
+
You can test your `garage` CLI utility by running a simple command such as:
```bash
diff --git a/doc/book/design/goals.md b/doc/book/design/goals.md
index 4e390ba6..78ac7978 100644
--- a/doc/book/design/goals.md
+++ b/doc/book/design/goals.md
@@ -42,15 +42,13 @@ locations. They use Garage themselves for the following tasks:
- As a [Matrix media backend](https://github.com/matrix-org/synapse-s3-storage-provider)
-- To store personal data and shared documents through [Bagage](https://git.deuxfleurs.fr/Deuxfleurs/bagage), a homegrown WebDav-to-S3 proxy
+- As a Nix binary cache
-- In the Drone continuous integration platform to store task logs
+- To store personal data and shared documents through [Bagage](https://git.deuxfleurs.fr/Deuxfleurs/bagage), a homegrown WebDav-to-S3 and SFTP-to-S3 proxy
-- As a Nix binary cache
+- As a backup target using `rclone` and `restic`
-- As a backup target using `rclone`
+- In the Drone continuous integration platform to store task logs
The Deuxfleurs Garage cluster is a multi-site cluster currently composed of
-4 nodes in 2 physical locations. In the future it will be expanded to at
-least 3 physical locations to fully exploit Garage's potential for high
-availability.
+9 nodes in 3 physical locations.