diff --git a/doc/DOCKER_advanced_setups.md b/doc/DOCKER_advanced_setups.md index 36bd1ac..a463267 100644 --- a/doc/DOCKER_advanced_setups.md +++ b/doc/DOCKER_advanced_setups.md @@ -9,6 +9,7 @@ A word of caution, though, the default values of these options try to maximize y ## Table of Content ## - [Local indexer of Bitcoin addresses](#local_indexer) - [Local Electrum server used as data source for imports/rescans](#local_electrum) +- [Local Whirlpool client](#local_whirlpool) - [External Bitcoin full node](#external_bitcoind) - [bitcoind RPC API ans ZMQ notifications exposed to external apps](#exposed_rpc_zmq) - [Static onion address for bitcoind hidden service](#static_onion) @@ -117,6 +118,64 @@ nano ./conf/docker-node.conf ``` + + +## Local Whirlpool client ## + +This setup allows to install and run a [Whirlpool client](https://github.com/Samourai-Wallet/whirlpool-client-cli) inside MyDojo. + +Note: In order to interact with the Whirlpool client, you'll need to install the [Whirlpool GUI application]((https://github.com/Samourai-Wallet/whirlpool-gui)) on a computer (either the machine running MyDojo or any computer connected to your LAN). + + +### Procedure ### + +``` +# If you're installing a new Dojo or if you're upgrading from a Dojo version < 1.6, edit the docker-whirlpool.conf.tpl file +nano ./conf/docker-whirlpool.conf.tpl + +# Otherwise, edit the docker-whirlpool.conf file +nano ./conf/docker-whirlpool.conf + +# +# Set the value of WHIRLPOOL_INSTALL to "on" +# If you plan to run whirlpool-gui on a machine than isn't the machine running MyDojo, set the value of WHIRLPOOL_RPC_EXTERNAL_IP with the IP address of the machine hosting MyDojo. Do not use the public IP address of the machine, use its address on your LAN (192.168.xXX.xxx). +# Save and exit nano +# +``` + +### Initialization with Whirlppol GUI ### + +These steps describe how to connect the Whirlpool GUI application ([whirlpool-gui](https://github.com/Samourai-Wallet/whirlpool-gui/releases)) to your Whirlpool client. + + +**Requirements** + +- MyDojo has been fully initialized, +- Whirlpool client has been activated in MyDojo, +- Your Samourai Wallet is paired to MyDojo, +- MyDojo is running. + + +**Procedure** + +``` +# Install the Whirlpool GUI application on a computer and launch it. + +# Select 'Connect to remote CLI'. +# Insert the value of WHIRLPOOL_RPC_EXTERNAL_IP in the first block +# For example, you should insert `https://172.30.1.8` if WHIRLPOOL_RPC_EXTERNAL_IP is set to `172.30.1.8` +# Keep the Port 8899 and API pairing key BLANK. Click 'Connect'. + +# Paste the pairing payload from your mobile device when prompted: +# Select the Samourai Wallet Menu (3 dots top right), +# Go to Settings -> Transactions -> Pair to Whirlpool GUI, +# Copy the payload and send to your main computer using any method you prefer, +# Paste the payload. + +# The GUI will restart and prompt for you to enter your Samourai Wallet passphrase. +# You are all set and ready to mix! +``` + ## External Bitcoin full node ##