Docker setup
This document describes how to run Lisk Core as a Docker image-based container.
Lisk Core version 4 does not have any external dependencies and hence does not require using docker-compose
.
Pre-installation
Create a new user
To run and manage a Lisk Core node in the future, please create a separate lisk
user as described below:
The |
sudo adduser lisk (1)
1 | Create a new user. |
It is not necessarily required to set up a lisk
user, especially when you are running a local instance for development purposes.
However, if it is required then it is recommended to create the user using the MacOS GUI.
Install Docker
To run Lisk Core in Docker, firstly it is necessary to install the Docker engine. Determine if your platform can run Docker as described below.
Please refer to https://docs.docker.com/engine/installation
Please refer to the Docker installation for ubuntu
Configure Docker, in order that it can be run without sudo rights: linux post install
|
Install make
using your package manager.
For example, use apt-get
if running Ubuntu as shown below:
sudo apt-get install curl make
Please refer to Docker installation for Mac.
Install make
using XCode.
Please refer to Docker installation for Windows
Lisk Core download
git clone https://github.com/LiskHQ/lisk-core.git (1)
cd lisk-core/docker (2)
git checkout v4.0.0 -b v4.0.0 (3)
1 | Clone the repository. |
2 | Navigate into the lisk-core root folder. |
3 | Check out the latest release tag. |
Please check for the latest release in the Lisk Core releases list. |
Run
Podman
podman can be used.
Simply replace occurrences of |
Create a "lisk-core" container:
docker run --volume lisk-data:/home/lisk/.lisk \
--publish 5001:5001 \
--name lisk-core \
lisk/core:4.0.0 \
start --network=mainnet
The default log levels for Mainnet are:
So if you start the node, it won’t show any logs in the console.
This is the recommended setting for reducing the number of logs for a running node.
However, to verify that the node started correctly, update the log levels in the config to Alternatively, start the node with the following flag:
|
docker run --volume lisk-data:/home/lisk/.lisk \
--publish 5001:5001 \
--name lisk-core \
lisk/core:4.0.0 \
start --network=testnet
Configuration
Further parameters can be passed after --network
, for example, as shown below:
docker run --volume lisk-data:/home/lisk/.lisk \
--publish 5001:5001 \
--publish 127.0.0.1:5000:5000 \
--name lisk-core \
lisk/core:4.0.0 \
start --network=testnet --enable-http-api-plugin
Environment variables can be set with --env
:
docker run --volume lisk-data:/home/lisk/.lisk \
--publish 5001:5001 \
--env LISK_CONSOLE_LOG_LEVEL=debug \
--name lisk-core \
lisk/core:4.0.0 \
start --network=testnet
An example with all possible flags set is shown below:
docker run -d --volume /data:/home/lisk/.lisk \
--publish 7000:7000 --publish 8080:8080 --publish 7008:7008\
--name lisk-core lisk/core:4.0.0 start --network=testnet --port 7000\
--api-ws --enable-http-api-plugin --http-api-plugin-port 7008\
--http-api-plugin-host host.docker.internal --http-api-plugin-whitelist 0.0.0.0/0 \
--api-ws --api-ws-port 8080 --api-ws-host 0.0.0.0
Import blockchain snapshot
docker run --volume lisk-data:/home/lisk/.lisk -it --rm lisk/core:4.0.0 blockchain download --network=betanet --output=/home/lisk/.lisk/tmp/
docker run --volume lisk-data:/home/lisk/.lisk -it --rm lisk/core:4.0.0 blockchain import /home/lisk/.lisk/tmp/blockchain.db.tar.gz
docker run --volume lisk-data:/home/lisk/.lisk -it --rm --entrypoint rm lisk/core:4.0.0 -f /home/lisk/.lisk/tmp/blockchain.db.tar.gz
docker start lisk-core
docker logs -f lisk-core