Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions .tx/config
Original file line number Diff line number Diff line change
Expand Up @@ -631,6 +631,18 @@ source_file = build/gettext/guides/network/running-a-symbol-node-manually.pot
source_lang = en
type = PO

[symboldocs.guides--network--running-a-secure-symbol-node]
file_filter = source/locale/<lang>/LC_MESSAGES/guides/network/running-a-secure-symbol-node.po
source_file = build/gettext/guides/network/running-a-secure-symbol-node.pot
source_lang = en
type = PO

[symboldocs.guides--network--non-custodial-node-setup]
file_filter = source/locale/<lang>/LC_MESSAGES/guides/network/non-custodial-node-setup.po
source_file = build/gettext/guides/network/non-custodial-node-setup.pot
source_lang = en
type = PO

[symboldocs.guides--network--supernode-enrollment]
file_filter = source/locale/<lang>/LC_MESSAGES/guides/network/supernode-enrollment.po
source_file = build/gettext/guides/network/supernode-enrollment.pot
Expand Down
15 changes: 13 additions & 2 deletions source/_static/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -441,10 +441,10 @@ div.figure .caption {
padding: 0;
}
.sphinx-tabs .sphinx-menu a.item {
color: #00c8ff !important;
color: #5200c6 !important;
}
.sphinx-tabs .sphinx-menu a.active.item, .sphinx-tab {
border-color: #00c8ff !important;
border-color: #5200c6 !important;
}
.highlight > pre {
color: #fff;
Expand Down Expand Up @@ -635,4 +635,15 @@ img.with-rounded-shadow {
border-left: 6px solid red;
background-color: pink;
text-align:center;
}
/* Topics, similar to Notes but with custom titles.
* Copied from .alert */
div.topic {
margin: 20px 0;
padding: 5px 1.5rem !important;
background: #F5F5F5;
color: #333;
border: 0px;
border-left: 6px solid #00c8ff;
border-radius: 0px 4px 4px 0px;
}
2 changes: 1 addition & 1 deletion source/cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Installation

|cli| is distributed using the node package manager ``npm``.

.. note:: Symbol CLI require Node.js 12 LTS to execute.
.. note:: Symbol CLI requires `node.js <http://nodejs.org>`__ 12 LTS to run. It is recommended that you install node.js using `nvm <https://github.com/nvm-sh/nvm>`__.

Execute the following command in a new terminal:

Expand Down
3 changes: 2 additions & 1 deletion source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -391,7 +391,8 @@ class CliLexer(BashLexer):
'root': [
(r'^\? ', token.Keyword), # Blue, with the inkpot style
(r'(^SUCCESS |^✔ )', token.Generic.Inserted), # Green
(r'^ERR ', token.Name.Exception), # Red
(r'^ERR ', token.Name.Exception), # Red
(r'(Account|Property|Value)', token.Comment.Preproc), # Blue
(r'.', token.Text)
]
}
Expand Down
2 changes: 1 addition & 1 deletion source/getting-started/setup-workstation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ We are creating a new account with the :doc:`Symbol CLI <../cli>`, a command-lin

node --version

If you get an error or the version returned does not match v12.X, visit |node-js| to install the requirement.
If you get an error or the version returned does not match v12.X, visit |node-js| to install the requirement (Although it is recommended to install through `nvm <https://github.com/nvm-sh/nvm>`__).

2. To install |cli|, run the next command.

Expand Down
2 changes: 2 additions & 0 deletions source/guides/network/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ Guides related to creating nodes and test networks.

running-a-symbol-node
running-a-symbol-node-manually
running-a-secure-symbol-node
non-custodial-node-setup
configuring-node-properties
creating-a-private-test-net
configuring-network-properties
Expand Down
196 changes: 196 additions & 0 deletions source/guides/network/non-custodial-node-setup.rst

Large diffs are not rendered by default.

498 changes: 498 additions & 0 deletions source/guides/network/running-a-secure-symbol-node.rst

Large diffs are not rendered by default.

6 changes: 6 additions & 0 deletions source/guides/network/running-a-symbol-node.rst
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,12 @@ Once the node is running, from a different terminal (but from the same folder),

Just like in the harvesting case, this creates the required :ref:`VotingKeyLink transaction <voting-key-link-transaction>` and submits it to the network. Upon successful completion, your new node is ready to vote.

*********************
Running a secure node
*********************

It is possible to setup a node in such a way that **the private keys are never stored in plain text on a computer connected to the Internet**. Read about it in the :doc:`running-a-secure-symbol-node`.

***************************
Configuring node properties
***************************
Expand Down
4 changes: 2 additions & 2 deletions source/guides/network/using-symbol-bootstrap.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Environment

The setup scripts are automated using **docker**. To run a test net or node, you will need to have installed the following tools:

* `nodejs`_ version 10 or higher
* `node.js`_ version 10 or higher (It is recommended that you install node.js using `nvm <https://github.com/nvm-sh/nvm>`__)
* `docker`_
* `docker-compose`_

Expand Down Expand Up @@ -187,7 +187,7 @@ Proceed to the following guides to put what you have learned into practice!

Read the `complete list <https://github.com/nemtech/symbol-bootstrap/blob/main/README.md#user-content-commands>`_ of ``symbol-bootstrap`` commands.

.. _nodejs: https://nodejs.org/en/download/
.. _node.js: https://nodejs.org/en/download/

.. _docker: https://docs.docker.com/install/

Expand Down
Loading