(DRAFT) This page is intended to provide basic instructions on how to get started running a Mugle node.

Prerequisites

• Tested on Windows 10
• Relatively recent hardware
• Some Windows CMD experience

Downloading the Software

The latest Mugle release can be found on the project Release Page. Binaries are currently provided for Linux and OSX and Windows.

Distribution-specific releases will likely appear over time, and will be listed here.

Installation

Windows 10

Download the zipped binary to your machine, and unzip it into a folder. This will unzip a single file called mugle.exe, which contains the server software.

For now, we'd recommend placing this somewhere relative in your C:\ folder. For this tutorial we assume you download and unzip the files into C:\Mugle\node\

Open CMD

In order to configure and run Mugle-Node we need to open the Windows command-line. Once opened we need to change directory into where we did unzipped the files, in our example:

cd c:\Mugle\node\

Running from a Custom Directory

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

..Mugle\node> mugle.exe server config

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

Running a Mugle Node

After following the installation steps, simply run Mugle:

..Mugle\node> mugle.exe server -c mugle-server.toml run

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

Further Help

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

mugle.exe help
mugle.exe client help
mugle.exe server help