ABT Node can be installed in the following ways :

You can use either of the above ways to deploy it on any infrastructure like Cloud, Virtual machines, workstations, etc.

If you are interested in running ABT Node locally on your device, we currently support Linux and macOS. If you are using another OS like Windows, we recommend using Windows Subsystem Linux (WSL), or you can use a virtual machine and make sure your ABT Wallet can access your VM's IP address.

Use the binary distribution

ABT Node is a NodeJS application. You must have NodeJS Runtime and Node Package Manager (NPM) to install it.

Environment Setup

You need to install NodeJS and NPM for installing ABT Node binary. ArcBlock recommends using Node Version Manager(NVM) for installing NodeJS.

Step 1: Install NVM

Install NVM using the below command:

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.3/install.sh | bash
Sample output

install nvm

Step 2: Install Node.js and npm

Get the latest LTS version of Node.js using the below command (you can list all versions with nvm ls-remote):

nvm ls-remote | grep 'Latest LTS'
Sample output

list Node.js versions

At the time of writing this document, the latest LTS version was v14.16.1

Then, install Node.js, which will automatically install npm (replace v10.22.0 with the version number):

nvm install v14.16.1  
Sample output

install Node.js

Note: You can install the latest version of Node.js by running nvm install-latest-npm command:

Install ABT Node

Execute the below command to install ABT Node :

npm install -g @abtnode/cli
Sample output

Install ABT Node

Configure ABT Node

After installing the ABT Node binary, you must initialize the node and provide a directory location for storing configuration.

  1. Run the abtnode init command to initialize the ABT Node
  2. Once initialized, the system will confirm the directory where you want to store the configuration.
  3. After confirming, the system will automatically generate your ABT Node configuration.
  4. Now, start the ABT Node Service by executing the abtnode start command.
Sample output

Start ABT Node

  1. You can stop ABT Node service by executing abtnode stop command.
Sample output

Stop ABT Node

Access ABT Node

The above command will start the ABT Node server on 8089. You can access the ABT Node on /admin request path (http://18.217.238.146:8089/). After this, you must agree to License terms before accessing the ABT Node dashboard.

ABT Node Terms

Please do not access the ABT Node using localhost / 127.0.0.1 address. You will not be able to connect it using ABT wallet.

Use the official Docker image

You can run ABT Node by using the official Docker image

docker run -d -p 80:80 -p 443:443  -v "$(pwd)":/data/abtnode arcblock/abtnode

Docker images are based on the Debian Linux platform.

Access ABT Node

The above command will start the ABT Node container and bind it to port 80 / 443 on the Host machine. You should access it using the IP address of the Host machine (http://192.168.1.5/). Please do not access the ABT Node using localhost / 127.0.0.1 address. You will not be able to connect it using ABT wallet.

ABT Node

After this, you must agree to License terms before accessing the ABT Node dashboard.

ABT Node Terms

Use AWS Marketplace

You can run ABT Node on AWS using AWS Marketplace

  1. You must select Continue to subscribe from the overview tab, MarketPlace
  2. You are presented with Terms and Conditions, to which you must agree by clicking Accept Terms. Accept Terms
  3. After the subscription authorization is complete Continue to Configuration will be enabled. Click it to proceed Subscription
  4. Select ABT Node version and AWS region, then click Continue to Launch Product Config
  5. You are on the Launch page, where you must provide the following instance details :

    • Select Launch from Website for the Choose Acton dropdown.
    • Select EC2 instance type.
    • Select appropriate VPC Settings, followed by Subnet Settings
    • In Security Group Settings select an existing security Group or create one by clicking "Create new based on seller setting".
    • select / create a key pair under Key Pair Settings
    • Click Launch to deploy ABT Node using the provided configuration

Launch

Security Group Ports


Please make a note of the ports that are opened in the associated security group. The standard ports are: 80 (HTTP) and 443 (SSL/HTTPS). We do not recommend opening port 22(SSH) unless required by your organisation practices.


Access ABT Node

AWS will take some time to create an application instance. After the confirmation message, you should open the EC2 Dashboard to get the Public IP, and AWS-provided sub-domain of the ABT Node instance.

EC2 Instance

You can access the ABT Node on /admin request path using either of the following locations :

  • Non secured Access : You can access ABT Node on HTTP by using the IP address (http://18.219.164.196/admin) or the AWS-provided sub-domain (http://ec2-18-219-164-196.us-east-2.compute.amazonaws.com/admin). HTTP Access
  • Secured Access : ArcBlock provides HTTPS access to AWS hosted ABT Nodes using a convention-based sub-domain(ipv4convention.ip.abtnet.io). You can determine the sub-domain by replacing the dot(.) separator in IPv4 address with the dash(-) separator. The above hosted ABT Node is available on https://18-219-164-196.ip.abtnet.io/admin. HTTPS Access

ArcBlock recommends using the secured approach over the non-secured approach. The admin page presents License terms to which you must agree before accessing the ABT Node dashboard.

ABT Node works on HTTPS using a sub-domain certificate (ip.abtnet.io). Accessing it using AWS provided public IPv4 address(http://18.219.164.196/admin) or sub-domain(https://ec2-18-219-164-196.us-east-2.compute.amazonaws.com/admin) gives an error of invalid certificate.