Skip to content
VSC Documentation

How to Deploy a VSC Validator Node

This repository hosts the Docker Compose file necessary for deploying the VSC node.

Prerequisites

Section titled “Prerequisites”

Requirements:

  • Hive account (100HP minimum for RCs)
  • 2000 Hive bonded to your VSC node (required for participating in consensus)
  • Technical knowledge of using a command line interface
  • Docker and docker-compose installed. Please see https://docs.docker.com/get-docker/ for installation guide for docker.

System requirements are very low, in the future requirements will rise as network usage incrases.

System requirements:

  • Raspberry pi 4 or better
  • 4 cores, 8GB ram or better

Setup

Section titled “Setup”
  1. Install Docker and Docker compose v2.
  2. git clone https://github.com/vsc-eco/vsc-deployment Clone this repository as a normal user (not root/admin) to a desired location. It’s crucial to ensure the Docker user has write permissions in the directory where you plan to initiate the Docker Compose file.
  3. docker compose run init Initialize the configuration files
  4. Edit the config file located at ./data/config/identityConfig.json and be sure to add in your Hive username and active key
  5. docker compose up -d Start the Docker containers. This will add a GraphQL server on port 8080, a MongoDB instance on port 27021, and a libp2p connection on port 10720.

Starting Up

Section titled “Starting Up”

To launch the node, execute docker compose up -d from the command line (or docker-compose up -d depending on your docker compose version).

For real-time log observation, use docker logs go-vsc-node -f.

Maintenance

Section titled “Maintenance”

The node is designed to self-update as necessary. However, on rare occasions, the deployment configuration may require manual updates not covered by automatic updates. Should such a situation arise, we will inform the community through our usual communication channels discord and twitter.

You can disable automatic updates by setting the environment variable AUTO_UPDATE to false. However, we recommend to keep this feature enabled to ensure the node is always up-to-date. In our rapidly evolving ecosystem, it’s crucial to keep the node updated for optimal network health.