Full Node Cheat Sheet
Full Node Cheat Sheet Using Systemd & Cosmovisor
This cheat sheet provides quick copy-pasta like instructions for installing and running a Full Node using an automated script.
If you're interested in understanding the underlying details, or having full control over every step of the process, check out the Full Node Walkthrough.
- Introduction
- Pre-Requisites
- Install and Run a Full Node using Cosmovisor
- FAQ & Troubleshooting
- [OPTIONAL] Do you care to know what just happened?
Introduction
This guide will help you install a Full Node for Pocket Network, using helper that abstract out some of the underlying complexity.
Running a Full Node is the first step toward becoming a Validator, Supplier, or Gateway.
Pre-Requisites
- Linux-based System: Ensure you have a Debian-based Linux distribution (other distributions may work but are not fully supported).
- Root or Sudo Access: You need administrative privileges to run the installation script.
- Dedicated Server or Virtual Machine: Any provider should work (Vultr and Hetzner have been tested).
Install and Run a Full Node using Cosmovisor
This section script will handle the installation of dependencies, user creation,
environment variable setup, and configuration of Cosmovisor and poktrolld
.
Follow the instructions below to quickly install and set up a Full Node:
-
Download the Installation Script:
curl -O https://raw.githubusercontent.com/pokt-network/poktroll/main/tools/installer/full-node.sh
-
Run the Script with Sudo Privileges:
sudo bash full-node.sh
-
Follow the Prompts:
- Choose the Network: Select
testnet-alpha
,testnet-beta
, ormainnet
. - Set Username: Input the desired username to run
poktrolld
(default:poktroll
). - Set Node Moniker: Input the node moniker (default: your
hostname
). - Confirm Seeds and Genesis File: The script fetches seeds and the genesis file automatically.
- External IP Address: The script detects your external IP address. Confirm or input manually if incorrect.
- Choose the Network: Select
Automatic Upgrades Out of the Box
Your node is configured to handle chain upgrades automatically through Cosmovisor. No manual intervention is required for standard upgrades.
When a chain upgrade is proposed and approved:
- Cosmovisor will download the new binary
- The node will stop at the designated upgrade height
- Cosmovisor will switch to the new binary
- The node will restart automatically
FAQ & Troubleshooting
See the FAQ & Troubleshooting section in the Full Node Walkthrough for examples of useful commands, common debugging instructions and other advanced usage.
[OPTIONAL] Do you care to know what just happened?
This section is optional and for informational purposes only.
If you're interested in understanding what just got installed, keep reading...
-
System User: A dedicated user (default:
poktroll
) is created to run the node securely. -
Cosmovisor: A binary manager that handles chain upgrades automatically:
- Location:
/home/poktroll/bin/cosmovisor
- Purpose: Manages different versions of
poktrolld
and handles chain upgrades - Configuration: Set up to automatically download and switch to new binaries during upgrades
- Location:
-
Poktrolld: The core node software:
- Location:
/home/poktroll/.poktroll/cosmovisor/genesis/bin/poktrolld
- Configuration:
/home/poktroll/.poktroll/config/
- Data:
/home/poktroll/.poktroll/data/
- Location:
-
Systemd Service: A service that manages the node:
- Name:
cosmovisor.service
- Status: Enabled and started automatically
- Configured for automatic restarts and upgrades
- Name: