(Draft) How to run a Grin Node (Windows)

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

Prerequisites

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

Downloading the Software

The latest Grin 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 grin.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:\Grin\node\

Open CMD

In order to configure and run Grin-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:\Grin\node\

Running from a Custom Directory

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

..Grin\node> grin.exe server config

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

Running a Grin Node

After following the installation steps, simply run Grin:

..Grin\node> grin.exe server -c grin-server.toml run

And that is it! The Grin 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 grin using the help command:

grin.exe help
grin.exe client help
grin.exe server help