Installation with Docker
How to set up Lisk Service and connect it to a local Lisk Core node.
Lisk Service is a web application middleware that allows interaction with various blockchain networks based on the Lisk protocol. It is recommended to set up a blockchain node first, before setting up Lisk Service.
It is strongly recommended to synchronize your blockchain node with the network before starting the Lisk Service.
- Supported Platforms
Ubuntu 20.04 (LTS) x86_64
Ubuntu 22.04 (LTS) x86_64
The following system requirements are recommended:
Machines with a minimum of 8 GB RAM for the Mainnet.
Machines with a minimum of 8 GB RAM for the Testnet.
Machines with a minimum of 40 GB HDD.
The following dependencies are required to install and run Lisk Service with Docker.
build-essential package alongside several development tools.
For example, use
apt if running Ubuntu as shown in the following command below:
apt install build-essential git
If you already have Brew installed, ensure it is working and is the latest version.
Install Xcode essentials coming from Apple.
Please refer to Docker installation for Mac. Please note that Docker for Mac already includes Docker Compose.
Clone the lisk-service GitHub repository and then navigate into the project folder.
git clone https://github.com/LiskHQ/lisk-service.git
Switch to the latest release branch.
git checkout v0.7.0
To build Lisk Service from local files, first, navigate to the
lisk-service repository on your system:
Lisk Service is now ready to use on your machine.
If you skipped the step to configure Docker to run without
Before running the application copy the default docker-compose environment file:
cp docker/example.env .env
In the next step, open
.env to set the required environment variables.
# Lisk ecosystem configuration LISK_APP_WS=ws://host.docker.internal:7887
example.env assumes that the blockchain node e.g. Lisk Core node is running on the host machine, and not inside of a Docker container.
When running a blockchain node inside of a Docker container, the following variable needs to refer to the container. For this to work, the container running the blockchain node and the Lisk Service Blockchain Connector container must share the same docker network:
# Lisk ecosystem configuration LISK_APP_WS="ws://<your_docker_container>:7887"
|For a complete list of supported environment variables check the Lisk Service Configuration Reference.|
Run the following command to start Lisk Service:
You can stop Lisk Service again with the following command:
More commands about how to manage Lisk Service are described on the Docker commands page.