Skip to main content
Version: Next

Using A Script

The simplest way to get started with HOPR is to run our script to install hoprd. The script will install all the required dependencies, including node.js version 16. If you have nvm installed, it will use it.

Warning

Please bear in mind that at the time of writing, hoprd only has been tested in version 16.

If you are a MacOS M1 user, please refer to the npm guide, this script will not work for you.

Setup and install HOPRd

Our script will ask you to accept our Privacy Policy, and afterwards prompt you for a version to install. You can use any of our public releases, but latest also works.

$ bash -c "$(curl -s https://raw.githubusercontent.com/hoprnet/hopr-sh/master/setup-hoprd.sh)"

██╗ ██╗ ██████╗ ██████╗ ██████╗
██║ ██║██╔═══██╗██╔══██╗██╔══██╗
███████║██║ ██║██████╔╝██████╔╝
██╔══██║██║ ██║██╔═══╝ ██╔══██╗
██║ ██║╚██████╔╝██║ ██║ ██║
╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═╝ ╚═╝

By installing this node, you agree to our Privacy Policy found at https://hoprnet.org/privacy-policy
Do you agree to our Privacy Policy? [y/n]:y
Terrific!
Warning! Running this script repeatedly will cause you to have a new node address each time.
Would you like to run this script? [y/n]:y
What release are you installing? Example: athens (The latest community release version you will find on the docs page)
athens

You might need to restart your terminal for your computer to be able to find hoprd after the script completes installation.

Ubuntu or Debian

Type following commands into your terminal, if you are using a VPS, log in into your VPS.

$ sudo apt install -y curl
$ curl https://raw.githubusercontent.com/hoprnet/hopr-sh/master/setup-hoprd.sh --output setup-hoprd.sh
$ chmod +x setup-hoprd.sh
$ ./setup-hoprd.sh
$ cd athens

macOS

Type following commands into your terminal. If you have not installed the XCode Command-line utils, please install them via:

xcode-select --install

Also check whether you have installed Homebrew - the OSX package manager - and install it if it is not installed yet.

$ brew install curl
$ curl https://raw.githubusercontent.com/hoprnet/hopr-sh/master/setup-hoprd-macos.sh --output setup-hoprd.sh
$ chmod +x setup-hoprd.sh
$ ./setup-hoprd.sh
$ cd athens

One-liner

If you like to live dangerously and have no regards to safety and trust us (you shouldn’t) and want a one-liner script, here it is.

bash -c "$(curl -s https://raw.githubusercontent.com/hoprnet/hopr-sh/master/setup-hoprd.sh)"

(we even removed the $ so you can copy and paste that on your terminal, you savage).

Running HOPRd

run hoprd

DEBUG="hopr*" npx hoprd --init --admin --identity ./hoprd-id-athens --data ./hoprd-db-athens --password='open-sesame-iTwnsPNg0hpagP+o6T0KOwiH9RQ0' --rest --restHost "0.0.0.0" --restPort 3001 --apiToken='<YOUR_SECRET_TOKEN>'
Important

If you want to secure your hoprd admin UI, in the command line you must use --apiToken tag.

<YOUR_SECRET_TOKEN> - Replace it with your own password (don't use "<>").

Password should contain:

  • at least 8 symbols
  • a lowercase letter
  • uppercase letter
  • a number
  • a special symbol

This ensures the node cannot be accessed by a malicious user residing in the same network.