Setup dVPN Node

This document provides a comprehensive guide for setting up and running an Erebus dVPN node. By participating as a node operator, you contribute to the security and decentralization of the Erebus network, while earning rewards for your contribution.

Supported Chains

• Aptos

• EVM

• Solana (Coming Soon)

• SUI (Coming soon)

Prerequisites:

• Operating System Supported: Linux and MacOS.

• Minimum hardware requirement : 2GB RAM, 1vCPU .

• Incoming traffic on port 51820, 9080 & 9002 is allowed.

• A computer with a reliable internet connection (preferably wired).

• Basic understanding of command line interface (CLI) tools i.e. terminal

• An Erebus Node Operator account (i.e. valid mnemonic on supported chain)

Installation

1. Install the Node Software

Open bash terminal and run below command in bash terminal

sudo bash <(curl -s https://raw.githubusercontent.com/NetSepio/erebrus/node_installer/install-node.sh)

Erebrus dVPN - Node Installation

• Confirm to continue with the installation and installer will start installing the dependencies.

Erebrus dVPN - Dependencies Installation

2. Configure the Node

• Follow on-screen instructions and guided setup process and configure all parameters as prompted.

Erebrus dVPN - Configure Parameters

• Following are the configuration parameters for the dVPN node

Parameter	Description	Required ?
Installation Directory	Absolute path name, where erebrus node will be installed. (Default: Current working directory)	Yes
Public IP	Public IP for dVPN node to listen on. This must be publicly routable IP address. (Default: Automatically detected)	Yes
Chain	Preferred chain to run the Erebrus dVPN node on. See list of supported chains (Default: None)	Yes
Mnemonic	Valid mnemonic on selected chain	Yes

3. Verify Configuration

• Verify configured parameters on screen and approve it for node installation to proceed. If any parameter is not correct, select "n/N" at the prompt and installer will exit.

Erebrus dVPN - Configuraiton Parameter Verification

• Once configuration parameters are confirmed at the prompt, installer will initiate the public IP reachability test to verify if provided public IP is routable and reachable from internet on port 9080, 51820 and 9001.

• Once IP reachability test is completed successfully, installer will start node installation.

Erebrus dVPN - Node Startup

• After successful installation, node will attempt to start the dVPN services as part of final stage. dVPN node will be functional as the end of this stage and the installer will finish. successfully.

Erebrus dVPN - Successful Installation

Node Maintenance

• Regularly update the node software to benefit from security patches and performance improvements. Instructions on how to update will be provided.

• Monitor your node's health and resource usage. Recommendations on monitoring tools (coming soon)

• Ensure your internet connection remains stable for optimal node performance.

Troubleshooting

1. Dependency Installation Failed

Symptom: The installation process fails during dependency installation.

Solution:

• Check the Log File: Review the error.log file in the current directory for detailed error messages.

• Docker Installation Failed: If the failure is related to Docker installation, it might be due to privilege issues.

  • Ensure you have the necessary permissions to install and run Docker.

  • On Linux, you might need to add your user to the Docker group:

    bashCopy codesudo usermod -aG docker $(whoami)

  • After adding the user to the Docker group, log out and log back in to apply the changes.

2. IP Traceability Failed

Symptom: The node installation fails with errors related to IP traceability.

Solution:

• Check Public IP Reachability: Ensure your public IP address is reachable from the internet.

• Open Required Ports: Verify that the following ports are open and accessible from the internet:

  • 51820

  • 9002

  • 9080

• Check the Log File: See the error.log file for more details on the issue.

3. Invalid Mnemonic

Symptom: The provided mnemonic is reported as invalid during the installation process.

Solution:

• Verify Mnemonic: Ensure the mnemonic you provided is valid and consists of exactly 12 words.

• Correct Format: The mnemonic should be a series of words separated by spaces. Verify there are no extra spaces or missing characters.

4. Node Already Running

Symptom: The installation process fails because an Erebrus dVPN node is already running.

Solution:

• Check Running Containers: Verify if the Erebrus dVPN node is already running.

  • List all running Docker containers:

    docker ps

  • Look for any containers related to Erebrus.

• Stop and Remove Containers: If the Erebrus containers are running, stop and remove them before proceeding with the installation:

  docker stop <container_id>
  docker rm <container_id>

  Replace <container_id> with the actual container ID of the Erebrus node.

Additional Resources

For further assistance, please consult the Erebrus documentation or reach out to the support team. The error.log file in the current directory is an invaluable resource for diagnosing specific issues encountered during installation.

Security Considerations:

• Emphasize the importance of protecting your Erebus Node Operator account credentials.

• Recommend keeping the node software and operating system updated with the latest security patches.

• Consider best practices for securing your server environment.