Commander application set up

Setup and manage your Lisk Core conveniently with Lisk Commander.

Pre-install

To complete the installation some prerequisites need to be fulfilled. If you have already performed these, please proceed to the Installation chapter.

Install Lisk Commander

Please access the Lisk Commander documentation and follow the installation instructions.

Once the Lisk Commander is set up on your system, it is possible use the commands below to set up and manage your Lisk Core node.

Installation

Do not run this command with a user that has sudo rights.
If this is executed then the installation will be aborted, as it is not required and not recommended to install Lisk Core for a user with sudo rights.

You can freely choose the name of your Lisk Core instance.

Please note that it is necessary to refer to your custom name instead of lisk-mainnet or lisk-testnet when running the commands.

  • Mainnet

  • Testnet

lisk core:install lisk-mainnet

Running this command will install the latest version of Lisk Core into a directory: ~/.lisk/instances/lisk-mainnet.

To verify your node is running correctly, execute the following command:

lisk core:status lisk-mainnet
lisk core:install --network=testnet lisk-testnet

Running this command will install the latest version of Lisk Core into a directory: ~/.lisk/instances/lisk-testnet.

To verify your node is running correctly, execute the following command:

lisk core:status lisk-testnet
For all available options, see the Lisk Commander command reference for Lisk Core as well as the General command reference.

Available options

Add one or multiples of the options below to the core:install command. Multiple options are seperated by spaces.

Full Name Short Name Examples Description

--network

-n

  • --network=testnet

  • --network=betanet

  • -n=alphanet

  • --network=devnet

The network, you require Lisk Core to connect to. If you don’t specify this option, it will connect to the default network, (Mainnet).

--release-url

-r

--release-url=https://my-custom.url/testnet/2.1.0-rc.0/lisk-2.1.0-rc.0-Linux-x86_64.tar.gz

Define a custom URL for downloading the new Lisk Core application script. It is also required to have the checksum for the TAR file with the format 2.0.0-Linux-x86_64.tar.gz.SHA256 for the Commander to check the integrity of the application. You can refer to our Lisk Core application releases for the file naming convention.

--lisk-version

N/A

  • --lisk-version=2.0.0

  • --lisk-version=2.1.3

Define the exact version required to upgrade Lisk Core. If you do not specify the version, it will install the latest stable version of Lisk Core.

--snapshot-url

-s

--snapshot-url=https://snapshots.lisk.io/lisk/testnet/lisk_test_backup-9299232.gz

Define a custom URL for downloading the snapshot, that should be used during the setup of Lisk Core.

--no-snapshot

N/A

N/A

Set this option, if you do not want to use any snapshot during the setup of Lisk Core. In this case, your node will synchronize to the whole blockchain, starting from the genesis block. If you choose this option, it will take quite a significant amount of time to complete the the setup process.

--no-start

N/A

N/A

Set this option, if you do not wish the Lisk Core to start automatically after the installation.

Post-install

After the installation is completed, check which ports Lisk Core is listening to by checking the status using the applicable command shown below:

  • Mainnet

  • Testnet

lisk core:status lisk-mainnet
lisk core:status lisk-testnet

Check you network settings to verify the corresponding ports are open.

In addition it is also recommended to set up a log rotation.

If you are not running Lisk locally, you will need to follow the API - Configuration guide to enable access.

Assuming all of the above steps have been successfully completed, then the next step is to move on to the configuration documentation. If you wish to enable forging or SSL, please see the General configuration.