From 06caa12d4992ec31ff231c013a463ab07eeb793c Mon Sep 17 00:00:00 2001 From: Jakub Jirutka Date: Sun, 7 May 2023 19:25:57 +0200 Subject: doc: Add information about Alpine Linux package to Quick Start --- doc/book/quick-start/_index.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) (limited to 'doc/book') diff --git a/doc/book/quick-start/_index.md b/doc/book/quick-start/_index.md index f01789a3..5863c09b 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 -- cgit v1.2.3 From 51011e68b16efc2232606bee47fcdc9e8a11068e Mon Sep 17 00:00:00 2001 From: Alex Auvolat Date: Mon, 28 Aug 2023 12:20:34 +0200 Subject: move alpine linux info to binary package page --- doc/book/cookbook/binary-packages.md | 15 ++++++++++++++- doc/book/quick-start/_index.md | 22 +++------------------- 2 files changed, 17 insertions(+), 20 deletions(-) (limited to 'doc/book') diff --git a/doc/book/cookbook/binary-packages.md b/doc/book/cookbook/binary-packages.md index 606de2b6..0a6ad8fc 100644 --- a/doc/book/cookbook/binary-packages.md +++ b/doc/book/cookbook/binary-packages.md @@ -7,10 +7,23 @@ Garage is also available in binary packages on: ## 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 install garage +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). + + ## Arch Linux Garage is available in the [AUR](https://aur.archlinux.org/packages/garage). diff --git a/doc/book/quick-start/_index.md b/doc/book/quick-start/_index.md index 46aaa9bc..4f974ea5 100644 --- a/doc/book/quick-start/_index.md +++ b/doc/book/quick-start/_index.md @@ -35,30 +35,14 @@ Place this binary somewhere in your `$PATH` so that you can invoke the `garage` command directly (for instance you can copy the binary in `/usr/local/bin` or in `~/.local/bin`). +You may also check whether your distribution already includes a +[binary package for Garage](@/documentation/cookbook/binary-packages.md). + 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). -### 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 -- cgit v1.2.3