Skip to content

Commit dfb1eea

Browse files
jpraynaudjpraynaud
authored
Merge pull request #2136 from input-output-hk/jpraynaud/2034-install-script-mithril-nodes
Feat: one line installation script for Mithril nodes
2 parents 8137305 + d75ab71 commit dfb1eea

24 files changed

+205
-66
lines changed

‎CHANGELOG.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ As a minor extension, we have adopted a slightly different versioning convention
1818
- **BREAKING** Remove the `network` field from the internal `CardanoDbBeacon` struct, Certificates of types `CardanoImmutableFilesFull`
1919
must have their hashes recomputed in order to stay valid (procedure detailed in the [`recompute-certificates-hash`](./docs/runbook/recompute-certificates-hash) runbook).
2020

21+
- Add a one line shell installation script for the Mithril nodes.
22+
2123
- Crates versions:
2224

2325
| Crate | Version |

‎docs/website/root/compiled-binaries.md‎

Lines changed: 0 additions & 16 deletions
This file was deleted.

‎docs/website/root/compiled-binaries.mdx‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
unlisted: true
3+
hide_title: true
4+
hide_table_of_contents: true
5+
---
6+
7+
import CodeBlock from "@theme/CodeBlock";
8+
9+
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_):
10+
11+
<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**`}
13+
</CodeBlock>
14+
15+
:::tip
16+
17+
You can also install the **{props.node}** binary for other distributions:
18+
19+
- use `-d unstable` for the **unstable** version
20+
- use `-d **DISTRIBUTION_VERSION**` for a specific distribution (e.g. `-d 2445.0`)
21+
22+
:::
23+
24+
:::info
25+
26+
The Linux binaries target `glibc`, and have a minimum requirement of `glibc 2.31` (compatible with `Ubuntu 20.04`
27+
or `Debian Bullseye`).
28+
29+
:::

‎docs/website/root/manual/develop/nodes/mithril-aggregator.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
sidebar_position: 1
33
---
44

5-
import CompiledBinaries from '../../../compiled-binaries.md'
5+
import CompiledBinaries from '../../../compiled-binaries.mdx'
66

77
# Mithril aggregator node
88

@@ -370,7 +370,7 @@ If you wish to delve deeper and access several levels of logs from the Mithril a
370370

371371
## Download the pre-built binary
372372

373-
<CompiledBinaries />
373+
<CompiledBinaries node="mithril-aggregator"/>
374374

375375
## Build and run the Docker container
376376

‎docs/website/root/manual/develop/nodes/mithril-client-library-wasm.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
sidebar_position: 5
33
---
44

5-
import CompiledBinaries from '../../../compiled-binaries.md'
6-
75
# Mithril client library WASM
86

97
:::info

‎docs/website/root/manual/develop/nodes/mithril-client-library.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
sidebar_position: 4
33
---
44

5-
import CompiledBinaries from '../../../compiled-binaries.md'
6-
75
# Mithril client library
86

97
:::info

‎docs/website/root/manual/develop/nodes/mithril-client.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
sidebar_position: 3
33
---
44

5-
import CompiledBinaries from '../../../compiled-binaries.md'
5+
import CompiledBinaries from '../../../compiled-binaries.mdx'
66

77
# Mithril client node
88

@@ -195,7 +195,7 @@ If you wish to delve deeper and access several levels of logs from the Mithril c
195195

196196
## Download the pre-built binary
197197

198-
<CompiledBinaries />
198+
<CompiledBinaries node="mithril-client"/>
199199

200200
## Run a Docker container
201201

‎docs/website/root/manual/develop/nodes/mithril-signer.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
sidebar_position: 2
33
---
44

5-
import CompiledBinaries from '../../../compiled-binaries.md'
5+
import CompiledBinaries from '../../../compiled-binaries.mdx'
66

77
# Mithril signer node
88

@@ -206,7 +206,7 @@ If you wish to delve deeper and access several levels of logs from the Mithril s
206206
207207
## Download the pre-built binary
208208
209-
<CompiledBinaries />
209+
<CompiledBinaries node="mithril-signer"/>
210210
211211
## Build and run a Docker container
212212

‎docs/website/root/manual/getting-started/bootstrap-cardano-node.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
sidebar_position: 3
33
---
44

5-
import CompiledBinaries from '../../compiled-binaries.md'
5+
import CompiledBinaries from '../../compiled-binaries.mdx'
66

77
# Bootstrap a Cardano node
88

@@ -158,7 +158,7 @@ If you wish to delve deeper and access several levels of logs from the Mithril c
158158

159159
## Download the pre-built binary
160160

161-
<CompiledBinaries />
161+
<CompiledBinaries node="mithril-client"/>
162162

163163
## Run the Docker container
164164

‎docs/website/root/manual/getting-started/prerequisites.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ sidebar_position: 1
33
---
44

55
import NetworksMatrix from '../../networks-matrix.md';
6-
import CompiledBinaries from '../../compiled-binaries.md'
76

87
# Prerequisites
98

0 commit comments

Comments
 (0)