Installation Instructions

Before you begin, important things to know:

1. Current supported region: EU

2. Current Supported architectures: x86

3. Check if your Firewall Ports are open: https://www.yougetsignal.com/tools/open-ports/

4. Always ensure your hardware and operating system are up-to-date.

5. Install the node on your own risk

6. Keep your node updated to the latest version to avoid being downgraded to the Testnet.

7. We offer limited one-on-one support, as we cannot remotely access your device. Please provide logs and system information so that we can better assist you.

There are multiple scenarios for installing the node on your system, each tailored to different environments and requirements. To start participating in the network, follow the steps outlined below for each scenario.

Befor you start the installation, make sure to met the Minimum Requirements

1. Linux Systems (Debian LTS or Ubuntu LTS):

   • Ensure Docker is installed and properly configured.

   • Run the node Script and follow the installation instructions.

   • Follow the onboarding

1. Windows Systems:

   • Use Windows Server for optimal performance and stability.

   • Install Docker and verify its functionality.

   • Download and install the node software, then configure it as needed.

1. NAS Systems:

   • Check the compatibility of your NAS OS with virtualization and Minimum Requirements

   • Install Docker or a compatible virtualization tool.

   • Follow the node installation guide specific to NAS environments.

General Settings for all Systems:

Regardless of your system, the Node requires some information from you. You can skip these steps, and the default values will be applied. Below are all the settings needed to complete the installation.

Setting	Default Value	Comment
Data source	Linux: /var/lib/wesendit-node/data Windows: No Path specified	Choose the path where the data will be stored. Please note that the system will reserve the specified space after onboarding.
Configuration	Linux: /var/lib/wesendit-node/config Windows: No Path specified	All your node configuration is stored in this folder, including information about the Node ID and locally cached system data. Please note that this folder is crucial for the Master Node to recognize your Storage Node. If you manipulate or modify this folder, the node will be blocked, and your stake may be slashed.
Master node Port	TCP 41631	This port must be open on your firewall and accessible to the Master Node; otherwise, the setup process will fail. You can change this on the installation if you run multiple nodes behind the same IP.
Storage node Port	TCP 41630	Local frontend: This connection is used to complete the onboarding process and regularly check the dashboard of your Storage node. It does not need to be publicly accessible. We recommend keeping it local, as there is no SSL by default.

As response time is critical, you can test the ping in advance with the script:

wget https://wesendit.io/setup/ping_test.sh
chmod +x ping_test.sh
./ping_test.sh

Installing on Linux

Installing the node on a native Linux distribution is the most common method for running a Storage node. Below, you will find detailed instructions and helpful tips on what you need to prepare, along with the necessary command lines.

1. Check Compatibility

Installing Docker on Linux is straightforward. Docker provides comprehensive documentation for all systems. To verify if your OS supports Docker and the WeSendit Storage node, refer to the table and check the row labeled 'x86_64 / amd64' on documentation.

If you're starting with a freshly installed Linux system or if there are no other services running on this OS, you can use our installation script to set up Docker and the node with a single click.

1. Install Docker

Follow Installation instructions for Debian, Ubuntu or other systems in the docker documentation.

1. Install the Node

For Linux systems, we've prepared a script for your convenience. Simply download it, make it executable, and run the script. This script will download and run WeSendit-Node Container as well as the Watchtower Container to monitor updates and keep it on the newes version.

Download the script:

If wgetis not installed, try sudo apt install wgetor search the web for installation instructions.

// Code for plain Linux installation including docker

// Debian
wget https://wesendit.io/setup/install_debian.sh
chmod +x install_debian.sh
sudo ./install_debian.sh

//Ubuntu
wget https://wesendit.io/setup/install_ubuntu.sh
chmod +x install_ubuntu.sh
sudo ./install_ubuntu.sh

Install Node

Ensure you're in the correct directory. Use the command ls -la to view the contents of the current folder.

Either by running the script

// Code for plain Linux installation if docker is installed

wget https://wesendit.io/setup/run_node.sh
chmod +x run_node.sh
sudo ./run_node.sh

Or installing manually on docker. With this method, you need to set up the watchtower on your own.

docker pull wesendit/node

Add your configuration and storage folders to your system. Then, replace <DATA_DIR> and <CONFIG_DIR> in the command below and execute it.

docker run -d -p 41630:41630 -p 41631:41631 --name wesendit-node -v <DATA_DIR>:/var/lib/wesendit-node/data -v <CONFIG_DIR>:/etc/wesendit-node --restart unless-stopped wesendit/node

if you install the Node manually, you need to take care of the updates with "watchtower". This ensures, your node rund on the latest version.

To update the node, you can run watchtower for checking and update all your containers. Please check your environment first and choose the appropriate arguments for your setup.

docker run -d --name watchtower -v /var/run/docker.sock:/var/run/docker.sock containrrr/watchtower --interval 3600 --cleanup

With this command, you're Installing watchtower and update container every 1h

Run Node:

You will be prompted to provide some information during the script execution. Be cautious with the settings unless you are confident in your choices. If you're unsure, simply press Enter to skip the steps, and the installation will proceed with the default (recommended) settings.

./run_node.sh

That's all, DONE! Open the Browser with the IP or localhost with the Port 41630 and start Onboarding.

Installing on Windows

As stated in the minimum requirements, ensure you choose the appropriate Windows OS for 24/7 operation. Misconfiguration or using an unsuitable OS can lead to downtime, which will negatively impact your node quality and score.

1. Download and Install Docker

Docker Install packages are available on Dockerdocs. Check the Architecture compatibility before you install Docker.

1. Install and run Container

After successfully installing Docker, ensure that it is running. Installation through the DockerHUB- Search is currently not possible due to technical requirements.

As this scenario is less common, we will add the script at a later stage.

Open Command line interface