Skip to content

Commit 3a77d06

Browse files
committed
wip(website): add DMQ node setup in Mithril signer guide
1 parent 8a4bfdb commit 3a77d06

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

docs/website/root/manual/operate/run-signer-node.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,10 +99,12 @@ Note that this guide works on a Linux machine only.
9999
:::
100100

101101
- To operate a **Cardano node** as a **stake pool**, you need:
102+
102103
- The pool's `operational certificate`
103104
- The pool's `KES secret key`
104105

105106
- To access the file system of the **Cardano block producer** node for **production** deployment (or of the **Cardano relay** node for **naive** deployment), you will need the following permissions:
107+
106108
- Read rights on the `Database` folder (specified by the `--database-path` setting of the **Cardano node**)
107109
- Read and write rights on the `Inter Process Communication` file (typically defined by the `CARDANO_NODE_SOCKET_PATH` environment variable used to launch the **Cardano node**)
108110

@@ -546,6 +548,7 @@ sudo systemctl restart mithril-signer
546548
:::info
547549
548550
- If you have already installed `Squid` via `apt` package manager, we recommend that you delete it before manually building it from source by running the following commands:
551+
549552
- `sudo systemctl stop squid`
550553
- `sudo apt remove squid`
551554
- `sudo apt autoremove`.
@@ -889,6 +892,53 @@ sudo service netfilter-persistent save
889892
890893
:::
891894
895+
## Setup the DMQ node (unstable)
896+
897+
:::caution
898+
899+
The DMQ node setup is currently **unstable** and not suitable for production use.
900+
901+
:::
902+
903+
The DMQ node supports the implementation of a **Decentralized Message Queue** (DMQ) for Mithril. The DMQ protocol allows Mithril signers to exchange signatures in a decentralized manner, enhancing the robustness and scalability of the Mithril networks. Once stabilized and deployed on a majority of SPOs on a Mithril network, the DMQ protocol will allow multiple aggregators to operate simultaneously, improving the overall availability of the Mithril protocol. The DMQ protocol is fully described in the [CIP-0137](https://cips.cardano.org/cip/CIP-0137).
904+
905+
### Download the pre-built binary
906+
907+
:::tip
908+
909+
You can use these parameters for the **pre-release-preview** network:
910+
911+
- **DMQ_RELEASE_URL**: `https://github.com/input-output-hk/mithril/raw/refs/heads/jpraynaud/dmq-node-binary/mithril-test-lab/mithril-devnet/bin/dmq-node-0.2.0.0-53bf9652787dc768abd86cf3844f1206f0fd7d8c`
912+
913+
This URL may change in the future; please refer to this page for the latest released version of the DMQ node binary.
914+
915+
:::
916+
917+
To download the latest released version of the DMQ node binary, run the following command:
918+
919+
```bash
920+
curl --fail -sL -o dmq-node **DMQ_RELEASE_URL**
921+
```
922+
923+
### Installing the service
924+
925+
#### Make the binary executable
926+
927+
To make the binary executable, run:
928+
929+
```bash
930+
chmod +x dmq-node
931+
```
932+
933+
#### Move the executable
934+
935+
To move the executable to /opt/mithril, run:
936+
937+
```bash
938+
sudo mkdir -p /opt/mithril
939+
sudo mv dmq-node /opt/mithril
940+
```
941+
892942
## Verify the Mithril signer deployment
893943
894944
:::tip

0 commit comments

Comments
 (0)