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

Lisk Core from Source Setup

Pre-Install

This document details the prerequisites to install Lisk Core 1.0.0 from a Source installation using tagged releases on Github.
To complete the installation there are prerequisites that need to be fulfilled. If you have already performed these, please proceed to the Installation chapter.

Firstly, please determine if your platform can install Lisk Core from source.

Supported Platforms
  • Ubuntu 14.04 (LTS) x86_64
  • Ubuntu 16.04 (LTS) x86_64
  • Ubuntu 18.04 (LTS) x86_64
  • MacOS 10.12 (Sierra)
  • MacOS 10.13 (High Sierra)

Open necessary ports

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

Network httpPort(HTTP) wsPort(TCP)
Mainnet 8000 8001
Testnet 7000 7001
Betanet 5000 5001
Devnet 4000 5000

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

Create a new user

In order to install the required prerequisites, it is necessary to have a user with sudo rights on the server.
In order to run and manage a Lisk Core node in the future, please create a separate 'Lisk' user like so:

Ubuntu

Note

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

sudo adduser lisk

Tool chain components

Used for compiling dependencies.

Ubuntu

sudo apt-get update
sudo apt-get install -y python build-essential curl automake autoconf libtool ntp

MacOS

Ensure that both XCode and Homebrew are installed.

Update homebrew and install dependencies:

brew update
brew doctor
brew install curl automake autoconf libtool

Git

Git is used for cloning and updating Lisk.

Ubuntu

sudo apt-get install -y git

MacOS

brew install git

Node.js

Node.js serves as the underlying engine for code execution.

Install System wide via package manager, like so:

Ubuntu

curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
sudo apt-get install -y nodejs

MacOS

brew install node@8.14.0

Node version manager

We recommend to use a Node version manager such as NVM.
NVM is a bash script that enables you to manage multiple active Node.js versions.

  1. Login as lisk user, that has been created in the first step:
    su - lisk
  2. Install nvm following these instructions
  3. Install the correct version of Node.js using nvm:
    nvm install 8.14.0

For the following steps, logout from the 'lisk' user again with CTRL+D, and continue with your user with sudo rights.

PM2

PM2 manages the node process for Lisk.

Note

Though it is not required to install a process manager such as PM2 to run Lisk Core, we recommend it as it simplifies administration of Lisk Core from Source.

sudo npm install -g pm2

PostgreSQL (version 10)

Ubuntu

Firstly, install postgreSQL on your machine:

sudo apt-get purge -y postgres* # remove all already installed postgres versions
sudo sh -c 'echo "deb http://apt.postgresql.org/pub/repos/apt/ $(lsb_release -cs)-pgdg main" > /etc/apt/sources.list.d/pgdg.list'
sudo apt install wget ca-certificates
wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | sudo apt-key add -
sudo apt update
sudo apt install postgresql-10

After installation, you should see the postgres database cluster, by running

  pg_lsclusters

Drop the existing database cluster, and replace it with a cluster with the locale en_US.UTF-8:

  sudo pg_dropcluster --stop 10 main
  sudo pg_createcluster --locale en_US.UTF-8 --start 10 main

Create a new database user called lisk and grant it rights to create databases:

  sudo -u postgres createuser --createdb lisk

Switch to the lisk user and create the databases, where {network} is the network you want to connect your Lisk Core node to:

  su - lisk
  createdb lisk_{network}

For the following steps, logout from the lisk user again with CTRL+D, and continue with your user with sudo rights.
Change 'password' to a secure password of your choice.

  sudo -u postgres psql -d lisk_{network} -c "alter user lisk with password 'password';"

MacOS

brew install postgresql@10
initdb /usr/local/var/postgres -E utf8 --locale=en_US.UTF-8
brew services start postgresql@10
createdb lisk_{network}

{network} is the network you want to connect your Lisk Core node to.

Installing Redis

Ubuntu

sudo apt-get install redis-server

Start redis:

sudo service redis-server start

Stop redis:

sudo service redis-server stop

MacOS

brew install redis

Start redis:

brew services start redis

Stop redis:

brew services stop redis
Note

Lisk does not run on the redis default port of 6379. Instead it is configured to run on port: 6380. Due to this, in order to run Lisk, you have one of two options:

  1. Change the Lisk configuration

In the next installation phase, remember to update the Redis port configuration in both config.json and test/data/config.json.

  1. Change the Redis launch configuration

Update the launch configuration file on your system. Note that there are a number of ways to do this.

The following is one example:

  1. Stop redis-server
  2. Edit the file redis.conf and change: port 6379 to port 6380
    • Ubuntu/Debian: /etc/redis/redis.conf
    • MacOS: /usr/local/etc/redis.conf
  3. Start redis-server

Now confirm that redis is running on port 6380:

redis-cli -p 6380
ping

And you should get the result PONG.

If you have finished all above steps successfully, your system is ready for installation of Lisk Core.

Installation

This section details how to install Lisk Core from Source. When completed, you will have a functioning node on the Lisk Network. If you are looking to upgrade your current Lisk Core installation, please see Upgrade from Source.

Login as the Lisk user

This user was created in the Prerequisites.
If you are already logged in to this user, please skip this step.

su - lisk

Installing Lisk from Source

Before proceeding, determine whether you wish to connect your node to the Mainnet (Main Network) or Testnet (Test Network).

git clone https://github.com/LiskHQ/lisk.git
cd lisk
git checkout v1.1.0 -b v1.1.0 # check out latest release tag
npm install
Note

Please check for latest release on https://github.com/LiskHQ/lisk/releases

To test that Lisk Core is built and configured correctly, issue the following command to connect to the network:

node app.js --network [network]

Where [network] might be either testnet or mainnet.

If the process is running correctly, no errors are thrown in the logs.
By default, errors will be logged in logs/lisk.log only. You can change the logging level in config.json.
Once the process is verified as running correctly, CTRL+C and start the process with pm2.
This will fork the process into the background and automatically recover the process if it fails.

pm2 start --name lisk app.js -- --network [network]

Where [network] might be either testnet or mainnet.

For details on how to manage or stop your Lisk node, please have a look in Administration from Source.

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 for more information.

Post-installation (optional)

Logrotate Setup

It is recommended to setup a log rotation for the logfile of Lisk Core.

Ubuntu

Ubuntu systems provide a service called logrotate for this purpose.
Please ensure Logrotate is installed on your system:

logrotate --version

Next, create a new file called lisk in the logrotate directory /etc/logrotate.d:

cd /etc/logrotate.d
touch lisk

Inside this file, define the parameters for the log rotation.

Example values:

/path/to/lisk/logs/*.log { 
        daily                   # daily rotation
        rotate 5                # keep the 5 most recent logs
        maxage 14               # remove logs that are older than 14 days
        compress                # compress old log files
        delaycompress           # compress the data, after it has been moved
        missingok               # if no logfile is present, ignore
        notifempty              # do not rotate empty log files
}

After customizing the config to fit your needs and saving it, you can test it by doing a dry run:

sudo logrotate /etc/logrotate.conf --debug