Skip to content
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

Update Mithril Documentation #1852

Merged
merged 1 commit into from
Feb 23, 2025
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
8 changes: 7 additions & 1 deletion docs/Mithril/mithril-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,13 +85,19 @@ variables for the Mithril client.
./mithril-client.sh environment setup
```

* Override a default variable in the Mithril environment file: Run the script with the environment override <VARIABLE> <VALUE> command to override a default variable in the mithril.env file.

```bash
./mithril-client.sh environment override <VARIABLE> <VALUE>
```

3. **Download the latest Mithril snapshot:** Once the environment file is set up, you
can download the latest Mithril snapshot by running the script with the `snapshot
download` command. This snapshot contains the latest state of the Cardano blockchain db
from a Mithril Aggregator.

```bash
./mithril-client.sh snapshot download
./mithril-client.sh cardano-db download
```

### Participating in Mithril Network
Expand Down
11 changes: 5 additions & 6 deletions docs/Scripts/mithril-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
## Usage

```bash
Usage: bash [-u] <command> <subcommand> [<sub arg>]
Usage: mithril-client.sh [-u] <command> <subcommand> [<sub arg>]
A script to run Cardano Mithril Client

-u Skip script update check overriding UPDATE_CHECK value in env (must be first argument to script)
Expand Down Expand Up @@ -55,16 +55,15 @@ You can investigate the available snapshots by using the `snapshot list` and `sn
- **List all available Mithril snapshots:** You can list all available Mithril snapshots by running the script with the `snapshot list` command. Add `json` at the end to get the output in JSON format.

```bash
./mithril-client.sh cardano-dbsnapshot list
./mithril-client.sh cardano-dbsnapshot list json
./mithril-client.sh cardano-db snapshot list
./mithril-client.sh cardano-db snapshot list json
```

- **Show details of a specific Mithril snapshot:** You can show details of a specific Mithril snapshot by running the script with the `snapshot show <DIGEST>` command, where `<DIGEST>` is the digest of the snapshot. Add `json` at the end to get the output in JSON format.

```bash
./mithril-client.sh cardano-dbsnapshot show <DIGEST>
./mithril-client.sh cardano-dbsnapshot show <DIGEST> json
./mithril-client.sh cardano-dbsnapshot show json <DIGEST>
./mithril-client.sh cardano-db snapshot show <DIGEST>
./mithril-client.sh cardano-db snapshot show <DIGEST> json
```

## Managing Stake Distributions
Expand Down
3 changes: 2 additions & 1 deletion docs/Scripts/mithril-relay.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,13 @@ loadbalancer. It provides functionalities such as:
## Usage

```bash
bash [-d] [-l] [-u] [-h]
mithril-relay.sh [-d] [-l] [-u] [-h]
A script to setup Cardano Mithril relays

-d Install squid and configure as a relay
-l Install nginx and configure as a load balancer
-u Skip update check
-s Stop relays
-h Show this help text
```

Expand Down
2 changes: 1 addition & 1 deletion docs/Scripts/mithril-signer.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ environment file to contain variables specific to the Mithril Signer.
## Usage

```bash
Usage: bash [-d] [-D] [-e] [-k] [-r] [-s] [-u] [-h]
Usage: mithril-signer.sh [-d] [-D] [-e] [-k] [-r] [-s] [-u] [-h]
A script to setup, run and verify Cardano Mithril Signer

-d Deploy mithril-signer as a systemd service
Expand Down
1 change: 1 addition & 0 deletions scripts/cnode-helper-scripts/mithril-relay.sh
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ usage() {
-d Install squid and configure as a relay
-l Install nginx and configure as a load balancer
-u Skip update check
-s Stop relays
-h Show this help text

EOF
Expand Down