From c68e907664d7c194c3ecbea1f64604ed1a67579d Mon Sep 17 00:00:00 2001 From: gmoratorio Date: Fri, 26 Jul 2024 13:52:52 -0600 Subject: [PATCH 1/2] GH-1787 -- updated mithril documentation --- docs/Mithril/mithril-overview.md | 56 ++++++++++++++++---------------- 1 file changed, 28 insertions(+), 28 deletions(-) diff --git a/docs/Mithril/mithril-overview.md b/docs/Mithril/mithril-overview.md index 63174ee6f..7157f82bc 100644 --- a/docs/Mithril/mithril-overview.md +++ b/docs/Mithril/mithril-overview.md @@ -4,20 +4,20 @@ in setting up and managing the: - [Mithril Client](https://mithril.network/doc/mithril/mithril-network/client) to -download a snapshot for the given network the node is attached to via the -[mithril-client.sh](../Scripts/mithril-client.md) script. + download a snapshot for the given network the node is attached to via the + [mithril-client.sh](../Scripts/mithril-client.md) script. - [Mithril Signer](https://mithril.network/doc/mithril/mithril-network/signer) to -participate in the creation of stake based singatures of snapshots via the -[mithril-signer.sh](../Scripts/mithril-signer.md) script. + participate in the creation of stake based singatures of snapshots via the + [mithril-signer.sh](../Scripts/mithril-signer.md) script. - Squid Mithril Relay to provide a relay for submitting the snapshots signatures to a -Mithril Aggregator, as described in [Run a Mithril signer as an -SPO](https://mithril.network/doc/manual/getting-started/run-signer-node) documentation -via the [mithril-relay.sh](../Scripts/mithril-relay.md) script. + Mithril Aggregator, as described in [Run a Mithril signer as an + SPO](https://mithril.network/doc/manual/getting-started/run-signer-node) documentation + via the [mithril-relay.sh](../Scripts/mithril-relay.md) script. The `env` file contains a new environment variable `MITHRIL_DOWNLOAD` that when enabled allows the `cnode.sh` script to automatically download the latest Mithril snapshot if -the local `db` directory is empty. This is useful for new nodes that need to be +the local `db` directory is empty. This is useful for new nodes that need to be bootstrapped with the latest snapshot to avoid synchronizing the entire blockchain from scratch. While also providing a high level of trust that the snapshot is valid since it is signed by multiple pool operators. @@ -74,21 +74,21 @@ snapshots, or show details of a specific snapshot. To bootstrap a Cardano node using the Mithril client, follow these steps: 1. **Setup the Cardano Node:** Use the guild tools to setup the Cardano node, either by -building the binaries or using pre-compiled binaries. Follow the instructions in the -[guild-operators documentation](https://cardano-community.github.io/guild-operators/Build/node-cli/). + building the binaries or using pre-compiled binaries. Follow the instructions in the + [guild-operators documentation](https://cardano-community.github.io/guild-operators/Build/node-cli/). 2. **Create the Mithril environment file:** Run the script with the `environment setup` -command. This will create a new `mithril.env` file with all the necessary environment -variables for the Mithril client. + command. This will create a new `mithril.env` file with all the necessary environment + variables for the Mithril client. ```bash ./mithril-client.sh environment setup ``` 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. + 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 @@ -143,13 +143,13 @@ steps: 1. **Deploy the Mithril Signer:** Run the `mithril-signer.sh` script: - 1. Use the `-u` flag to update the `mithril.env` file with the Mithril + 1. Use the `-e` flag to update the `mithril.env` file with the Mithril Signer environment variables. 2. Provide the IP address of your Mithril Relay when prompted. 3. Optionally provide the relays listening port when prompted to use a port. ```bash - ./mithril-signer.sh -u + ./mithril-signer.sh -e Enter the IP address of the relay endpoint: 4.5.6.7 Enter the port of the relay endpoint (press Enter to use default 3132): Using RELAY_ENDPOINT=4.5.6.7:3132 for the Mithril signer relay endpoint. @@ -174,17 +174,17 @@ steps: 1. **Deploy the Nginx sidecar loadbalancer:** Run the `mithril-relay.sh` script: 1. Use the `-l` flag to deploy the Nginx Mithril Relay. - 2. Provide the IP address of your Block Producer when prompted to secure - the Mithril Relay to only accept traffic from your Block Producer. - 3. Optionally provide the relays listening port when prompted to use a port + 2. Provide the IP address of your Mithril Relay(s) when prompted. + 3. Provide an IP address for your nginx loadbalancer (default 127.0.0.1) + 4. Optionally provide the relays listening port when prompted to use a port other than the default 3132, or just press enter to use the default. - 4. Create the appropriate firewall rule to allow traffic from your Block - Producer to the Mithril Relay. + 5. Create the appropriate firewall rule to allow traffic from your Block + Producer to the Mithril Relay(s). ```bash - ./mithril-relay.sh -d + ./mithril-relay.sh -l - nInstalling nginx load balancer + Installing nginx load balancer Enter the IP address of a relay: 4.5.6.7 Are there more relays? (y/n) y Enter the IP address of a relay: 8.9.10.11 @@ -204,13 +204,13 @@ steps: 2. **Deploy the Mithril Signer:** Run the `mithril-signer.sh` script: - 1. Use the `-u` flag to update the `mithril.env` file with the Mithril + 1. Use the `-e` flag to update the `mithril.env` file with the Mithril Signer environment variables. - 2. Provide the IP address of your Mithril Relay when prompted. - 3. Optionally provide the relays listening port when prompted to use a port. + 2. Provide the IP address of your nginx loadbalancer when prompted. + 3. Optionally provide the loadbalancer listening port when prompted to use a port. ```bash - ./mithril-signer.sh -u + ./mithril-signer.sh -e Enter the IP address of the relay endpoint: 127.0.0.1 Enter the port of the relay endpoint (press Enter to use default 3132): Using RELAY_ENDPOINT=127.0.0.1:3132 for the Mithril signer relay endpoint. From 8c9f100674b85216ecd2f5928c89c5d031ac69d1 Mon Sep 17 00:00:00 2001 From: gmoratorio Date: Fri, 26 Jul 2024 14:12:13 -0600 Subject: [PATCH 2/2] GH-1787 -- revert whitespace formatting changes --- docs/Mithril/mithril-overview.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/Mithril/mithril-overview.md b/docs/Mithril/mithril-overview.md index 7157f82bc..e9116926b 100644 --- a/docs/Mithril/mithril-overview.md +++ b/docs/Mithril/mithril-overview.md @@ -4,20 +4,20 @@ in setting up and managing the: - [Mithril Client](https://mithril.network/doc/mithril/mithril-network/client) to - download a snapshot for the given network the node is attached to via the - [mithril-client.sh](../Scripts/mithril-client.md) script. +download a snapshot for the given network the node is attached to via the +[mithril-client.sh](../Scripts/mithril-client.md) script. - [Mithril Signer](https://mithril.network/doc/mithril/mithril-network/signer) to - participate in the creation of stake based singatures of snapshots via the - [mithril-signer.sh](../Scripts/mithril-signer.md) script. +participate in the creation of stake based singatures of snapshots via the +[mithril-signer.sh](../Scripts/mithril-signer.md) script. - Squid Mithril Relay to provide a relay for submitting the snapshots signatures to a - Mithril Aggregator, as described in [Run a Mithril signer as an - SPO](https://mithril.network/doc/manual/getting-started/run-signer-node) documentation - via the [mithril-relay.sh](../Scripts/mithril-relay.md) script. +Mithril Aggregator, as described in [Run a Mithril signer as an +SPO](https://mithril.network/doc/manual/getting-started/run-signer-node) documentation +via the [mithril-relay.sh](../Scripts/mithril-relay.md) script. The `env` file contains a new environment variable `MITHRIL_DOWNLOAD` that when enabled allows the `cnode.sh` script to automatically download the latest Mithril snapshot if -the local `db` directory is empty. This is useful for new nodes that need to be +the local `db` directory is empty. This is useful for new nodes that need to be bootstrapped with the latest snapshot to avoid synchronizing the entire blockchain from scratch. While also providing a high level of trust that the snapshot is valid since it is signed by multiple pool operators. @@ -74,21 +74,21 @@ snapshots, or show details of a specific snapshot. To bootstrap a Cardano node using the Mithril client, follow these steps: 1. **Setup the Cardano Node:** Use the guild tools to setup the Cardano node, either by - building the binaries or using pre-compiled binaries. Follow the instructions in the - [guild-operators documentation](https://cardano-community.github.io/guild-operators/Build/node-cli/). +building the binaries or using pre-compiled binaries. Follow the instructions in the +[guild-operators documentation](https://cardano-community.github.io/guild-operators/Build/node-cli/). 2. **Create the Mithril environment file:** Run the script with the `environment setup` - command. This will create a new `mithril.env` file with all the necessary environment - variables for the Mithril client. +command. This will create a new `mithril.env` file with all the necessary environment +variables for the Mithril client. ```bash ./mithril-client.sh environment setup ``` 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. +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