Commit 229d59ab authored by Wallet Guy's avatar Wallet Guy
Browse files

Merge branch 'lmt_fixes' into 'master'

Missing links + removed sentences

See merge request documentation/docs.samourai.io!2
parents 932c41c3 4ea84cb5
......@@ -6,11 +6,13 @@ source for imports and rescans. While private, this
default option has many limitations.
To get rid of these limitations, MyDojo allows to install
a local indexer (addrindexrs) providing the best of both
a local indexer (`addrindexrs`_) providing the best of both
worlds (no request sent to a third party, fast and real
time rescans, all transactions referencing the sdaddress
are retrieved).
.. _`addrindexrs`: https://github.com/Samourai-Wallet/addrindexrs
Requirements
----------------------------------
The initial installation of the indexer requires an
......
.. _to-configuration:
Dojo Configuration
==================
......
.. _to-first-install:
First Time Install
==================
......
......@@ -17,20 +17,22 @@ the base layer connecting MyDojo to the Bitcoin network.
Nodejs
-----------------------------
A Docker container running a `NodeJS`_ application server hosting the
Dojo server. This container is the core of MyDojo.
`Dojo server`_. This container is the core of MyDojo.
The Dojo server is composed of 4 modules:
- **API Server** - This module is the front end of the Dojo server.
It serves light clients like Samourai Wallet or Sentinel through
requests sent to its REST API and notifications sent through websockets.
- **Tracker** - This module takes care of tracking the activity of xpubs
and addresses registered on the Dojo server.
- **PushTx server** - This module is in charge of pushing transactions
on the Bitcoin network.
- **PushTx Orchestrator** - This module manages programmable pushes of
transactions.
- **API Server** - This module is the front end of the Dojo server.
It serves light clients like Samourai Wallet or Sentinel through
requests sent to its REST API and notifications sent through websockets.
- **Tracker** - This module takes care of tracking the activity of xpubs
and addresses registered on the Dojo server.
- **PushTx server** - This module is in charge of pushing transactions
on the Bitcoin network.
- **PushTx Orchestrator** - This module manages programmable pushes of
transactions.
.. _`NodeJS`: https://nodejs.org/en/
.. _`Dojo server`: https://github.com/Samourai-Wallet/samourai-dojo
Db
......@@ -54,7 +56,7 @@ communications pass through this component.
Nginx
-----------------------------
A Docker container running a NGINX web server.
A Docker container running a `NGINX`_ web server.
.. _`NGINX`: https://www.nginx.com/
......
.. _to-introduction:
Introduction to Dojo
====================
......
.. _to-introduction-key_concepts:
---------------------------------
Key Concepts
---------------------------------
......
.. _to-introduction-in_a_nutshell:
---------------------------------
Dojo in a nutshell
---------------------------------
......@@ -38,14 +40,21 @@ addressing different audiences:
- While some knowledge of the Linux environment is a plus, MyDojo
is great for anyone who isn't afraid of tinkering with a computer.
Dojo has a great and supportive community.
Dojo has a `great and supportive community`_.
.. _`great and supportive community`: https://t.me/samourai_dojo
- Users who like to play with different hardware architectures may prefer
Ronin Dojo, a fork of Dojo for Raspberry Pi4 and Odroid N2 that also
provides an improved UI. Another similar option is MyNodeBTC.
`Ronin Dojo`_, a fork of Dojo for Raspberry Pi4 and Odroid N2 that also
provides an improved UI. Another similar option is `MyNodeBTC`_.
.. _`Ronin Dojo`: https://github.com/RoninDojo/RoninDojo
.. _`MyNodeBTC`: https://mynodebtc.com/
- Users who prefer plug-n-play solutions will definitely enjoy the
convenience offered by Nodl Dojo.
convenience offered by `Nodl Dojo`_.
.. _`Nodl Dojo`: https://www.nodl.it
Learning MyDojo
......@@ -54,17 +63,17 @@ You have made up your mind. MyDojo is what you want. Here are a few
recommended readings that will teach you everything you need to know
for installing and running MyDojo:
- A short introduction to the requirements, the basic concepts and the
- A :ref:`short introduction <to-introduction-key_concepts>` to the requirements, the basic concepts and the
architecture of MyDojo.
- Everything you need to know about the Dojo Shell Script, your main tool
- Everything you need to know about the :ref:`Dojo Shell Script <to-tools-shell_script>`, your main tool
for interacting with MyDojo.
- Discover the role played by configuration files for customizing MyDojo to
- Discover the role played by :ref:`configuration files <to-configuration>` for customizing MyDojo to
your needs.
- It's time to install MyDojo thanks to this step by step guide.
- It's time to :ref:`install MyDojo <to-first-install>` thanks to this step by step guide.
- Your Dojo is syncing the blockchain. It's the perfect moment to
learn more about the Maintenance Tool and how to monitor and
learn more about the :ref:`Maintenance Tool <to-tools-maintenace_tool>` and how to monitor and
manage MyDojo.
......@@ -3,7 +3,7 @@ Upgrade MyDojo
For the sake of simplicity, the procedures described in this section
make a few assumptions about how MyDojo was installed
(see First Installation section). Nevertheless, they can be easily
(see :ref:`First Installation <to-first-install>` section). Nevertheless, they can be easily
adapted for different setups (by adapting directory paths, etc).
......
......@@ -36,9 +36,10 @@ Overwrite the dojo-app directory with the content of the archive
Update Configuration (optional)
----------------------------------
Check the release notes for a list of new features that may require to tune
Check the `release notes`_ for a list of new features that may require to tune
the value of new configuration options.
.. _`release notes`: https://github.com/Samourai-Wallet/samourai-dojo/blob/master/RELEASES.md
If applicable, edit the templates files stored in
``~/dojo-app/docker/my-dojo/conf/`` and modify the values set for new
......
......@@ -37,9 +37,10 @@ Overwrite the dojo-app directory with the content of the archive
Update Configuration (optional)
----------------------------------
Check the release notes for a list of new features that may require to tune
Check the `release notes`_ for a list of new features that may require to tune
the value of new configuration options.
.. _`release notes`: https://github.com/Samourai-Wallet/samourai-dojo/blob/master/RELEASES.md
If applicable, edit the templates files stored in
``~/dojo-app/docker/my-dojo/conf/`` and modify the values set for new
......
.. _to-tools-maintenace_tool:
---------------------------------
Maintenance Tool
---------------------------------
......@@ -5,8 +7,7 @@ The Maintenance Tool is a web interface accessible through Tor
and allowing to run maintenance operations.
The Maintenance Tool can be seen as a graphical interface wrapping
calls to web services provided by the REST API of MyDojo. More info
about the endpoints served by the REST API on this page.
calls to web services provided by the REST API of MyDojo.
.. image:: ../dojo-assets/maintenance_tool_1.png
:width: 650
......
......@@ -5,7 +5,6 @@ Dojo Shell Script
---------------------------------
A linux shell script supporting multiple commands allowing
to interact with your Dojo (install, updates, Dojo logs, etc).
More info about the shell script on this page.
.. image:: ../dojo-assets/dojosh_1.png
:width: 650
......
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