aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlex <alex@adnab.me>2023-08-28 10:18:33 +0000
committerAlex <alex@adnab.me>2023-08-28 10:18:33 +0000
commita54a1f5616a49f31d63c38ffb5c7f47ce160160c (patch)
tree3b47ca976b8f969e649fd53147af7cbbc3c150ea
parent9b4ce4a8ad645a012d5bd31d4d588cb7c3962b1a (diff)
parent06caa12d4992ec31ff231c013a463ab07eeb793c (diff)
downloadgarage-a54a1f5616a49f31d63c38ffb5c7f47ce160160c.tar.gz
garage-a54a1f5616a49f31d63c38ffb5c7f47ce160160c.zip
Merge pull request 'doc: Add information about Alpine Linux package to Quick Start' (#564) from jirutka/garage:alpine into next-0.8
Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/564
-rw-r--r--doc/book/quick-start/_index.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/book/quick-start/_index.md b/doc/book/quick-start/_index.md
index f556eaa3..46aaa9bc 100644
--- a/doc/book/quick-start/_index.md
+++ b/doc/book/quick-start/_index.md
@@ -40,6 +40,25 @@ or if you want a build customized for your system,
you can [build Garage from source](@/documentation/cookbook/from-source.md).
+### Alpine Linux
+
+If you use Alpine Linux, you can simply install the
+[garage](https://pkgs.alpinelinux.org/packages?name=garage) package from the
+Alpine Linux repositories (available since v3.17):
+
+```bash
+apk add garage
+```
+
+The default configuration file is installed to `/etc/garage.toml`. You can run
+Garage using: `rc-service garage start`. If you don't specify `rpc_secret`, it
+will be automatically replaced with a random string on the first start.
+
+Please note that this package is built without Consul discovery, Kubernetes
+discovery, OpenTelemetry exporter, and K2V features (K2V will be enabled once
+it's stable).
+
+
## Configuring and starting Garage
### Generating a first configuration file