Run a POA node on Windows (Simple)
This is a simplified and visually explained guide for running a node. If you feel confident with installing software and running commands through command prompt please find the the general guide here:
To begin this process there are three pieces of software that must be installed these are:
- .Net Framework
- Rust
- MongoDB
We will go through these in turn.
Firstly however we must explain some of the tool we will be using to install the pieces of software. The main componants of all three software will be installed like any other software.
Some elements of this guide will require the use of the Command Prompt, this come pre-installed on all Windows distributions. You can find command prompt by using the search bar generally found at the bottom of your screen.
Once opened the window should look like this:
.Net is installed through the link:
This link should automatically download the SDK needed. If it does not please click the link in the below photo.
This can generally be done by double clicking the software on the bottom bar which should look like:
Running this software should bring up a screen like:
Proceed through the steps indicated in the the software installation. The installation may at points ask for permission to allow the app to make changes to your computer, if this happens select the yes option. Once the installation is complete select the close option.
Firstly we must install the C++ build tools for Visual Studion. To do this click on the link:
Then you must select the option displayed below.
This should automatically begin the download of rust. If this does not work use this link:
Once the installer is downloaded run it by opening the downloaded installer. When run several options should be availiable for the instalation. We must select the higlighted option in the below image.
After this option is checked press install. This installation may take a while. Once it is complete you will be required to restart your PC.
The download for Rust can be found at the link:
Then select the Download Rustup-init.exe (64-bit) as seen in the below image.
Once the download has completed run the downloaded installation package. This will open your command prompt. This will ask you whether you wish to proceed, continue by typing y and then enter.
The instalation will then ask what kind of install you wish to perform, select option 1 by typing 1 and then enter.
Once the download is complete the command prompt will look as below, press enter to complete the install.
Use the following link to gownload the MongoDB installer:
If that does not work use the link:
Select Windows under the operating system tab and MSI under the package.
Then open the installer which should open a window that looks like this:
Follow the links pressing next and accept the End-User License agreement. You will then be asked what kind of download you would like, select complete.
The installer will ask about Service configuration, leave as default as seen in the below image.
At the next step the installer will ask if you wish to install MongoDB compass, check the box that says Install MongoDB Compass as seen in the below image and click next.
On the final box select install, at this point the app may request permissions you must allow these to complete the download. This download may take a while.
Start by downloading the git installer using the following link:
The download should automatically start if it does not click the link in the image below.
Run the installer once the download is complete to bring up a window like below.
Use the settings in the following images (most are default settings):
Git is now installed on your PC
We must now change some of the settings manually within the applications that we have installed. Furthermore, we'll show steps on how to check that the software has been installed correctly.
All of this step will take place using the command prompt, getting access to this is described at the top of the page.
Firstly we wish to update the settings for Rust that we installed earlier this requires two commands, the first is:
rustup toolchain install nightly
Then click enter, then use:
rustup default nightly
This will update the rust settings. We can now check that we have installed everything correctly. We run each of the following commands in turn.
- Git -
git --version - Rust -
rust --version - .Net -
dotnet --version
This will give us an input that looks like:
If your output looks like this then the software is installed correctly.
We can now clone the repository that contains the Catalyst project, this is done using the command git clone https://github.com/catalyst-network/Catalyst.git in the command prompt.
The output should look like:
This means that the repository has been downloaded successfully
We can now enter the Catalyst repository, this is done with the command cd Catalyst
Catalyst relies on some external submodules that are built into the project, these must be updated and downloaded also, this is done using the command git submodule update --init --recursive --force. The output of which should look like.
We can now move into src file in the Catalyst repository, this is where the source code for the project is held. We do this by using cd src on the Command Prompt. Now we can build the solution, this is done by running the command dotnet build Catalyst.sln. The final lines of the output should look like:
Now we can run the node for the first time. During this process we must set 3 passwords for the node:
- Node Password
- IPFS Password
- SSL Certificate Password
First we must change directory again, this time using cd Catalyst.Node.POA.CE from the command prompt. Then we use the command dotnet run. We will fist be asked to create the node password as below.
Enter your desired password and press enter. The console will then ask for you to provide your IPFS password.
Once again enter your desired password and press enter. Finally it will ask you to type in a password for your certificate.
Type in the password you want to set it too and press enter.