This document details how to install Lisk Core from source, but there are two other ways to participate in the network: binaries and Docker images. If you have satisfied the requirements from the Pre-Installation section, you can jump directly to the next section Installation Steps.
- Managing Lisk
- Configuring Lisk
- Utility Scripts
- Performance Monitoring
The following dependencies need to be installed in order to run applications created with the Lisk SDK:
You can find further details on installing these dependencies in our pre-installation setup guide. Clone the Lisk Core repository using Git and initialize the modules.
git clone https://github.com/LiskHQ/lisk-core.git cd lisk-core git checkout master npm ci npm run build
To test Lisk is built and configured correctly, issue the following command at the root level of the project:
To pretty-print the console logs:
node dist/index.js | npx bunyan -o short
This will start the lisk instance with
devnet configuration. Once the process is verified as running correctly, use
CTRL+C to quit the running application.
Optionally, start the process with
pm2. This will fork the process into the background and automatically recover the process if it fails.
npx pm2 start --name lisk dist/index.js
After the process is started, its runtime status and log location can be retrieved by issuing the following command:
npx pm2 show lisk
To stop Lisk after it has been started with
pm2, issue the following command:
npx pm2 stop lisk
NOTE: The port, address and config-path can be overridden by providing the relevant command switch:
npx pm2 start --name lisk dist/index.js -- -p [port] -a [address] -c [config-path] -n [network]
You can pass any of
mainnet for the network option.
More information about options can be found at Command Line Options.
- The Lisk configuration is managed under different folder structures.
- Root folder for all configuration is
- The default configuration file that used as a base is
- You can find network specific configurations under
- Don't override any value in files mentioned above if you need custom configuration.
- Create your own
jsonfile and pass it as command line options
- Configurations will be loaded in the following order, lowest in the list has the highest priority:
- Default configuration file
- Network specific configuration file
- Custom configuration file (if specified by the user)
- Command line configurations, specified as command
- Any config option of array type gets completely overridden. If you specify one peer at
peers.listin your custom config file, it will replace every default peer for the network.
- For development use
devnetas the network option.
Command Line Options
There are plenty of options available that you can use to override configuration on runtime while starting the lisk.
node dist/index.js -- [options]
Each of that option can be appended to the command-line. There are also a few
ENV variables that can be utilized for this purpose.
|Option||ENV Variable||Config Option||Description|
|LISK_NETWORK||Which configurations set to use, associated to lisk networks. Any of this option can be used
|LISK_CONFIG_FILE||Path to the custom configuration file, which will override values of
|LISK_WS_PORT||wsPort||TCP port for P2P layer|
|LISK_HTTP_PORT||httpPort||TCP port for HTTP API|
|LISK_ADDRESS||address||Listening host name or ip|
|LISK_FILE_LOG_LEVEL||fileLogLevel||Log level for file output|
|LISK_CONSOLE_LOG_LEVEL||consoleLogLevel||Log level for console output|
|LISK_CACHE_ENABLED||cacheEnabled||Enable or disable cache. Must be set to true/false|
|LISK_DB_NAME||db.database||PostgreSQL database name to connect to|
|LISK_DB_HOST||db.host||PostgreSQL database host name|
|LISK_DB_PORT||db.port||PostgreSQL database port|
|LISK_DB_USER||db.user||PostgreSQL database username to connect to|
|LISK_DB_PASSWORD||db.password||PostgreSQL database password to connect to|
|LISK_REDIS_HOST||redis.host||Redis host name|
|LISK_REDIS_DB_NAME||redis.db||Redis database name to connect to|
|LISK_REDIS_DB_PASSWORD||redis.password||Redis database password to connect to|
|LISK_PEERS||peers.list||Comma separated list of peers to connect to in the format
|LISK_API_PUBLIC||api.access.public||Enable or disable public access of http API. Must be set to true/false|
|LISK_API_WHITELIST||api.access.whiteList||Comma separated list of IPs to enable API access. Format
|LISK_FORGING_DELEGATES||forging.delegates||Comma separated list of delegates to load in the format publicKey|encryptedPassphrase,publicKey2|encryptedPassphrase2|
|LISK_FORGING_WHITELIST||forging.access.whiteList||Comma separated list of IPs to enable access to forging endpoints. Format
|Number of rounds to include in the snapshot, must be a positive integer equal to or greater than
ENVvariables restricted with operating system constraint of
ENVvariable maximum length.
- Comma-separated lists will replace the original config values. e.g. If you specify
peers.list, which is specific to the network, will be replaced completely.
For a more detailed understanding of configuration read this online documentation
Change Redis Port
redis.port configuration attribute in
config/devnet/config.json or any other network you want to configure.
- Recreate the database to run the tests against a new blockchain:
dropdb lisk_dev createdb lisk_dev
- Launch Lisk (runs on port 4000):
NODE_ENV=test node dist/index.js
There are a couple of command line scripts that facilitate users of lisk to perform handy operations. All scripts are located under
./framework/src/modules/chain/scripts/ directory and can be executed directly by
This script will help you to generate a unified version of the configuration file for any network. Here is the usage of the script:
Usage: generate_config [options] Options: -h, --help output usage information -V, --version output the version number -c, --config [config] custom config file -n, --network [network] specify the network or use LISK_NETWORK
network is required and can by
mainnet or any other network folder available under
This script keeps track of all changes introduced in Lisk over time in different versions. If you have one config file in any of specific version and you want to make it compatible with other versions of the Lisk, this scripts will do it for you.
Usage: update_config [options] <input_file> <from_version> [to_version] Options: -h, --help output usage information -V, --version output the version number -n, --network [network] specify the network or use LISK_NETWORK -o, --output [output] output file path
As you can see from the usage guide,
from_version are required. If you skip
to_version argument changes in config.json will be applied up to the latest version of Lisk Core. If you do not specify
--output path the final config.json will be printed to stdout. If you do not specify
--network argument you will have to load it from
LISK_NETWORK env variable.
This script is useful in development. It will initialize the components of Lisk and load these into Node.js REPL.
node framework/src/modules/chain/scripts/console.js initApplication: Application initialization inside test environment started... initApplication: Target database - lisk_dev initApplication: Rewired modules available initApplication: Fake onBlockchainReady event called initApplication: Loading delegates... initApplication: Delegates loaded from config file - 101 initApplication: Done lisk-core [lisk_dev] >
Once you get the prompt, you can use
config objects and play with these in REPL.
We used newrelic to monitor the activities inside the application. It enables to have detail insight into the system and keeps track of the performance of each activity. e.g. An HTTP API call or a background job from a queue.
To enable the performance monitoring on your node make sure you have an environment variable
available and set and then start the node normally. The monitoring data will be visible to your newRelic account with the
name of the network you started. e.g.
Copyright 2016-2019 Lisk Foundation
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Copyright © 2016-2019 Lisk Foundation
Copyright © 2015 Crypti
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.