Skip to content

How to run a MWC node

Tom edited this page May 15, 2020 · 1 revision

This page is intended to provide basic instructions on how to get started running a MWC node.

Prerequisites

  • Linux (x86-64 only) or MacOS
  • Relatively recent hardware
  • Some Linux command line knowledge very helpful
  • rust 1.31+ (use rustup- i.e. curl https://sh.rustup.rs -sSf | sh; source $HOME/.cargo/env)
    • if rust is already installed, you can simply update version with rustup update

Downloading the Software

The latest MWC Node release can be found on the project Release Page.

Installation

Linux (all distributions)

Download the zipped binary to your machine, and unzip it using the terminal. This will unzip a single file called mwc, which contains both the server and wallet software.

For now, we'd recommend placing this somewhere relative to your home directory, and editing your path environment variable to ensure the mwc executable is available from wherever you run it. All of this can be done by running the following commands in the directory to which you downloaded MWC.

mkdir -p ~/mwc
tar xzf mwc-v1.0.0-479973573-linux-amd64.tgz -C ~/mwc
echo export 'PATH=~/mwc:$PATH' >> ~/.bashrc
source ~/.bashrc

Running a MWC Node

After following the installation steps, simply run mwc:

mwc

Or, to run a Floonet (i.e. test network) node:

mwc --floonet

And that is it! The MWC TUI (Text-User-Interface) should appear and your node should automatically sync up with the blockchain.

Configuring your MWC node

By default, your MWC node keeps all of its configuration files and data in the ~/.mwc directory under your user home. The main server configuration file can be found in the file ~/.mwc/main/mwc-server.toml (~/.mwc/floo/mwc-server.toml for Floonet). This file is fully documented, and contains many configuration options for your mwc server. Leaving these values at their defaults should work for most people who simply want to run a node.

Running from a Custom Directory

You can also keep MWC's data and configuration files in a custom directory. From the directory in which you want MWC to store its files, run:

mwc server config

This will create a mwc-server.toml file in the current directory that is configured to place its data files in the same directory. The mwc command will always check the current directory for a mwc-server.toml file, and if one is found it will use it instead of ~/.mwc/main/mwc-server.toml.

Further Help

You can view further details on the various commmand-line options available from MWC using the help command:

mwc help
mwc client help
mwc server help
Clone this wiki locally