diff --git a/docs/Scripts/mithril-client.md b/docs/Scripts/mithril-client.md index 2e4b1f960..32beab383 100644 --- a/docs/Scripts/mithril-client.md +++ b/docs/Scripts/mithril-client.md @@ -1,10 +1,37 @@ `mithril-client.sh` is a script to manage the Mithril client, a tool used to set up the Mithril client environment and manage downloading Mithril snapshots and stake distributions. The main features include: - **environment** - Creates a new `mithril.env` file with all the necessary environment variables for the Mithril client. -- **snapshot** - Download, list all or show a specific available Mithril snapshot. +- **cardano-db** - Download, list all or show a specific available Mithril snapshot. - **stake-distribution** - Download or list available Mithril stake distributions. - **-u** - Skip script update check. +## Usage + +```bash +Usage: bash [-u] [] +A script to run Cardano Mithril Client + +-u Skip script update check overriding UPDATE_CHECK value in env (must be first argument to script) + +Commands: +environment Manage mithril environment file + setup Setup mithril environment file + override Override default variable in the mithril environment file + update Update mithril environment file +cardano-db Interact with Cardano DB + download Download Cardano DB from Mithril snapshot + snapshot Interact with Mithril snapshots + list List available Mithril snapshots + json List availble Mithril snapshots in JSON format + show Show details of a Mithril snapshot + json Show details of a Mithril snapshot in JSON format +stake-distribution Interact with Mithril stake distributions + download Download latest stake distribution + list List available stake distributions + json Output latest Mithril snapshot in JSON format + +``` + ## Preparing a Relay or Block Producer Node To prepare a relay or block producer node, you should follow these steps: @@ -18,7 +45,7 @@ To prepare a relay or block producer node, you should follow these steps: 2. **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 ``` ## Investigating Available Snapshots @@ -28,16 +55,16 @@ 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 snapshot list - ./mithril-client.sh snapshot list json + ./mithril-client.sh cardano-dbsnapshot list + ./mithril-client.sh cardano-dbsnapshot 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 ` command, where `` is the digest of the snapshot. Add `json` at the end to get the output in JSON format. ```bash - ./mithril-client.sh snapshot show - ./mithril-client.sh snapshot show json - ./mithril-client.sh snapshot show json + ./mithril-client.sh cardano-dbsnapshot show + ./mithril-client.sh cardano-dbsnapshot show json + ./mithril-client.sh cardano-dbsnapshot show json ``` ## Managing Stake Distributions diff --git a/docs/Scripts/mithril-relay.md b/docs/Scripts/mithril-relay.md index a7713274a..01454779f 100644 --- a/docs/Scripts/mithril-relay.md +++ b/docs/Scripts/mithril-relay.md @@ -7,12 +7,13 @@ loadbalancer. It provides functionalities such as: ## Usage ```bash -Usage: mithril-relay.sh [-d] [-l] +bash [-d] [-l] [-u] [-h] +A script to setup Cardano Mithril relays -Options: - -d Install squid and configure as a relay - -l Install nginx and configure as a load balancer - -h Show this help text +-d Install squid and configure as a relay +-l Install nginx and configure as a load balancer +-u Skip update check +-h Show this help text ``` # Description diff --git a/docs/Scripts/mithril-signer.md b/docs/Scripts/mithril-signer.md index 1c846d433..4e28d4e6c 100644 --- a/docs/Scripts/mithril-signer.md +++ b/docs/Scripts/mithril-signer.md @@ -5,12 +5,17 @@ environment file to contain variables specific to the Mithril Signer. ## Usage ```bash -Usage: mithril-signer.sh [-d] [-u] - -Options: - -d Deploy mithril-signer as a systemd service - -u Update mithril environment file - -h Show this help text +Usage: bash [-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 +-D Run mithril-signer as a daemon +-e Update mithril environment file +-k Stop signer using SIGINT +-r Verify signer registration +-s Verify signer signature +-u Skip update check +-h Show this help text ``` # Description