Lisk Core Binary Setup

This document details how to setup Lisk Core Binary distribution on a system.

Pre-Install

To complete the installation some prerequisites need to be fulfilled. If you have already performed these, please proceed to the Installation chapter.

Determine if your platform can run Lisk Core

Supported Platforms

  • Ubuntu 18.04 (LTS) x86_64

  • Ubuntu 16.04 (LTS) x86_64

Ports

Mandatory: Always open the WebSocket port of your desired network, to enable communication with other peer nodes.

Optional: Open the corresponding HTTP port for your network, to make your node’s API reachable. For more info, see the diagram on the Interact with network page.

To connect to the desired network with Lisk Core, please ensure that the corresponding ports are open:

Network HTTP WebSocket

Mainnet

8000

8001

Testnet

7000

7001

Devnet

4000

5000

These are the default ports for connecting with the network. They can be altered later in the config.json file.

Install dependencies

sudo apt-get update
sudo apt-get install curl wget tar unzip zip ntp

Create a new user

To run and manage a Lisk Core node in the future, please create a separate lisk user like so:

  • Ubuntu

  • MacOS

The lisk user itself does not need any sudo rights to run Lisk Core.

It is sufficient to create a group docker and add the newly created user to that group, to enable the user to use Docker (see: https://docs.docker.com/install/linux/linux-postinstall/).

sudo adduser lisk              (1)
sudo groupadd docker           (2)
sudo usermod -aG docker lisk   (3)
1 create a new user
2 create docker group
3 add the user to docker group

It is not essentially needed to set up a lisk user, especially when you are runnign a local instance for development pruposes.

If you still want to do it, we recommend to create the user using the macOS GUI: https://support.apple.com/en-gb/guide/mac-help/mtusr001/mac

Installation

This section details how to install Lisk Core using pre-built binary packages. Once completed, you will have a functioning node on the Lisk Network. If you are looking to upgrade your current Lisk Core installation, please see the Upgrade Binary section.

Login to the Lisk user

The user was created in the Binary - Prerequisites Section. If you are already logged in to this user, please skip this step.

sudo -u lisk -i

Execute the installation script

This will configure the environment, download and install Lisk Core. Before proceeding, determine whether you wish to connect your node to the Testnet (Test Network) or the Mainnet (Main Network).

  • Mainnet

  • Testnet

Download Lisk Core:

wget https://downloads.lisk.io/lisk/main/installLisk.sh

To connect your node to the Mainnet, run:

bash installLisk.sh install -r main

Download Lisk Core:

wget https://downloads.lisk.io/lisk/test/installLisk.sh

To connect your node to the Testnet, run:

bash installLisk.sh install -r test

You will be prompted for your installation directory, pressing enter will choose the default.

Next, you will be prompted, if you wish to synchronize from the Genesis block. If you answer `no', which is the default option, the node will download a recent snapshot of the database. This will be much faster than synching from the genesis block.

The installation may take a few minutes. Check the output of the script to verify that the installation was successful.

If you recognize an error, try to resolve it by analyzing the error output, otherwise, you can have a look at our Troubleshooting Section.

Verify successful installation

When the installation script has finished, navigate inside of the newly created folder lisk-main(for Mainnet) or lisk-test(for Testnet). You can verify that your Lisk node is up and running, by running the following command:

bash lisk.sh status

For further information and how to administer your Lisk node, please have a look at our Administration Section.

If you are not running Lisk locally, you will need to follow the Configuration - API document to enable access.

With all of the above steps complete you are ready to move on to the configuration documentation if you wish to enable forging or SSL, please see General Configuration.

Post-installation (optional)