Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
e25dd95
Merge pull request #310 from Remmeauth/docs-change-admin-password
dmytrostriletskyi Apr 10, 2019
f94a89a
Migrate setup command due to 0.8.1 release
dmytrostriletskyi Apr 18, 2019
309224b
Merge pull request #326 from Remmeauth/docs-update-to-0.8.1
dmytrostriletskyi Apr 19, 2019
9a8ad63
Add instruction to add domain to discovery
dmytrostriletskyi Apr 19, 2019
fee3145
Merge pull request #329 from Remmeauth/docs-discovery-with-domain
dmytrostriletskyi Apr 19, 2019
3838aff
Fix documentation environemnt variable saving
dmytrostriletskyi Apr 23, 2019
a26a7b2
Merge pull request #336 from Remmeauth/fix-docs-env-vars
dmytrostriletskyi Apr 23, 2019
c9b92d0
Update docs to 0.9.0 release, add upgrade section
dmytrostriletskyi Apr 25, 2019
e8d1f63
Merge pull request #339 from Remmeauth/docs-update-to-0.9.0
dmytrostriletskyi Apr 25, 2019
baea96b
Include upgrade section to the advanced tree
dmytrostriletskyi Apr 25, 2019
ca58bfc
Merge pull request #340 from Remmeauth/upgrade-section-advanced-tree
dmytrostriletskyi Apr 25, 2019
6986fea
Update guide due to 0.9.1 release: bumnp version
dmytrostriletskyi May 3, 2019
397933f
Merge pull request #343 from Remmeauth/docs-update-to-0.9.1
dmytrostriletskyi May 3, 2019
54d05c8
Update version from 0.9.1 to 0.10.0
dmytrostriletskyi May 10, 2019
cdc6f77
Merge pull request #347 from Remmeauth/docs-update-to-0.10.0
dmytrostriletskyi May 10, 2019
4c0a36d
Update node release to 0.11.0 in AWS sectiona
dmytrostriletskyi May 20, 2019
dc70411
Update node release to 0.11.0 in DO section
dmytrostriletskyi May 20, 2019
4f2255e
Update node release to 0.11.0 in Vultr section
dmytrostriletskyi May 20, 2019
200ae03
Merge pull request #354 from Remmeauth/update-release-from-0.10.0-to-…
dmytrostriletskyi May 20, 2019
2d50281
Add migration command from 0.10.0 to 0.11.0
dmytrostriletskyi May 20, 2019
1cb1400
Merge pull request #355 from Remmeauth/docs-update-to-0.11.0
dmytrostriletskyi May 21, 2019
f51225d
Add metrics collection to the initial 11 release installation
dmytrostriletskyi May 21, 2019
2090532
Merge pull request #357 from Remmeauth/docs-update-to-0.11.0
dmytrostriletskyi May 21, 2019
3a8ac8d
Fix link with updating script for 0.11.0-alpha
dmytrostriletskyi May 21, 2019
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
Binary file modified docs/img/user-guide/admin-panel/login-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/img/user-guide/cloud/aws/instance-security-group.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 3 additions & 1 deletion docs/user-guide/advanced-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@ Advanced guide

.. include:: /user-guide/advanced-guide/types-of-node-running.rst
.. include:: /user-guide/advanced-guide/admin-panel.rst
.. include:: /user-guide/advanced-guide/upgrade-node.rst
.. include:: /user-guide/advanced-guide/new-os-user.rst
.. include:: /user-guide/advanced-guide/2fa-auth.rst
.. include:: /user-guide/advanced-guide/domain-name.rst
.. include:: /user-guide/advanced-guide/node-ssl-cert.rst
.. include:: /user-guide/advanced-guide/backup-ssh-keys.rst
.. include:: /user-guide/advanced-guide/snapshots.rst
.. include:: /user-guide/advanced-guide/node-private-key.rst
.. include:: /user-guide/advanced-guide/node-keys.rst
21 changes: 14 additions & 7 deletions docs/user-guide/advanced-guide/domain-name.rst
Original file line number Diff line number Diff line change
Expand Up @@ -112,17 +112,24 @@ change ``157.230.146.230`` to your server's ``IP address``.

.. code-block:: console

$ export NODE_IP_ADDRESS=157.230.146.230
$ curl -X POST http://$NODE_IP_ADDRESS:8080 -H 'Content-Type: application/json' -d \
$ curl -X POST http://$NODE_IP_ADDRESS/rpc/ -H 'Content-Type: application/json' -d \
'{"jsonrpc":"2.0","id":"11","method":"get_node_config","params":{}}' | python3 -m json.tool

