Skip to content

Feat: one line installation script for Mithril nodes #2136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Nov 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ As a minor extension, we have adopted a slightly different versioning convention
- **BREAKING** Remove the `network` field from the internal `CardanoDbBeacon` struct, Certificates of types `CardanoImmutableFilesFull`
must have their hashes recomputed in order to stay valid (procedure detailed in the [`recompute-certificates-hash`](./docs/runbook/recompute-certificates-hash) runbook).

- Add a one line shell installation script for the Mithril nodes.

- Crates versions:

| Crate | Version |
Expand Down
16 changes: 0 additions & 16 deletions docs/website/root/compiled-binaries.md

This file was deleted.

29 changes: 29 additions & 0 deletions docs/website/root/compiled-binaries.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
unlisted: true
hide_title: true
hide_table_of_contents: true
---

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_):

<CodeBlock language="bash">
{`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**`}
</CodeBlock>

:::tip

You can also install the **{props.node}** binary for other distributions:

- use `-d unstable` for the **unstable** version
- use `-d **DISTRIBUTION_VERSION**` for a specific distribution (e.g. `-d 2445.0`)

:::

:::info

The Linux binaries target `glibc`, and have a minimum requirement of `glibc 2.31` (compatible with `Ubuntu 20.04`
or `Debian Bullseye`).

:::
4 changes: 2 additions & 2 deletions docs/website/root/manual/develop/nodes/mithril-aggregator.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebar_position: 1
---

import CompiledBinaries from '../../../compiled-binaries.md'
import CompiledBinaries from '../../../compiled-binaries.mdx'

# Mithril aggregator node

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

## Download the pre-built binary

<CompiledBinaries />
<CompiledBinaries node="mithril-aggregator"/>

## Build and run the Docker container

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
sidebar_position: 5
---

import CompiledBinaries from '../../../compiled-binaries.md'

# Mithril client library WASM

:::info
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
sidebar_position: 4
---

import CompiledBinaries from '../../../compiled-binaries.md'

# Mithril client library

:::info
Expand Down
4 changes: 2 additions & 2 deletions docs/website/root/manual/develop/nodes/mithril-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebar_position: 3
---

import CompiledBinaries from '../../../compiled-binaries.md'
import CompiledBinaries from '../../../compiled-binaries.mdx'

# Mithril client node

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

## Download the pre-built binary

<CompiledBinaries />
<CompiledBinaries node="mithril-client"/>

## Run a Docker container

Expand Down
4 changes: 2 additions & 2 deletions docs/website/root/manual/develop/nodes/mithril-signer.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebar_position: 2
---

import CompiledBinaries from '../../../compiled-binaries.md'
import CompiledBinaries from '../../../compiled-binaries.mdx'

# Mithril signer node

Expand Down Expand Up @@ -206,7 +206,7 @@ If you wish to delve deeper and access several levels of logs from the Mithril s

## Download the pre-built binary

<CompiledBinaries />
<CompiledBinaries node="mithril-signer"/>

## Build and run a Docker container

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebar_position: 3
---

import CompiledBinaries from '../../compiled-binaries.md'
import CompiledBinaries from '../../compiled-binaries.mdx'

# Bootstrap a Cardano node

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

## Download the pre-built binary

<CompiledBinaries />
<CompiledBinaries node="mithril-client"/>

## Run the Docker container

Expand Down
1 change: 0 additions & 1 deletion docs/website/root/manual/getting-started/prerequisites.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ sidebar_position: 1
---

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

# Prerequisites

Expand Down
2 changes: 0 additions & 2 deletions docs/website/root/manual/operate/become-mithril-spo.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
sidebar_position: 1
---

import CompiledBinaries from '../../compiled-binaries.md'

# Become a Mithril SPO

## The journey with Mithril toward `mainnet`
Expand Down
4 changes: 2 additions & 2 deletions docs/website/root/manual/operate/run-signer-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebar_position: 3
---

import CompiledBinaries from '../../compiled-binaries.md'
import CompiledBinaries from '../../compiled-binaries.mdx'

# Run a Mithril signer node

Expand Down Expand Up @@ -202,7 +202,7 @@ make build

### Download the pre-built binary

<CompiledBinaries />
<CompiledBinaries node="mithril-signer"/>

### Verifying the binary

Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
unlisted: true
hide_title: true
hide_table_of_contents: true
---

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_):

<CodeBlock language="bash">
{`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**`}
</CodeBlock>

:::tip

You can also install the **{props.node}** binary for other distributions:

- use `-d unstable` for the **unstable** version
- use `-d **DISTRIBUTION_VERSION**` for a specific distribution (e.g. `-d 2445.0`)

:::

:::info

The Linux binaries target `glibc`, and have a minimum requirement of `glibc 2.31` (compatible with `Ubuntu 20.04`
or `Debian Bullseye`).

:::
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebar_position: 1
---

import CompiledBinaries from '../../../compiled-binaries.md'
import CompiledBinaries from '../../../compiled-binaries.mdx'

# Mithril aggregator node

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

## Download the pre-built binary

<CompiledBinaries />
<CompiledBinaries node="mithril-aggregator"/>

## Build and run the Docker container

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
sidebar_position: 5
---

import CompiledBinaries from '../../../compiled-binaries.md'

# Mithril client library WASM

:::info
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
sidebar_position: 4
---

import CompiledBinaries from '../../../compiled-binaries.md'

# Mithril client library

:::info
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebar_position: 3
---

import CompiledBinaries from '../../../compiled-binaries.md'
import CompiledBinaries from '../../../compiled-binaries.mdx'

# Mithril client node

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

## Download the pre-built binary

<CompiledBinaries />
<CompiledBinaries node="mithril-client"/>

## Run a Docker container

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebar_position: 2
---

import CompiledBinaries from '../../../compiled-binaries.md'
import CompiledBinaries from '../../../compiled-binaries.mdx'

# Mithril signer node

Expand Down Expand Up @@ -206,7 +206,7 @@ If you wish to delve deeper and access several levels of logs from the Mithril s

## Download the pre-built binary

<CompiledBinaries />
<CompiledBinaries node="mithril-signer"/>

## Build and run a Docker container

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebar_position: 3
---

import CompiledBinaries from '../../compiled-binaries.md'
import CompiledBinaries from '../../compiled-binaries.mdx'

# Bootstrap a Cardano node

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

## Download the pre-built binary

<CompiledBinaries />
<CompiledBinaries node="mithril-client"/>

## Run the Docker container

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ sidebar_position: 1
---

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

# Prerequisites

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
sidebar_position: 1
---

import CompiledBinaries from '../../compiled-binaries.md'

# Become a Mithril SPO

## The journey with Mithril toward `mainnet`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebar_position: 3
---

import CompiledBinaries from '../../compiled-binaries.md'
import CompiledBinaries from '../../compiled-binaries.mdx'

# Run a Mithril signer node

Expand Down Expand Up @@ -202,7 +202,7 @@ make build

### Download the pre-built binary

<CompiledBinaries />
<CompiledBinaries node="mithril-signer"/>

### Verifying the binary

Expand Down
Loading