Installation with Docker

This guide describes how to setup Lisk Service with Docker. Alternative options of how to install Lisk Service are described on the Setup page.

Prerequisites

The following dependencies are required to install and run Lisk Service with Docker.

Development tools

  • Ubuntu / Debian

  • MacOS

Install the build-essential package alongside with several development tools.

For example, use apt if running Ubuntu as shown in the following command below:

apt install build-essential git

Brew

Install Brew by following the most recent instruction.

If you already have Brew installed, ensure it is working and is the latest version.

brew update
brew doctor

Xcode

Install Xcode essentials coming from Apple.

xcode-select --install

Docker

  • Ubuntu / Debian

  • MacOS

To install Docker Compose, please refer to install docker compose.

To configure Docker so it can be run without sudo rights, follow: linux post install.

Please refer to Docker installation for Mac. Please note that Docker for Mac already includes Docker Compose. Install make using XCode.

Open necessary ports

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

  • 9901: API (HTTP)

Installation

Clone the lisk-service GitHub repository and then navigate into the project folder.

In the directory where you want to store Lisk Service
git clone https://github.com/LiskHQ/lisk-service.git
cd lisk-service

Lisk Service is now ready to use on your machine.

You may now directly start it with:

Inside of the lisk-service root folder
make up

The command make up will use the latest released version of Lisk Service on Docker Hub.

In case you wish to build from your local version of Lisk Service, firstly you need to run make build as shown below:

How to build Lisk Service from local files
make build
make up

This will start Lisk Service with the default configuration, which will connect to a Lisk Core Mainnet node.

In case a different node or network shall be used, configure Lisk Service accordingly.

You can stop Lisk Service again with the following command:

make down

More commands about how to manage Lisk Service are described on the Docker commands page.

Check the Usage section for examples of how to use and interact with Lisk Service.