Skip to content

Latest commit

 

History

History
56 lines (37 loc) · 2.62 KB

README.md

File metadata and controls

56 lines (37 loc) · 2.62 KB

hshelp - Tools for Handshake - More updates to come.

install-all-hsd

This script installs a Handshake full node (https://github.com/handshake-org/hsd) and all dependencies.

Prerequisites

  • Ubuntu or Debian
  • Static public IP address - this may not be required will look into it
  • 2GB RAM
  • Enough storage space, I was running out of space with a 50GB (had 1.2 GB left of free space so had to do a reimage of my machine) - check via df -h

If you install this on a new deployed system and currently work with user root consider using a different user with root privilegies.

adduser <Username>
usermod -aG sudo <Username>
su - <Username>

Installation

On a new deployed system this installation takes about 3 minutes before hsd full node is started as service. Duration of a full chain sync depends on your system, most important is fast storage. On performant entry level VPS it takes few hours.

sudo apt update
sudo apt install git
cd
git clone https://github.com/nglabs42/hshelp
hshelp/install-all-hsd

Per default all blockchain data, config and log files are under /opt/hsd_data. You can set an alternative path by adding it as parameter like hshelp/install-all-hsd /some/where/else.

2BDA7A6E-53AD-4F8A-B9F0-2E2E1A8C9AC9_4_5005_c

During this first chain sync hsd is still running as a non listening node. After you restart hsd or reboot - which also makes sense since most probably some installed components might require a reboot anyway - the node allows 800 inbound connections. Those could be other full nodes but also SPV nodes like hnsd or Fingertip. Running listening public full nodes are essential for Handshake, you do great support by running one!

Further Settings - ONLY IF YOU UPDATE TO LISTEN: TRUE

The node listens to port 12038 and 44806. Make sure you allowed those ports on incoming traffic.

If you don't use any firewall consider running one like ufw and set the specific ports. (Don't forget to set your ssh port ;-)

Service and Usage

Some useful commands - hsd status: systemctl status hsd - hsd restart: sudo systemctl restart hsd

hsd node is accessable via hsd-cli, hsw-cli and API. Full documentation: https://hsd-dev.org/api-docs/

To check the current outbound and inbound connections call hsd-cli info|jq .pool

hsd Update

If you run the script while hsd is already installed it will try to update to the latest master release.