From 2efbb5a92f9003db96451cb06a76cc8660d6678e Mon Sep 17 00:00:00 2001 From: Jean-Philippe Raynaud Date: Mon, 25 Nov 2024 12:26:41 +0100 Subject: [PATCH 1/2] docs: add dev blog post for one line installer --- .../2024-11-25-one-line-binaries-installer.md | 64 +++++++++++++++++++ 1 file changed, 64 insertions(+) create mode 100644 docs/website/blog/2024-11-25-one-line-binaries-installer.md diff --git a/docs/website/blog/2024-11-25-one-line-binaries-installer.md b/docs/website/blog/2024-11-25-one-line-binaries-installer.md new file mode 100644 index 00000000000..56a5d21d6f7 --- /dev/null +++ b/docs/website/blog/2024-11-25-one-line-binaries-installer.md @@ -0,0 +1,64 @@ +--- +title: One line installer for Mithril binaries +authors: + - name: Mithril Team +tags: + [ + binaries, + pre-built, + install, + update, + nodes, + command-line, + binaries, + installer, + ] +--- + +### One line installer for Mithril binaries + +In order to facilitate the installation and update of Mithril binaries, we have created a one line installer that downloads and installs the Mithril binaries for you. +This installer is available for Linux and MacOS, and for the Mithril signer, Mithril aggregator, and Mithril CLI. + +The one line command is also displayed in the several `Download the pre-built binary` sections across the documentation. + +Here are few examples of the one line installer: + +- Download the **latest Mithril signer** in the current directory: + +```bash +curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/input-output-hk/mithril/refs/heads/main/mithril-install.sh | sh -s -- -c mithril-signer -d latest -p $(pwd) +``` + +- Download the **latest Mithril client CLI** in the current directory: + +```bash +curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/input-output-hk/mithril/refs/heads/main/mithril-install.sh | sh -s -- -c mithril-client -d latest -p $(pwd) +``` + +- Download the **unstable Mithril aggregator** in the current directory: + +```bash +curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/input-output-hk/mithril/refs/heads/main/mithril-install.sh | sh -s -- -c mithril-aggregator -d unstable -p $(pwd) +``` + +- Download the **Mithril client of distribution `2445.0`** in the current directory: + +```bash +curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/input-output-hk/mithril/refs/heads/main/mithril-install.sh | sh -s -- -c mithril-client -d 2445.0 -p $(pwd) +``` + +- Installer usage: + +```bash +curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/input-output-hk/mithril/refs/heads/main/mithril-install.sh | sh -s -- -h + +Install or upgrade a Mithril node +Usage: sh [-n node] [-v version] [-d distribution] [-p path] + -c node : Mithril node to install or upgrade (mithril-signer, mithril-aggregator, mithril-client) + -d distribution : Distribution to upgrade to (latest, unstable or distribution version e.g '2445.0') + -p path : Path to install the component + +``` + +For any inquiries or assistance, don't hesitate to reach out to the team on the [Discord channel](https://discord.gg/5kaErDKDRq). From 3aaf496b87cc71f4d70047f19677c16bb9abae88 Mon Sep 17 00:00:00 2001 From: Jean-Philippe Raynaud Date: Mon, 25 Nov 2024 13:22:14 +0100 Subject: [PATCH 2/2] fix: props value not displaying correctly in code boxes of compiled binaries component --- docs/website/root/compiled-binaries.mdx | 4 +++- .../versioned_docs/version-maintained/compiled-binaries.mdx | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/website/root/compiled-binaries.mdx b/docs/website/root/compiled-binaries.mdx index 3374ff44067..033b1c7e2f7 100644 --- a/docs/website/root/compiled-binaries.mdx +++ b/docs/website/root/compiled-binaries.mdx @@ -9,7 +9,9 @@ import CodeBlock from "@theme/CodeBlock"; You can install a the **latest** released binary of the **{props.node}** by running this one line command (_replace **YOUR_PATH** with your installation path_): - {`curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/input-output-hk/mithril/refs/heads/main/mithril-install.sh | sh -s -- -c {props.node} -d latest -p **YOUR_PATH**`} + curl --proto '=https' --tlsv1.2 -sSf + https://raw.githubusercontent.com/input-output-hk/mithril/refs/heads/main/mithril-install.sh + | sh -s -- -c {props.node} -d latest -p **YOUR_PATH** :::tip diff --git a/docs/website/versioned_docs/version-maintained/compiled-binaries.mdx b/docs/website/versioned_docs/version-maintained/compiled-binaries.mdx index 3374ff44067..033b1c7e2f7 100644 --- a/docs/website/versioned_docs/version-maintained/compiled-binaries.mdx +++ b/docs/website/versioned_docs/version-maintained/compiled-binaries.mdx @@ -9,7 +9,9 @@ import CodeBlock from "@theme/CodeBlock"; You can install a the **latest** released binary of the **{props.node}** by running this one line command (_replace **YOUR_PATH** with your installation path_): - {`curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/input-output-hk/mithril/refs/heads/main/mithril-install.sh | sh -s -- -c {props.node} -d latest -p **YOUR_PATH**`} + curl --proto '=https' --tlsv1.2 -sSf + https://raw.githubusercontent.com/input-output-hk/mithril/refs/heads/main/mithril-install.sh + | sh -s -- -c {props.node} -d latest -p **YOUR_PATH** :::tip