Commit 932c41c3 authored by Wallet Guy's avatar Wallet Guy
Browse files

Merge branch 'lmt_fixes' into 'master'

Misc. fixes and updates

See merge request documentation/docs.samourai.io!1
parents 9deb26c6 e2c82598
......@@ -10,7 +10,7 @@ Configuration changes
This setup is activated thanks to the modification of these
configuration options
:ref:`BITCOIND_EPHEMERAL_HS <to-config-bitcoind_ephemeral_hs>` must
- :ref:`BITCOIND_EPHEMERAL_HS <to-config-bitcoind_ephemeral_hs>` must
be set to ``off``
.. attention:: The deactivation of the default behavior isn't
......
......@@ -8,7 +8,7 @@ Configuration changes
This setup is activated thanks to the modification of these
configuration options
:ref:`COMMON_BTC_NETWORK <to-config-common_btc_network>` must
- :ref:`COMMON_BTC_NETWORK <to-config-common_btc_network>` must
be set to ``testnet``
.. attention::
......
......@@ -12,19 +12,14 @@ Retrieve connnection information
The first step to activate this setup is to retrieve connection
informations for 3 Tor bridges:
Head over to https://bridges.torproject.org
- Head over to https://bridges.torproject.org
- Click on ``Get bridges``, then you will see a form with ``Advanced Options`` header
- Leave the Pluggable Transport as ``obfs4`` and click on ``Get Bridges`` button
- Solve the captcha, you will get the bridge addresses, usually three lines::
Click on ``Get bridges``, then you will see a form with
``Advanced Options`` header
Leave the Pluggable Transport as ``obfs4`` and click on ``Get Bridges``
button
Solve the captcha, you will get the bridge addresses, usually three lines::
obfs4 24.106.248.94:65531 B9EFBC5... cert=yrX... iat-mode=0
obfs4 ...
obfs4 ...
obfs4 24.106.248.94:65531 B9EFBC5... cert=yrX... iat-mode=0
obfs4 ...
obfs4 ...
Configuration changes
......@@ -32,17 +27,7 @@ Configuration changes
With the Tor bridge connection information the setup can be activated and
configured by modifying following configuration options
:ref:`TOR_USE_BRIDGES <to-config-tor_use_bridges>` must
be set to ``on``
:ref:`TOR_BRIDGE_1 <to-config-tor_bridge_1>` must
must be set with the first line returned in the previous
step
:ref:`TOR_BRIDGE_2 <to-config-tor_bridge_2>` must
must be set with the second line returned in the previous
step
:ref:`TOR_BRIDGE_3 <to-config-tor_bridge_3>` must
must be set with the third line returned in the previous
step
- :ref:`TOR_USE_BRIDGES <to-config-tor_use_bridges>` mustbe set to ``on``
- :ref:`TOR_BRIDGE_1 <to-config-tor_bridge_1>` must be set with the first line returned in the previous step
- :ref:`TOR_BRIDGE_2 <to-config-tor_bridge_2>` must be set with the second line returned in the previous step
- :ref:`TOR_BRIDGE_3 <to-config-tor_bridge_3>` must be set with the third line returned in the previous step
......@@ -3,7 +3,7 @@
Bitcoind Options
-----------------------------
A set of options allowing to configure the bitcoin daemon used by MyDojo.
General options are stored on the host machine, in the
Bitcoind options are stored on the host machine, in the
``<dojo_dir>/docker/my-dojo/docker-bitcoind.conf`` file.
.. _to-config-bitcoind_rpc_user:
......
......@@ -3,7 +3,7 @@
Explorer Options
-----------------------------
A set of options allowing to configure the blocks explorer provided by MyDojo.
General options are stored on the host machine, in the
Explorer options are stored on the host machine, in the
``<dojo_dir>/docker/my-dojo/docker-explorer.conf`` file.
.. _to-config-explorer-install:
......
......@@ -3,7 +3,7 @@
Indexer Options
-----------------------------
A set of options allowing to configure the addresses indexer used by MyDojo.
General options are stored on the host machine, in the
Indexer options are stored on the host machine, in the
``<dojo_dir>/docker/my-dojo/docker-indexer.conf`` file.
.. _to-config-indexer_install:
......
......@@ -3,7 +3,7 @@
MySQL Options
-----------------------------
A set of options allowing to configure the database used by MyDojo.
General options are stored on the host machine, in the
MySQL options are stored on the host machine, in the
``<dojo_dir>/docker/my-dojo/docker-mysql.conf`` file.
MYSQL_ROOT_PASSWORD
......
......@@ -3,7 +3,7 @@
NodeJS options
-----------------------------
A set of options allowing to configure MyDojo server application.
General options are stored on the host machine, in the
NodeJS options are stored on the host machine, in the
``<dojo_dir>/docker/my-dojo/docker-node.conf`` file.
......
Tor Options
-----------------------------
A set of options allowing to configure the Tor module of MyDojo.
General options are stored on the host machine, in the
Tor options are stored on the host machine, in the
``<dojo_dir>/docker/my-dojo/docker-tor.conf`` file.
.. _to-config-tor_use_bridges:
......
---------------------------------
Configuration Options
---------------------------------
This section will explain general concepts related to how
MyDojo handles configuration options.
This section details the configuration options supported by MyDojo.
.. include:: ./config-options-general.rst
......
......@@ -29,8 +29,8 @@ Customize the content of the file
.. code-block:: console
BITCOIND_RPC_USER = <provide_this value>
BITCOIND_RPC_PASSWORD = <provide_this value>
BITCOIND_RPC_USER=<provide_this value>
BITCOIND_RPC_PASSWORD=<provide_this value>
.. tip::
If your machine has a lot of RAM, it's recommended that you increase
......@@ -54,9 +54,9 @@ Customize the content of the file
.. code-block:: console
MYSQL_ROOT_PASSWORD = <provide_this value>
MYSQL_USER = <provide_this value>
MYSQL_PASSWORD = <provide_this value>
MYSQL_ROOT_PASSWORD=<provide_this value>
MYSQL_USER=<provide_this value>
MYSQL_PASSWORD=<provide_this value>
Save and exit the file with ``CTRL+X``, ``Y`` and ``ENTER``.
......@@ -75,10 +75,10 @@ Customize the content of the file
.. code-block:: console
NODE_API_KEY = <provide_this value>
NODE_ADMIN_KEY = <provide_this value>
NODE_JWT_SECRET = <provide_this value>
NODE_ACTIVE_INDEXER = local_indexer
NODE_API_KEY=<provide_this value>
NODE_ADMIN_KEY=<provide_this value>
NODE_JWT_SECRET=<provide_this value>
NODE_ACTIVE_INDEXER=local_indexer
Save and exit the file with ``CTRL+X``, ``Y`` and ``ENTER``.
......@@ -97,7 +97,7 @@ Customize the content of the file
.. code-block:: console
INDEXER_INSTALL = on
INDEXER_INSTALL=on
Save and exit the file with ``CTRL+X``, ``Y`` and ``ENTER``.
......@@ -116,7 +116,7 @@ Customize the content of the file
.. code-block:: console
EXPLORER_KEY = <provide_this>
EXPLORER_KEY=<provide_this>
Save and exit the file with ``CTRL+X``, ``Y`` and ``ENTER``.
......
......@@ -4,34 +4,39 @@ Architecture
::
--------------------- --------------------- ----------------------
| Samourai Wallet | | Sentinel | | Bitcoin full nodes |
--------------------- --------------------- ----------------------
|_______________________|_______________________|
|
------------
Tor network
------------
|
Host machine | (Tor hidden services)
______________________________| _____________________________
| | |
| ------------------- dmznet |
| | Tor Container | |
| ------------------- |
| | | |
| ------------------- | |
| | Nginx Container | | |
| ------------------- | |
|- - - - - - - - - - - | - - -|- - - - | - - - - - - - - - - |
| -------------------- | -------------------- |
| | Nodejs Container | ------ | Bitcoind Container | |
| -------------------- | -------------------- |
| | | | |
| -------------------- | -------------------- |
| | MySQL Container | ---- | BTC RPC Explorer | |
| -------------------- -------------------- |
| |
| dojonet |
|____________________________________________________________|
------------------- ------------------- --------------------
| Samourai Wallet | | Sentinel | | Bitcoin full nodes |
------------------- ------------------- --------------------
|_______________________|_______________________|
|
------------
Tor network
------------
|
| (Tor hidden services)
______________________________ | _____________________________
| | |
| --------- dmznet |
| --------| Tor |------------ |
| | --------- | |
| | | |
| --------- | |
| --| Nginx |-------- | |
| | --------- | | |
|- - - - -|- - - - - - - - - - -|- - - - - - - - -|- - - - - - |
| | | | |
| ---------- ---------- ---------- |
| | Nodejs |----------| Explorer |------| Bitcoind | |
| ---------- ---------- ---------- |
| | | | | |
| | | | | |
| | ------- | | |
| ---------- | ---------- | |
| | Db | ----| Indexer |----------- |
| ---------- ---------- |
| dojonet |
|______________________________________________________________|
Docker Host Machine
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment