Skip to content

Commit

Permalink
doc: Use backticks for directories and config values
Browse files Browse the repository at this point in the history
  • Loading branch information
@hkjn
hkjn committed Jul 19, 2019
1 parent bc4ebcd commit 516136a
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions doc/DOCKER_setup.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -83,35 +83,35 @@ This procedure allows to install a new Dojo from scratch.

* Download the most recent release of Dojo from [Github](https://github.com/Samourai-Wallet/samourai-dojo/archive/master.zip)

* Uncompress the archive on the host machine in a temporary directory of your choice (named <tmp_dir> in this doc)
* Uncompress the archive on the host machine in a temporary directory of your choice (named `<tmp_dir>` in this doc)

* Create a directory for Dojo (named <dojo_dir> in this doc)
* Create a directory for Dojo (named `<dojo_dir>` in this doc)

* Copy the content of the "<tmp_dir>/samourai-dojo-master" directory into the <dojo_dir> directory
* Copy the content of the `<tmp_dir>/samourai-dojo-master` directory into the `<dojo_dir>` directory

* Customize the configuration of your Dojo

* Go to the "<dojo_dir>/docker/my-dojo/conf" directory
* Go to the `<dojo_dir>/docker/my-dojo/conf` directory

* Edit docker-bitcoin.conf.tpl and provide a new value for the following parameters:
* BITCOIND_RPC_USER = login protecting the access to the RPC API of your full node,
* BITCOIND_RPC_PASSWORD = password protecting the access to the RPC API of your full node.
* If your machine has a lot of RAM, it's recommended that you increase the value of BITCOIND_DB_CACHE for a faster Initial Block Download.
* `BITCOIND_RPC_USER` = login protecting the access to the RPC API of your full node,
* `BITCOIND_RPC_PASSWORD` = password protecting the access to the RPC API of your full node.
* If your machine has a lot of RAM, it's recommended that you increase the value of `BITCOIND_DB_CACHE` for a faster Initial Block Download.
* This file also provides a few additional settings for advanced setups:
* static onion address for your full node,
* bitcoind RPC API exposed to external apps,
* use of an external full node.
See this [doc](./DOCKER_advanced_setups.md) for more details.

* Edit docker-mysql.conf.tpl and provide a new value for the following parameters:
* MYSQL_ROOT_PASSWORD = password protecting the root account of MySQL,
* MYSQL_USER = login of the account used to access the database of your Dojo,
* MYSQL_PASSWORD = password of the account used to access the database of your Dojo.
* `MYSQL_ROOT_PASSWORD` = password protecting the root account of MySQL,
* `MYSQL_USER` = login of the account used to access the database of your Dojo,
* `MYSQL_PASSWORD` = password of the account used to access the database of your Dojo.

* Edit docker-node.conf.tpl and provide a new value for the following parameters:
* NODE_API_KEY = API key which will be required from your Samourai Wallet / Sentinel for its interactions with the API of your Dojo,
* NODE_ADMIN_KEY = API key which will be required from the maintenance tool for accessing a set of advanced features provided by the API of your Dojo,
* NODE_JWT_SECRET = secret used by your Dojo for the initialization of a cryptographic key signing Json Web Tokens.
* `NODE_API_KEY` = API key which will be required from your Samourai Wallet / Sentinel for its interactions with the API of your Dojo,
* `NODE_ADMIN_KEY` = API key which will be required from the maintenance tool for accessing a set of advanced features provided by the API of your Dojo,
* `NODE_JWT_SECRET` = secret used by your Dojo for the initialization of a cryptographic key signing Json Web Tokens.
These parameters will protect the access to your Dojo. Be sure to provide alphanumeric values with enough entropy.

* Open the docker quickstart terminal or a terminal console and go to the `<dojo_dir>/docker/my-dojo` directory. This directory contains a script named dojo.sh which will be your entrypoint for all operations related to the management of your Dojo.
Expand Down Expand Up @@ -158,9 +158,9 @@ This procedure allows to upgrade your Dojo with a new version.

* Download the most recent release of Dojo from [Github](https://github.com/Samourai-Wallet/samourai-dojo/releases)

* Uncompress the archive on the host machine in a temporary directory of your choice (named <tmp_dir> in this doc)
* Uncompress the archive on the host machine in a temporary directory of your choice (named `<tmp_dir>` in this doc)

* Copy the content of the "<tmp_dir>/samourai-dojo-1.x.y" directory into the <dojo_dir> directory (overwrite).
* Copy the content of the `<tmp_dir>/samourai-dojo-1.x.y` directory into the `<dojo_dir>` directory (overwrite).

* Launch the upgrade of your Dojo with

Expand Down Expand Up @@ -255,7 +255,7 @@ A maintenance tool is accessible through your Tor browser at the url: <v3_onion_

The maintenance tool requires that you allow javascript for the site.

Sign in with the value entered for NODE_ADMIN_KEY.
Sign in with the value entered for `NODE_ADMIN_KEY`.


<a name="pairing"/>
Expand Down

0 comments on commit 516136a

Please sign in to comment.