GH-1787 -- updated mithril documentation #1788
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gmoratorio
commented
Jul 26, 2024
| 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 |
There was a problem hiding this comment.
Fix flag (-u is to skip update, -e is for env setup)
gmoratorio
commented
Jul 26, 2024
|
|
||
| ```bash | ||
| ./mithril-signer.sh -u | ||
| ./mithril-signer.sh -e |
There was a problem hiding this comment.
Fix flag (-u is to skip update, -e is for env setup)
gmoratorio
commented
Jul 26, 2024
|
|
||
| ```bash | ||
| ./mithril-relay.sh -d | ||
| ./mithril-relay.sh -l |
There was a problem hiding this comment.
Fix flag (-d is to deploy service, -l loadbalancer setup)
gmoratorio
commented
Jul 26, 2024
| 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). |
There was a problem hiding this comment.
Clarified instructions for nginx install of mithril-relay.sh script
gmoratorio
commented
Jul 26, 2024
docs/Mithril/mithril-overview.md
Outdated
| 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. |
There was a problem hiding this comment.
I think these came through as auto-format changes from my IDE. I can revert these if desired.
gmoratorio
commented
Jul 26, 2024
|
|
||
| nInstalling nginx load balancer | ||
| Installing nginx load balancer |
gmoratorio
commented
Jul 26, 2024
| 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. |
There was a problem hiding this comment.
Clarify instructions
TrevorBenson
approved these changes
Jul 26, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Updates to
mithril-documentation.mdinstructions for setting up MithrilWhere should the reviewer start?
See new documentation changes
Motivation and context
Instructions were excellent, but slightly off in a few places. Updated for clarity.
Which issue it fixes?
closes GH-1787
How has this been tested?
Reads good!