Distribution package for Dash Masternode installation
- Docker (v18.06.0+)
- Docker Compose (v1.25.0+)
- Node.js (v10.0+)
For Linux installations you may optionally wish to follow the post-installation steps to manage Docker as a non-root user, otherwise you will have to run CLI and Docker commands with sudo.
$ git clone -b master https://github.com/dashevo/mn-bootstrap.git
$ cd mn-bootstrap
$ npm install # optional: install CLI dependencies
$ sudo npm link # optional: link CLI for system-wide executionThe package contains a CLI, Docker Compose and configuration files.
The CLI can be used to perform routine tasks. Invoke the CLI with mn if linked during installation, or with node bin/mn if not linked. To list available commands, either run mn with no parameters or execute mn help. To list the help on any command just execute the command, followed by the --help option.
The setup command is used to quickly configure common node configurations. Arguments may be provided as options, otherwise they will be queried interactively with sensible values suggested.
USAGE
$ mn setup [PRESET] [NODE-TYPE]
ARGUMENTS
PRESET (testnet|local) Node configuration preset
NODE-TYPE (masternode|fullnode) Node type
OPTIONS
-i, --external-ip=external-ip external ip
-k, --operator-bls-private-key=operator-bls-private-key operator bls private key
-p, --funding-private-key=funding-private-key private key with more than 1000 dash for funding collateral
-v, --verbose use verbose mode for output
--node-count=node-count number of nodes to setup
Supported presets:
testnet- a masternode or full node for testnetlocal- a node group to run a local dash network with the specified number of masternodes. To operate a group of nodes, use the group commands
To setup a testnet masternode:
$ mn setup testnet masternodeIf a funding private key is provided with the --funding-private-key option, the tool will automatically register your node on the network as a masternode. This functionality is only available when using the testnet preset.
The config command is used to manage your node configuration before starting the node. Several system configurations are provided as a starting point:
- base - basic config for use as template
- local - template for local node configs
- testnet - testnet node configuration
You can modify and use the system configs directly, or create your own. You can base your own configs on one of the system configs using the mn config:create CONFIG [FROM] command. You must set a default config with mn config:default CONFIG or specify a config with the --config=<config> option when running commands. The base config is initially set as default.
USAGE
$ mn config
OPTIONS
-v, --verbose use verbose mode for output
--config=config configuration name to use
DESCRIPTION
Display configuration options for default config
COMMANDS
config:create Create config
config:default Manage default config
config:envs Export config to envs
config:get Get config option
config:list List available configs
config:remove Remove config
config:set Set config option
The start command is used to start a node with the default or specified config.
USAGE
$ mn start
OPTIONS
-v, --verbose use verbose mode for output
-w, --wait-for-readiness wait for nodes to be ready
--config=config configuration name to use
To start a masternode:
$ mn startThe stop command is used to stop a running node.
USAGE
$ mn stop
OPTIONS
-v, --verbose use verbose mode for output
--config=config configuration name to use
To stop a node:
$ mn stopThe restart command is used to restart a node with the default or specified config.
USAGE
$ mn restart
OPTIONS
-v, --verbose use verbose mode for output
--config=config configuration name to use
The status command outputs status information relating to either the host, masternode or services.
USAGE
$ mn status
OPTIONS
-v, --verbose use verbose mode for output
--config=config configuration name to use
COMMANDS
status:core Show core status details
status:host Show host status details
status:masternode Show masternode status details
status:platform Show platform status details
status:services Show service status details
To show the host status:
$ mn status:hostThe reset command removes all data corresponding to the specified config and allows you to start a node from scratch.
USAGE
$ mn reset
OPTIONS
-v, --verbose use verbose mode for output
--config=config configuration name to use
-h, --hard reset config as well as data
-p, --platform-only reset platform data only
With the hard reset mode enabled, the corresponding config will be reset as well. To proceed, running the node setup is required.
To reset a node:
$ mn resetIt is also possible to start a full node instead of a masternode. Modify the config setting as follows:
mn config:set core.masternode.enable falseCLI allows to setup and operate multiple nodes. Only the local preset is supported at the moment.
The setup command set corresponding group as default. To output the current default group or set another one as default use group:default command.
USAGE
$ mn group:default [GROUP]
ARGUMENTS
GROUP group name
OPTIONS
-v, --verbose use verbose mode for output
The group:list command outputs a list of group configs.
USAGE
$ mn group:list
OPTIONS
-v, --verbose use verbose mode for output
--group=group group name to use
The group:start command is used to start a group of nodes belonging to the default group or a specified group.
USAGE
$ mn group:start
OPTIONS
-v, --verbose use verbose mode for output
-w, --wait-for-readiness wait for nodes to be ready
--group=group group name to use
The group:stop command is used to stop group nodes belonging to the default group or a specified group.
USAGE
$ mn group:stop
OPTIONS
-v, --verbose use verbose mode for output
--group=group group name to use
The group:restart command is used to restart group nodes belonging to the default group or a specified group.
USAGE
$ mn group:restart
OPTIONS
-v, --verbose use verbose mode for output
--group=group group name to use
The group:status command outputs group status information.
USAGE
$ mn group:status
OPTIONS
-v, --verbose use verbose mode for output
--group=group group name to use
The group:reset command removes all data corresponding to the specified group and allows you to start group nodes from scratch.
USAGE
$ mn group:reset
OPTIONS
-h, --hard reset config as well as data
-p, --platform-only reset platform data only
-v, --verbose use verbose mode for output
--group=group group name to use
With the hard reset mode enabled, corresponding configs will be reset as well. To proceed, running the node setup is required.
To group nodes together, set a group name to group option in corresponding configs.
Create a group of two testnet nodes:
# create a new config using `testnet` config as template
mn config:create testnet_2 testnet
# combine configs into the group
mn config:set --config=testnet group testnet
mn config:set --config=testnet_2 group testnet
# set the group as default
mn group:default testnetTo start the group of nodes, ports and other required options need to be updated.
To start a local dash network, the setup command with the local preset can be used to generate configs, mine some dash, register masternodes and populate the nodes with the data required for local development.
To allow developers quickly test changes to DAPI and Drive, a local path for DAPI or Drive may be specified via the platform.drive.abci.docker.build.path and platform.dapi.api.docker.build.path config options. A Docker image will be built from the provided path and then used by mn-bootstrap.
If you want to use Docker Compose directly, you will need to pass a configuration as a dotenv file. You can output a config to a dotenv file for Docker Compose as follows:
$ mn config:envs --config=testnet --output-file .env.testnetThen specify the created dotenv file as an option for the docker-compose command:
$ docker-compose --env-file=.env.testnetFeel free to dive in! Open an issue or submit PRs.
MIT © Dash Core Group, Inc.