For the best viewing experience, please turn your phone to portrait mode.

Lisk Core Binary Setup

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

Option A: Lisk Commander

Setup and manage your Lisk node conveniently with Lisk Commander.

Note: This setup option is supported from Lisk Core v2.0.0 upwards.
If you have Lisk Core v1.6 or lower installed, you wont be able to upgrade your node with Lisk Commander.
In this case, use the bash script or remove your old version and make a fresh install with Lisk Commander.

Pre-Installation

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 the network page.

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

Lisk Core installed by lisk Commander currently uses the default ports, incremented by +2. If you want to change it back to the default ports ports, just change the config of your Lisk Core, once it's installed.

Network HTTP WebSocket
Mainnet 8002 8003
Testnet 7002 7003
Devnet 4002 5002

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

Install Lisk Commander

Head to the Lisk Commander docs and follow the installation instructions.

Once Lisk Commander is set up on your system, you can use the commands below to set up/manage your Lisk Core node.

Installation

lisk core:install lisk-mainnet

This will install Lisk Core latest version into a directory lisk-mainnet.

To verify your node is running correctly, run e.g.

lisk core:status lisk-mainnet

See for all available options the Lisk Commander Command reference for Lisk Core as well as the general Command reference.

Post-Install

After installation, check which ports Lisk Core is listening by checking the status:

lisk core:status lisk-mainnet

Check you network settings to verify, the corresponding ports are open.

It's also recommended to set up a log rotation.

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.

Option B: The Bash script

Pre-Install

Determine if your platform can run Core

Supported Platforms
  • Ubuntu 18.04 (LTS) x86_64
  • Ubuntu 16.04 (LTS) x86_64

To complete the installation some prerequisites need to be fulfilled. If you have already performed these, please proceed to the Installation chapter. Please follow the instructions below to load the required software to your system.

Open the necessary 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 the 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 user to run Lisk

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

sudo adduser lisk

Install

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

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

Testnet

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)


What's next?
Docker