diff --git a/docs/user/network/dashmate/img/4a-import-existing-data.png b/docs/user/network/dashmate/img/4a-import-existing-data.png new file mode 100644 index 000000000..cc511838c Binary files /dev/null and b/docs/user/network/dashmate/img/4a-import-existing-data.png differ diff --git a/docs/user/network/dashmate/img/4b-import-existing-data-path.png b/docs/user/network/dashmate/img/4b-import-existing-data-path.png new file mode 100644 index 000000000..ccad1a876 Binary files /dev/null and b/docs/user/network/dashmate/img/4b-import-existing-data-path.png differ diff --git a/docs/user/network/dashmate/img/dashmate-help.png b/docs/user/network/dashmate/img/dashmate-help.png index 3ed3b015c..54e0214a7 100644 Binary files a/docs/user/network/dashmate/img/dashmate-help.png and b/docs/user/network/dashmate/img/dashmate-help.png differ diff --git a/docs/user/network/dashmate/index.rst b/docs/user/network/dashmate/index.rst index ec9054845..24b9a1325 100644 --- a/docs/user/network/dashmate/index.rst +++ b/docs/user/network/dashmate/index.rst @@ -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 @@ -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 `__ 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 `__:: - 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 `__:: +.. warning:: This installation option is not recommended for mainnet masternodes. Please install + packages from the `GitHub releases page `__. + +.. dropdown:: Node.js dashmate install + + To install the NodeJS package, it is necessary to install NodeJS first. We recommend + installing it using `nvm `__:: - 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 @@ -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 +` 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 +` section. + +.. _dashmate-define-keys-addresses: + Define Keys and Addresses ------------------------- @@ -166,6 +211,8 @@ Optionally, use the one automatically generated by dashmate. Enter the Platform node key +.. _dashmate-configure-communication: + Configure communication ----------------------- @@ -197,6 +244,8 @@ details. Run the registration command +.. _dashmate-enable-ssl: + Enable SSL ----------