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.

Sign up for GitHub

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

GH-1787 -- updated mithril documentation #1788

Merged
merged 2 commits into from
Jul 26, 2024
Merged

GH-1787 -- updated mithril documentation #1788

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c68e907
GH-1787 -- updated mithril documentation
gmoratorio Jul 26, 2024
8c9f100
GH-1787 -- revert whitespace formatting changes
gmoratorio Jul 26, 2024
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
26 changes: 13 additions & 13 deletions docs/Mithril/mithril-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix flag (-u is to skip update, -e is for env setup)

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.
Expand All @@ -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).
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Clarified instructions for nginx install of mithril-relay.sh script


```bash
./mithril-relay.sh -d
./mithril-relay.sh -l
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix flag (-d is to deploy service, -l loadbalancer setup)


nInstalling nginx load balancer
Installing nginx load balancer
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix typo

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
Expand All @@ -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.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Clarify instructions


```bash
./mithril-signer.sh -u
./mithril-signer.sh -e
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix flag (-u is to skip update, -e is for env setup)

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.
Expand Down