Cover photo

Installing VOI Swarm Platform

System Requirements

Ensure your system meets the following requirements:

  1. Operating System: Linux (Ubuntu 20.04 or later recommended).

  2. Hardware:

    • CPU: 4 cores or more.

    • Memory: 8 GB RAM or more.

    • Disk Space: Minimum 100 GB free space.

  3. Network:

    • Stable internet connection.

    • Open required ports for communication (e.g., 8545, 30303).


Step 1: Update Your System

Start by updating the package list and upgrading your current packages to the latest versions.

sudo apt update && sudo apt upgrade -y

Step 2: Install Dependencies

VOI Swarm requires several dependencies. Install them with the following commands:

# Install Git
sudo apt install git -y

# Install Docker
sudo apt install docker.io -y

# Install Docker Compose
sudo apt install docker-compose -y

# Install Node.js (version 16.x or later)
curl -fsSL https://deb.nodesource.com/setup_16.x | sudo -E bash -
sudo apt install -y nodejs

Verify installations:

docker --version
docker-compose --version
node --version
npm --version

Step 3: Clone the VOI Swarm Repository

Use Git to clone the VOI Swarm repository to your local machine:

git clone https://github.com/voinetwork/voi-swarm.git
cd voi-swarm

Step 4: Configure Environment Variables

Copy the example .env file and edit it to configure your environment settings:

cp .env.example .env
nano .env

Set the necessary variables in the .env file, such as:

  • Node URL

  • Wallet credentials

  • Port configurations

Save and exit (Ctrl+O, Ctrl+X).


Step 5: Build and Run the Services

Use Docker Compose to build and run the VOI Swarm services:

docker-compose up --build -d

This will:

  • Pull the required Docker images.

  • Build the containers.

  • Start the VOI Swarm services in detached mode.


Step 6: Verify Installation

Check the running containers:

You should see the VOI Swarm containers running. Access the web interface or interact with the platform using its APIs.


Step 7: Maintain and Update

To stop the services:

docker-compose down

To update the platform:

git pull origin main
docker-compose up --build -d