Then change the value of ``NODE_IP_ADDRESS`` to your domain name with an extension (i.e. ``the-coolest-masternode.xyz``)
and send execute the previous command again. A response should be similar to the previous one:
Then create a new environment variable with your domain name with an extension as illustrated below. Also, there is
a command to make your node to be discovered for synchronization by domain name instead of IP address. Change ``the-coolest-masternode.xyz``
to your ``domain name``.

.. code-block:: console

$ export NODE_IP_ADDRESS=the-coolest-masternode.xyz
$ curl -X POST http://$NODE_IP_ADDRESS:8080 -H 'Content-Type: application/json' -d \
$ export DOMAIN=the-coolest-masternode.xyz
$ sudo -i sed -i "s@$NODE_IP_ADDRESS@$DOMAIN@" /home/remme-core-$REMME_CORE_RELEASE/config/network-config.env && \
echo "DOMAIN=$DOMAIN" >> ~/.bashrc

Execute the previous command again. A response should be similar to the previous one.

.. code-block:: console

$ curl -X POST http://$DOMAIN/rpc/ -H 'Content-Type: application/json' -d \
'{"jsonrpc":"2.0","id":"11","method":"get_node_config","params":{}}' | python3 -m json.tool

The flow is illustrated below.
Expand All @@ -132,5 +139,5 @@ The flow is illustrated below.
:align: center
:alt: Proof domain name works

For now, you can reach your admin panel with the following address — ``http://the-coolest-masternode.xyz/login``,
For now, you can reach your admin panel with the following address — ``http://the-coolest-masternode.xyz``,
changing ``the-coolest-masternode.xyz`` to your domain name and extension.
37 changes: 37 additions & 0 deletions docs/user-guide/advanced-guide/node-keys.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
Node keys
=========

Until the admin panel does not cover all node's user requirements, there is an ability to fetch the node's private and public keys
manually to execute different operations such as an ``Atomic Swap``. Being logged in the server, use the following command to fetch
node's private key.

.. code-block:: console

$ sudo cat /var/lib/docker/volumes/remme_validator_keys/_data/validator.priv

The command will show you the private key and you can copy it. The result is illustrated below.

.. image:: /img/user-guide/advanced-guide/node-private-key.png
:width: 100%
:align: center
:alt: Get node private key

Do not share it for the security reasons. To fetch the public key and its address, use thee following command:

.. code-block:: console

$ curl -X POST http://$NODE_IP_ADDRESS/rpc/ -H 'Content-Type: application/json' -d \
'{"jsonrpc":"2.0","id":"11","method":"get_node_config","params":{}}' | python3 -m json.tool

The response should look similar to this:

.. code-block:: console

{
"jsonrpc": "2.0",
"id": "11",
"result": {
"node_public_key": "02b844a10124aae7713e18d80b1a7ae70fcbe73931dd933c821b354f872907f7f3",
"node_address": "116829caa6f35dddfd62d067607426407c95bf8dbc37fa55bcf734366df2e97cac660b"
}
}
18 changes: 0 additions & 18 deletions docs/user-guide/advanced-guide/node-private-key.rst

This file was deleted.

36 changes: 11 additions & 25 deletions docs/user-guide/advanced-guide/node-ssl-cert.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,6 @@ The flow is illustrated below.
:align: center
:alt: SSH login to the server

Then create a new environment variable as illustrated below. Change ``the-coolest-masternode.xyz``
with your ``domain name``.

.. code-block:: console

$ export DOMAIN=the-coolest-masternode.xyz

Then create a new environment variable with your ``email`` to receive notifications from ``Let's Encrypt``:

.. code-block:: console
Expand All @@ -42,22 +35,22 @@ Copy the command below and paste into the terminal which will create an ``SSL ce

.. code-block:: console

