Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add dashmate import details #353

Merged
merged 5 commits into from
Jul 11, 2024
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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/user/network/dashmate/img/dashmate-help.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
79 changes: 64 additions & 15 deletions docs/user/network/dashmate/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ and easily set up and run a development network on your local system.
Installation
============

This guide describes how to download, install and use dashmate on for Linux. The guide is written
for Ubuntu 22.04 x64 LTS, but the steps should be similar for other Linux distributions.

.. _dashmate-dep-install:

Install dependencies
Expand All @@ -38,45 +41,53 @@ Install and configure Docker::
Install dashmate
----------------

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

.. _dashmate-install-deb:

Debian package
^^^^^^^^^^^^^^

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

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

Install dashmate using apt::

sudo apt update
sudo apt install ./dashmate_0.25.15-1_arm64.deb
sudo apt install ./dashmate_0.25.22.b143aee50-1_amd64.deb

Node package
^^^^^^^^^^^^

To install the NodeJS package, it is necessary to install NodeJS first. We recommend
installing it using `nvm <https://github.com/nvm-sh/nvm#readme>`__::
.. warning:: This installation option is not recommended for mainnet masternodes. Please install
packages from the `GitHub releases page <https://github.com/dashpay/platform/releases/latest>`__.

.. dropdown:: Node.js dashmate install

To install the NodeJS package, it is necessary to install NodeJS first. We recommend
installing it using `nvm <https://github.com/nvm-sh/nvm#readme>`__::

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.5/install.sh | bash
source ~/.bashrc
nvm install 20
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.5/install.sh | bash
source ~/.bashrc
nvm install 20

Once NodeJS has been installed, use npm to install dashmate::
Once NodeJS has been installed, use npm to install dashmate::

npm install -g dashmate
npm install -g dashmate

.. _dashmate-wizard-walkthrough:

Masternode setup
================

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

.. raw:: html

Expand Down Expand Up @@ -112,6 +123,40 @@ about an existing masternode.

Set up a new masternode

If registering a new masternode, jump to the :ref:`defining keys and addresses
<dashmate-define-keys-addresses>` section next.

Import existing Core data
-------------------------

.. note:: The following step only applies when migrating an existing masternode into dashmate.

If you chose to import an existing masternode in the previous step, you will be prompted for the
location of your existing installation.

.. figure:: img/4a-import-existing-data.png
:align: center
:width: 90%

Import existing data

.. figure:: img/4b-import-existing-data-path.png
:align: center
:width: 90%

Enter existing Core data directory

.. figure:: img/4c-import-existing-data-complete.png
:align: center
:width: 90%

Core data import complete

Once the Core data has been imported, jump to the :ref:`configure communication
<dashmate-configure-communication>` section.

.. _dashmate-define-keys-addresses:

Define Keys and Addresses
-------------------------

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

Enter the Platform node key

.. _dashmate-configure-communication:

Configure communication
-----------------------

Expand Down Expand Up @@ -197,6 +244,8 @@ details.

Run the registration command

.. _dashmate-enable-ssl:

Enable SSL
----------

Expand Down