Skip to content

Commit ad40680

Browse files
authored
Merge pull request #2139 from input-output-hk/jpraynaud/2034-dev-blog-post-one-line-installer
Docs: dev blog post for one line installer
2 parents 901f130 + 3aaf496 commit ad40680

File tree

3 files changed

+70
-2
lines changed

3 files changed

+70
-2
lines changed
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
title: One line installer for Mithril binaries
3+
authors:
4+
- name: Mithril Team
5+
tags:
6+
[
7+
binaries,
8+
pre-built,
9+
install,
10+
update,
11+
nodes,
12+
command-line,
13+
binaries,
14+
installer,
15+
]
16+
---
17+
18+
### One line installer for Mithril binaries
19+
20+
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.
21+
This installer is available for Linux and MacOS, and for the Mithril signer, Mithril aggregator, and Mithril CLI.
22+
23+
The one line command is also displayed in the several `Download the pre-built binary` sections across the documentation.
24+
25+
Here are few examples of the one line installer:
26+
27+
- Download the **latest Mithril signer** in the current directory:
28+
29+
```bash
30+
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)
31+
```
32+
33+
- Download the **latest Mithril client CLI** in the current directory:
34+
35+
```bash
36+
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)
37+
```
38+
39+
- Download the **unstable Mithril aggregator** in the current directory:
40+
41+
```bash
42+
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)
43+
```
44+
45+
- Download the **Mithril client of distribution `2445.0`** in the current directory:
46+
47+
```bash
48+
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)
49+
```
50+
51+
- Installer usage:
52+
53+
```bash
54+
curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/input-output-hk/mithril/refs/heads/main/mithril-install.sh | sh -s -- -h
55+
56+
Install or upgrade a Mithril node
57+
Usage: sh [-n node] [-v version] [-d distribution] [-p path]
58+
-c node : Mithril node to install or upgrade (mithril-signer, mithril-aggregator, mithril-client)
59+
-d distribution : Distribution to upgrade to (latest, unstable or distribution version e.g '2445.0')
60+
-p path : Path to install the component
61+
62+
```
63+
64+
For any inquiries or assistance, don't hesitate to reach out to the team on the [Discord channel](https://discord.gg/5kaErDKDRq).

docs/website/root/compiled-binaries.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ import CodeBlock from "@theme/CodeBlock";
99
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_):
1010

1111
<CodeBlock language="bash">
12-
{`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**`}
12+
curl --proto '=https' --tlsv1.2 -sSf
13+
https://raw.githubusercontent.com/input-output-hk/mithril/refs/heads/main/mithril-install.sh
14+
| sh -s -- -c {props.node} -d latest -p **YOUR_PATH**
1315
</CodeBlock>
1416

1517
:::tip

docs/website/versioned_docs/version-maintained/compiled-binaries.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ import CodeBlock from "@theme/CodeBlock";
99
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_):
1010

1111
<CodeBlock language="bash">
12-
{`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**`}
12+
curl --proto '=https' --tlsv1.2 -sSf
13+
https://raw.githubusercontent.com/input-output-hk/mithril/refs/heads/main/mithril-install.sh
14+
| sh -s -- -c {props.node} -d latest -p **YOUR_PATH**
1315
</CodeBlock>
1416

1517
:::tip

0 commit comments

Comments
 (0)