$ echo "DOMAIN=$DOMAIN" >> ~/.bashrc && \
sudo apt install software-properties-common -y && \
$ sudo apt install software-properties-common -y && \
sudo add-apt-repository ppa:certbot/certbot -y && \
sudo apt update && sudo apt install certbot python-certbot-nginx -y && \
sudo -i sed -i "s@websitenamewithdomain@$DOMAIN@" /etc/nginx/nginx.conf && \
sudo certbot run --nginx -d $DOMAIN --non-interactive --agree-tos -m $EMAIL && \
curl https://raw.githubusercontent.com/Remmeauth/remme-core/master/docs/user-guide/templates/letsencrypt-nginx.conf | sudo tee /etc/nginx/nginx.conf > /dev/null && \
curl https://gist.githubusercontent.com/dmytrostriletskyi/24a8125e609bba7e8d8f9b3e54d634ff/raw/6e9fa256fe07c99d1e15bc652bd328cb3447b046/letsencrypt-nginx.conf | sudo tee /etc/nginx/nginx.conf > /dev/null && \
sudo -i sed -i "s@websitenamewithdomain@$DOMAIN@" /etc/nginx/nginx.conf && \
sudo systemctl restart nginx && \
echo "* * * * * $USER /usr/bin/certbot renew" | sudo tee -a /etc/crontab > /dev/null
echo "1 5 * * * $USER /usr/bin/certbot renew" | sudo tee -a /etc/crontab > /dev/null && \
echo "5 5 * * * /usr/bin/systemctl reload nginx" | sudo tee -a /etc/crontab > /dev/null

To check if your node has completed a correct ``SSL certificate`` setup, use the following commands, being logged in your server.

.. code-block:: console

$ curl -X POST https://$DOMAIN -H 'Content-Type: application/json' -d \
$ curl -X POST https://$DOMAIN/rpc/ -H 'Content-Type: application/json' -d \
'{"jsonrpc":"2.0","id":"11","method":"get_node_config","params":{}}' | python3 -m json.tool

The flow is illustrated below.
Expand All @@ -67,7 +60,7 @@ The flow is illustrated below.
:align: center
:alt: Proof node works over HTTPS

For now, you can reach your monitoring page with the following address — ``https://the-coolest-masternode.xyz/grafana/``,
For now, you can reach your monitoring page with the following address — ``https://the-coolest-masternode.xyz``,
changing ``the-coolest-masternode.xyz`` to your domain name and extension.

Comodo
Expand Down Expand Up @@ -278,15 +271,8 @@ Using a brand new terminal window on the local machine transfer the file to the

$ scp ~/Desktop/210854864.zip root@157.230.226.218:~

Then open a terminal window with the server. Then create a new environment variable with your domain name as illustrated below.
Remember to change ``the-coolest-masternode.xyz`` with your ``domain name``.

.. code-block:: console

$ export DOMAIN=the-coolest-masternode.xyz

Copy the command below and paste into the terminal which will create an ``SSL certificate`` and order the web-server to
serve ``https`` connections.
Then open a terminal window with the server. Copy the command below and paste into the terminal which will
create an ``SSL certificate`` and order the web-server to serve ``https`` connections.

.. code-block:: console

