Skip to content

Commit 75f8592

Browse files
committed
docs: add dashmate import details (dashpay#353)
* docs: dashmate masternode import wip * docs: update dashmate screenshots and import section * docs: update dashmate download version * docs: minor edits * docs: make dropdown for node install option
1 parent 0c791d3 commit 75f8592

File tree

4 files changed

+64
-15
lines changed

4 files changed

+64
-15
lines changed
Loading
Loading
-1.25 KB
Loading

docs/user/network/dashmate/index.rst

+64-15
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ and easily set up and run a development network on your local system.
2222
Installation
2323
============
2424

25+
This guide describes how to download, install and use dashmate on for Linux. The guide is written
26+
for Ubuntu 22.04 x64 LTS, but the steps should be similar for other Linux distributions.
27+
2528
.. _dashmate-dep-install:
2629

2730
Install dependencies
@@ -38,45 +41,53 @@ Install and configure Docker::
3841
Install dashmate
3942
----------------
4043

41-
There are several methods available for installing dashmate.
44+
There are several methods available for installing dashmate. Installing the Linux, MacOS, or Windows
45+
packages from the `GitHub releases page <https://github.com/dashpay/platform/releases/latest>`__ is
46+
recommended for mainnet masternodes.
4247

4348
.. _dashmate-install-deb:
4449

4550
Debian package
4651
^^^^^^^^^^^^^^
4752

48-
Download the dashmate installation package::
53+
Download the dashmate installation package for your architecture from the `GitHub releases
54+
page <https://github.com/dashpay/platform/releases/latest>`__::
4955

50-
wget https://github.com/dashpay/platform/releases/download/v0.25.15/dashmate_0.25.15-1_arm64.deb
56+
wget https://github.com/dashpay/platform/releases/download/v0.25.22/dashmate_0.25.22.b143aee50-1_amd64.deb
5157

5258
Install dashmate using apt::
5359

5460
sudo apt update
55-
sudo apt install ./dashmate_0.25.15-1_arm64.deb
61+
sudo apt install ./dashmate_0.25.22.b143aee50-1_amd64.deb
5662

5763
Node package
5864
^^^^^^^^^^^^
5965

60-
To install the NodeJS package, it is necessary to install NodeJS first. We recommend
61-
installing it using `nvm <https://github.com/nvm-sh/nvm#readme>`__::
66+
.. warning:: This installation option is not recommended for mainnet masternodes. Please install
67+
packages from the `GitHub releases page <https://github.com/dashpay/platform/releases/latest>`__.
68+
69+
.. dropdown:: Node.js dashmate install
70+
71+
To install the NodeJS package, it is necessary to install NodeJS first. We recommend
72+
installing it using `nvm <https://github.com/nvm-sh/nvm#readme>`__::
6273

63-
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.5/install.sh | bash
64-
source ~/.bashrc
65-
nvm install 20
74+
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.5/install.sh | bash
75+
source ~/.bashrc
76+
nvm install 20
6677

67-
Once NodeJS has been installed, use npm to install dashmate::
78+
Once NodeJS has been installed, use npm to install dashmate::
6879

69-
npm install -g dashmate
80+
npm install -g dashmate
7081

7182
.. _dashmate-wizard-walkthrough:
7283

7384
Masternode setup
7485
================
7586

76-
You can setup both regular masternodes and Evolution masternodes (evonodes)
77-
using dashmate. There are few minor extra steps for evonodes, but the process is
78-
largely identical for both masternode types. Complete the steps in the sections
79-
below to set up your node or follow along with this step-by-step tutorial.
87+
Dashmate is primarily recommended for setting up Evolution masternodes (evonodes). With the
88+
exception of a few minor extra steps for evonodes, the process is identical for evonodes and regular
89+
masternodes. Complete the steps in the sections below to set up your node or follow along with this
90+
step-by-step tutorial.
8091

8192
.. raw:: html
8293

@@ -112,6 +123,40 @@ about an existing masternode.
112123

113124
Set up a new masternode
114125

126+
If registering a new masternode, jump to the :ref:`defining keys and addresses
127+
<dashmate-define-keys-addresses>` section next.
128+
129+
Import existing Core data
130+
-------------------------
131+
132+
.. note:: The following step only applies when migrating an existing masternode into dashmate.
133+
134+
If you chose to import an existing masternode in the previous step, you will be prompted for the
135+
location of your existing installation.
136+
137+
.. figure:: img/4a-import-existing-data.png
138+
:align: center
139+
:width: 90%
140+
141+
Import existing data
142+
143+
.. figure:: img/4b-import-existing-data-path.png
144+
:align: center
145+
:width: 90%
146+
147+
Enter existing Core data directory
148+
149+
.. figure:: img/4c-import-existing-data-complete.png
150+
:align: center
151+
:width: 90%
152+
153+
Core data import complete
154+
155+
Once the Core data has been imported, jump to the :ref:`configure communication
156+
<dashmate-configure-communication>` section.
157+
158+
.. _dashmate-define-keys-addresses:
159+
115160
Define Keys and Addresses
116161
-------------------------
117162

@@ -166,6 +211,8 @@ Optionally, use the one automatically generated by dashmate.
166211

167212
Enter the Platform node key
168213

214+
.. _dashmate-configure-communication:
215+
169216
Configure communication
170217
-----------------------
171218

@@ -197,6 +244,8 @@ details.
197244

198245
Run the registration command
199246

247+
.. _dashmate-enable-ssl:
248+
200249
Enable SSL
201250
----------
202251

0 commit comments

Comments
 (0)