From 146a11700e910e29f1888c72c02cf77aeeee23dc Mon Sep 17 00:00:00 2001 From: Nick Larsen Date: Wed, 14 Aug 2024 10:05:06 +0200 Subject: [PATCH 1/2] docs(stackablectl): fix installation command so that copying doesn't run both --- .../stackablectl/pages/installation.adoc | 27 ++++++++++++++----- 1 file changed, 21 insertions(+), 6 deletions(-) diff --git a/docs/modules/stackablectl/pages/installation.adoc b/docs/modules/stackablectl/pages/installation.adoc index 3177bd79..0f279249 100644 --- a/docs/modules/stackablectl/pages/installation.adoc +++ b/docs/modules/stackablectl/pages/installation.adoc @@ -15,13 +15,21 @@ manual building steps can be found in xref:#building-from-source[this] section. Linux:: + -- -Download the `stackablectl-x86_64-unknown-linux-gnu` binary file from the link:{latest-release}[latest release], then -rename the file to `stackablectl`. You can also use the following command: +Download the appropriate binary file for your architecture, `stackablectl-x86_64-unknown-linux-gnu` for Intel-based devices or +`stackablectl-aarch64-unknown-linux-gnu` for ARM-based devices from the link:{latest-release}[latest release], +then rename the file to `stackablectl`. You can also use the following command: + +*x86_64* (amd64): [source,console] ---- $ curl -L -o stackablectl https://github.com/stackabletech/stackable-cockpit/releases/download/stackablectl-24.7.0/stackablectl-x86_64-unknown-linux-gnu -# or +---- + +**aarch64** (arm64): + +[source,console] +---- $ curl -L -o stackablectl https://github.com/stackabletech/stackable-cockpit/releases/download/stackablectl-24.7.0/stackablectl-aarch64-unknown-linux-gnu ---- @@ -38,14 +46,21 @@ Then, make sure it is present in your `$PATH`, like `/usr/local/bin`. macOS:: + -- -Download the `stackablectl-x86_64-apple-darwin` binary file for Intel-based devices or the -`stackablectl-aarch64-apple-darwin` binary file for ARM-based devices from the link:{latest-release}[latest release], +Download the appropriate binary file for your architecture, `stackablectl-x86_64-apple-darwin` for Intel-based devices or +`stackablectl-aarch64-apple-darwin` for ARM-based devices from the link:{latest-release}[latest release], then rename the file to `stackablectl`. You can also use the following command: +*x86_64* (amd64): + [source,console] ---- $ curl -L -o stackablectl https://github.com/stackabletech/stackable-cockpit/releases/download/stackablectl-24.7.0/stackablectl-x86_64-apple-darwin -# or +---- + +**aarch64** (arm64): + +[source,console] +---- $ curl -L -o stackablectl https://github.com/stackabletech/stackable-cockpit/releases/download/stackablectl-24.7.0/stackablectl-aarch64-apple-darwin ---- From 76564777ea75fc1e88eed0d04227402de95e3d4d Mon Sep 17 00:00:00 2001 From: Nick Larsen Date: Wed, 14 Aug 2024 12:24:06 +0200 Subject: [PATCH 2/2] docs(stackablectl): simplify install commands --- .../stackablectl/pages/installation.adoc | 36 ++++++++++++++++--- 1 file changed, 31 insertions(+), 5 deletions(-) diff --git a/docs/modules/stackablectl/pages/installation.adoc b/docs/modules/stackablectl/pages/installation.adoc index 0f279249..7c55400f 100644 --- a/docs/modules/stackablectl/pages/installation.adoc +++ b/docs/modules/stackablectl/pages/installation.adoc @@ -33,14 +33,21 @@ $ curl -L -o stackablectl https://github.com/stackabletech/stackable-cockpit/rel $ curl -L -o stackablectl https://github.com/stackabletech/stackable-cockpit/releases/download/stackablectl-24.7.0/stackablectl-aarch64-unknown-linux-gnu ---- -Mark the binary as executable: +Install the binary into a directory in the `$PATH`, and make it executable: + +NOTE: If you have a directory in your `$HOME` for user binaries, you can remove `sudo`, and change the directory to that. [source,console] ---- -$ chmod +x stackablectl +$ sudo install -m 755 -t /usr/local/bin stackablectl ---- -Then, make sure it is present in your `$PATH`, like `/usr/local/bin`. +Test that it works: + +[source,console] +---- +$ stackablectl --version +---- -- macOS:: @@ -64,15 +71,27 @@ $ curl -L -o stackablectl https://github.com/stackabletech/stackable-cockpit/rel $ curl -L -o stackablectl https://github.com/stackabletech/stackable-cockpit/releases/download/stackablectl-24.7.0/stackablectl-aarch64-apple-darwin ---- -Mark the binary as executable: +Install the binary into a directory in the `$PATH`, and make it executable: + +NOTE: If you have a directory in your `$HOME` for user binaries, you can remove `sudo`, and change the directory to that. + +[source,console] +---- +$ sudo install -m 755 -t /usr/local/bin stackablectl +---- + +Test that it works: [source,console] ---- -$ chmod +x stackablectl +$ stackablectl --version ---- +[TIP] +==== If macOS denies the execution of `stackablectl` go to Settings -> Security & Privacy -> General. Here you will see a pop up asking if you want to allow access for `stackablectl`. You must allow access. +==== -- Windows:: @@ -108,6 +127,13 @@ access it from anywhere if you like: $ cp target/release/stackablectl /usr/local/bin ---- +Test that it works: + +[source,console] +---- +$ stackablectl --version +---- + [#shell-comps] == Shell Completions