Expand All @@ -295,15 +281,15 @@ serve ``https`` connections.
cd "CER - CRT Files" && cat ${DOMAIN%.*}_${DOMAIN##*.}.crt My_CA_Bundle.ca-bundle > ssl-bundle.crt && \
cd .. && mv CER\ -\ CRT\ Files/ssl-bundle.crt . && \
sudo mkdir /etc/comodo/ && sudo mv server.key ssl-bundle.crt /etc/comodo/ && \
curl https://raw.githubusercontent.com/Remmeauth/remme-core/master/docs/user-guide/templates/comodo-nginx.conf | sudo tee /etc/nginx/nginx.conf > /dev/null && \
curl https://gist.githubusercontent.com/dmytrostriletskyi/a0b4c24e0b34788596ed3f6264282694/raw/35be13584c781037c775f2f082387515ad069815/comodo-nginx.conf | sudo tee /etc/nginx/nginx.conf > /dev/null && \
sudo -i sed -i "s@websitenamewithdomain@$DOMAIN@" /etc/nginx/nginx.conf && \
sudo systemctl restart nginx

To check if your node has completed a correct ``SSL certificate`` setup, use the following commands, being logged in your server.

.. code-block:: console

$ curl -X POST https://$DOMAIN -H 'Content-Type: application/json' -d \
$ curl -X POST https://$DOMAIN/rpc/ -H 'Content-Type: application/json' -d \
'{"jsonrpc":"2.0","id":"11","method":"get_node_config","params":{}}' | python3 -m json.tool

The flow is illustrated below.
Expand All @@ -317,5 +303,5 @@ The flow is illustrated below.

<a href="https://curl.haxx.se/download.html" target="_blank">tool named curl </a>

For now, you can reach your admin panel with the following address — ``https://the-coolest-masternode.xyz/login``,
For now, you can reach your admin panel with the following address — ``https://the-coolest-masternode.xyz``,
changing ``the-coolest-masternode.xyz`` to your domain name and extension.
49 changes: 49 additions & 0 deletions docs/user-guide/advanced-guide/upgrade-node.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
Upgrade the node
================

This section describes how to upgrade the node to latest version. After upgrade you are required to redo login
to the server if you want to execute commands farther.

From 0.10.0-alpha to 0.11.0-alpha
---------------------------------

To upgrade from the version ``0.10.0-alpha`` to the version ``0.11.0-alpha``, use the following command on the server:

.. code-block:: console

$ curl https://gist.githubusercontent.com/dmytrostriletskyi/7407898a9737d5808716ea3b0f3d6f75/raw/64ec47fac9f0add5819526aaf9094d1529264edf/upgrade-node-from-0.10.0a-to-0.11.0a.sh > ~/upgrade-node-from-0.10.0a-to-0.11.0a.sh && \
chmod +x ~/upgrade-node-from-0.10.0a-to-0.11.0a.sh && \
~/./upgrade-node-from-0.10.0a-to-0.11.0a.sh 0.10.0-alpha 0.11.0-alpha $NODE_IP_ADDRESS

From 0.9.1-alpha to 0.10.0-alpha
--------------------------------

To upgrade from the version ``0.9.1-alpha`` to the version ``0.10.0-alpha``, use the following command on the server:

.. code-block:: console

$ curl https://gist.githubusercontent.com/dmytrostriletskyi/ddb0d8fc16512523f4942a2d60b57c63/raw/63de05cc7f68801bb6887fc07463422810276a10/upgrade-node.sh > ~/upgrade-node.sh && \
chmod +x ~/upgrade-node.sh && \
~/./upgrade-node.sh 0.9.1-alpha 0.10.0-alpha

From 0.9.0-alpha to 0.9.1-alpha
-------------------------------

To upgrade from the version ``0.9.0-alpha`` to the version ``0.9.1-alpha``, use the following command on the server:

.. code-block:: console

$ curl https://gist.githubusercontent.com/dmytrostriletskyi/ddb0d8fc16512523f4942a2d60b57c63/raw/63de05cc7f68801bb6887fc07463422810276a10/upgrade-node.sh > ~/upgrade-node.sh && \
chmod +x ~/upgrade-node.sh && \
~/./upgrade-node.sh 0.9.0-alpha 0.9.1-alpha

From 0.8.1-alpha to 0.9.0-alpha
-------------------------------

To upgrade from the version ``0.8.1-alpha`` to the version ``0.9.0-alpha``, use the following command on the server:

.. code-block:: console

$ curl https://gist.githubusercontent.com/dmytrostriletskyi/ddb0d8fc16512523f4942a2d60b57c63/raw/63de05cc7f68801bb6887fc07463422810276a10/upgrade-node.sh > ~/upgrade-node.sh && \
chmod +x ~/upgrade-node.sh && \
~/./upgrade-node.sh 0.8.1-alpha 0.9.0-alpha
56 changes: 27 additions & 29 deletions docs/user-guide/cloud/aws.rst
Original file line number Diff line number Diff line change
Expand Up @@ -100,11 +100,9 @@ Set tag named ``Name`` with value ``remme-core-testnet-node``, then press ``Next

Add the following rules to the security group:

1. ``Custom TCP`` for type, ``8080`` for port range, ``0.0.0.0/0, ::/0`` for source and ``Open node RPC API port`` for description.
2. ``Custom TCP`` for type, ``8800`` for port range, ``0.0.0.0/0, ::/0`` for source and ``Nodes synchronisation port`` for description.
3. ``Custom TCP`` for type, ``3000`` for port range, ``0.0.0.0/0, ::/0`` for source and ``Monitoring port`` for description.
4. ``Custom TCP`` for type, ``80`` for port range, ``0.0.0.0/0, ::/0`` for source and ``HTTP port`` for description.
5. ``Custom TCP`` for type, ``443`` for port range, ``0.0.0.0/0, ::/0`` for source and ``HTTPS port`` for description.
1. ``Custom TCP`` for type, ``8800`` for port range, ``0.0.0.0/0, ::/0`` for source and ``Nodes synchronisation port`` for description.
2. ``Custom TCP`` for type, ``80`` for port range, ``0.0.0.0/0, ::/0`` for source and ``HTTP port`` for description.
3. ``Custom TCP`` for type, ``443`` for port range, ``0.0.0.0/0, ::/0`` for source and ``HTTPS port`` for description.

.. image:: /img/user-guide/cloud/aws/instance-security-group.png
:width: 100%
Expand Down Expand Up @@ -180,27 +178,29 @@ If you need any assistance connecting to your instance, please see |connection_t
Step 5: start the project
=========================

Copy commands below and paste it into the terminal. You can change the value of ``REMME_CORE_RELEASE`` below, just take
a look at our `release list <https://github.com/Remmeauth/remme-core/releases>`_. We would recommend the latest version of
the project that already specified in the command below.

Export environment variable with your server ``IPv4 Public IP`` with the following command. Remember to change
``157.230.146.230`` to your server's ``IPv4 Public IP``.

.. code-block:: console

$ export NODE_IP_ADDRESS=157.230.146.230

Now, specify the release of the node you want to start. We would recommend the latest version of the project that already
specified in the command below. But you can change the value of ``REMME_CORE_RELEASE``, just take a look at our
`release list <https://github.com/Remmeauth/remme-core/releases>`_.

.. code-block:: console

$ export REMME_CORE_RELEASE=0.8.0-alpha
$ sudo apt-get install apt-transport-https ca-certificates curl software-properties-common make -y && \
echo "REMME_CORE_RELEASE=$REMME_CORE_RELEASE" >> ~/.bashrc && \
cd /home/ && curl -L https://github.com/Remmeauth/remme-core/archive/v$REMME_CORE_RELEASE.tar.gz | sudo tar zx && \
cd remme-core-$REMME_CORE_RELEASE && \
sudo apt update && sudo apt upgrade -y && \
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add - && \
sudo apt update && sudo apt install docker.io -y && \
sudo curl -o /usr/local/bin/docker-compose -L "https://github.com/docker/compose/releases/download/1.23.2/docker-compose-$(uname -s)-$(uname -m)" && \
sudo chmod +x /usr/local/bin/docker-compose && \
curl https://gist.githubusercontent.com/dmytrostriletskyi/9f525241acfc46799c65d5f010c43b5f/raw/3147860240613e7e2eab5e288d48a975934a260a/up-node-after-server-restart.sh > ~/up-node-after-server-restart.sh && \
chmod +x ~/up-node-after-server-restart.sh && \
echo "@reboot $USER ~/./up-node-after-server-restart.sh $REMME_CORE_RELEASE" | sudo tee -a /etc/crontab > /dev/null && \
curl https://gist.githubusercontent.com/dmytrostriletskyi/48f2877d77570facffdea395521e8bd8/raw/9334bfb5cc18b4e143311fead9bd2447a0ae6d24/seeds-list.txt | sudo tee config/seeds-list.txt > /dev/null && \
sudo make run_bg_user
$ export REMME_CORE_RELEASE=0.11.0-alpha

After, copy and paste the following command to the terminal which will install and start your node.

.. code-block:: console

$ curl https://gist.githubusercontent.com/dmytrostriletskyi/c02b5b3a5f0e0a0a22abb2d35d6a8f20/raw/fbeb7d7e949c4d2cc27255117a79c31a72bfe315/install-and-start-node.sh > ~/install-and-start-node.sh && \
chmod +x ~/install-and-start-node.sh && \
~/./install-and-start-node.sh $NODE_IP_ADDRESS $REMME_CORE_RELEASE

.. image:: /img/user-guide/cloud/aws/installation-command.png
:width: 100%
Expand Down Expand Up @@ -228,13 +228,11 @@ When you see the same output as illustrated below, it means the node is ready to
:align: center
:alt: Proof core is up

To check if your node has completed a correct setup, use the following commands, being logged in your instance. Remember to
change ``157.230.146.230`` to your server's ``IP address``.
To check if your node has completed a correct setup, use the following command:

.. code-block:: console

$ export NODE_IP_ADDRESS=157.230.146.230
$ curl -X POST http://$NODE_IP_ADDRESS:8080 -H 'Content-Type: application/json' -d \
$ curl -X POST http://$NODE_IP_ADDRESS/rpc/ -H 'Content-Type: application/json' -d \
'{"jsonrpc":"2.0","id":"11","method":"get_node_config","params":{}}' | python3 -m json.tool

The response should look similar to this:
Expand All @@ -261,8 +259,8 @@ Step 6: admin panel
===================

While starting the node, the admin panel has also been installed and started. Log into the admin panel. Copy your server's
``IPv4 Public IP`` address, paste it into the browser address bar. Then add ``/login`` to the end of the address and press ``Enter``.
Then you will see the initial admin panel page with authentication. Enter ``remme`` to the password fields.
``IPv4 Public IP``, paste it into the browser address bar press ``Enter``. Then you will see the initial admin panel page with
authentication. Enter ``remme`` to the password fields.

.. image:: /img/user-guide/admin-panel/login-page.png
:width: 100%
Expand Down
Loading