lukechilds
/
umbrel-samourai-dojo
mirror of https://github.com/lukechilds/umbrel-samourai-dojo.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

update docs

use-env-var-docker
kenshin-samourai 5 years ago
parent
d3457f81cd
commit
3f1d461fce
2 changed files with 52 additions and 41 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 10
      doc/DOCKER_advanced_setups.md
  2. 83
      doc/DOCKER_setup.md

10
doc/DOCKER_advanced_setups.md
View File

@ -173,13 +173,13 @@ These steps describe how to install the Whirlpool GUI application how a computer
```
# If needed, install Tor browser on the computer that will run the Whirlpool GUI application
# Launch the Tor browser
# Install the Whirlpool GUI application on the computer and launch it.
# Install the Whirlpool GUI application on the computer and launch it
# Select 'Connect to remote CLI'.
# Insert the onion address of the Whirlpool API, **prefixed by HTTP**, in the first block
# Set the port to 80
# Let the API pairing key BLANK.
# Select 'Advanced: remote CLI'
# Set 'CLI address' with 'http://your_onion_address' where your_onion_address is the address of the Whirlpool API
# Check that the 'Tor proxy' field has the correct socks5 port used by your Tor browser (default should be ok).
# Click 'Connect'.
# Paste the pairing payload from your mobile device when prompted:

83
doc/DOCKER_setup.md
View File

@ -27,42 +27,41 @@ MyDojo is a set of Docker containers providing a full Samourai backend composed
## Architecture ##
------------------- ------------------- --------------------
| Samourai Wallet | | Sentinel | | Bitcoin full nodes |
------------------- ------------------- --------------------
|_______________________|_______________________|
|
------------
Tor network
------------
|
Host machine | (Tor hidden services)
______________________________ | _____________________________
| | |
| --------- dmznet |
| --------| Tor |------------ |
| | --------- | |
| | | |
| --------- | |
| --| Nginx |-------- | |
| | --------- | | |
|- - - - -|- - - - - - - - - - -|- - - - - - - - -|- - - - - - |
| | | | |
| ---------- ---------- ---------- |
| | Nodejs |----------| Explorer |------| Bitcoind | |
| ---------- ---------- ---------- |
| | | | | |
| | ------- | | |
| | | | | |
| ---------- | ---------- | |
| | MySQL | ----| Indexer |----------- |
| ---------- ---------- |
| dojonet |
|______________________________________________________________|
------------------ -------------------- --------------- -----------------------
| Mobile Wallets | | Bitcoin full nodes | | Whirlpool GUI | | Whirlpool Coordinator |
------------------ -------------------- --------------- -----------------------
|_______________________|____________________|_______________________|
|
-------------
| |
---------------------- | Tor network |
| | |
| ------------
| |
| | (Tor hidden services)
_____ | ____________________________ | _________________________________________
| | | | |
| | | --------- dmznet |
| | | -----------| Tor |------------------------ |
| | | | --------- | |
| | --------- | |
| | | nginx | - - - - - - - - - - - - - - - - - - - - - -|- - - - - - |
| | --------- | |
| | | | | | |
| | --- | ---------------------------- | |
| | | | | | | |
| ----------- | ---------- ---------- ---------- |
| | whirlpool | | | Nodejs |----------| Explorer |------| Bitcoind | |
| ----------- | ---------- ---------- ---------- |
| | | | | | |
| | | ------- | | |
| | | | | | |
| | ---------- | ---------- | |
| | | MySQL | ----| Indexer |----------- |
| | ---------- ---------- |
| whirlnet | dojonet |
|_________________|______________________________________________________________|
Host machine
@ -160,6 +159,7 @@ This procedure allows to install a new Dojo from scratch.
* Dojo provides a few additional settings for advanced setups:
* installation of an address indexer used for fast imports and rescans,
* support of an external electrum server (ElectrumX or electrs) used for fast imports and rescans,
* installation of a Whirlpool client,
* static onion address for your full node,
* bitcoind RPC API exposed to external apps,
* use of an external full node,
@ -258,6 +258,7 @@ Available commands:
dojo.sh logs pushtx : display the logs of the pushTx API (nodejs)
dojo.sh logs pushtx-orchest : display the logs of the Orchestrator (nodejs)
dojo.sh logs explorer : display the logs of the Explorer
dojo.sh logs whirlpool : display the logs of the Whirlpool client
Available options (for api, tracker, pushtx, pushtx-orchest and explorer modules):
-d [VALUE] : select the type of log to be displayed.
@ -277,6 +278,12 @@ Available commands:
upgrade Upgrade your Dojo.
version Display the version of dojo.
whirlpool [action] Interact with the internal whirlpool-cli mdule."
Available actions:"
apikey : display the API key generated by whirlpool-cli."
reset : reset the whirlpool-cli instance (delete configuration file)."
```
@ -346,6 +353,10 @@ The maintenance tool is accessed as a Tor hidden service (static onion address).
The block explorer is accessed as a Tor hidden service (static onion address).
The Whirlpool API is accessed as a Tor hidden service (static onion address).
The Whirlpool client connects to the Whirlpool Coordinator hidden service.
The Bitcoin node only allows incoming connections from Tor (ephemeral onion address).
The Bitcoin node attempts outgoing connections to both Tor and clearnet nodes (through the Tor local proxy).

Write Preview
Loading…
Cancel
Save