Configuration
Command line options
Please note, there are numerous options available that can be deployed to override the configuration on the runtime whilst starting the Lisk Core.
To overwrite config options from the command line, execute the following commands below:
LISK_NETWORK=[network] LISK_CONFIG_FILE=[config-path] LISK_ADDRESS=[address] LISK_WS_PORT=[port] pm2 start lisk
The flag options are deprecated. Therefore it is recommend to pass the options as ENV variables. |
node dist/index.js -p [port] -a [address] -c [config-path] -n [network]
You can pass devnet
(default), alphanet
, betanet
, testnet
, or mainnet
for the [network]
option.
All ENV variables are restricted with a operating system constraint of ENV variable maximum length.
|
Comma-separated lists will replace the original config values.
For example, If |
Each of these options listed below can be appended in the command line:
Command line Option | ENV Variable | Description |
---|---|---|
|
|
Any of these options can be used |
|
|
Pass the custom configuration file, which will override values of the following: |
|
|
TCP port for P2P layer. |
|
|
TCP port for HTTP API. |
|
|
Listening host name or IP. |
|
|
Log level for file output. |
|
Log level for console output. |
|
|
Enable or disable cache. Must be set to true/false. |
|
|
|
PostgreSQL database name to connect to. |
|
PostgreSQL database host name. |
|
|
PostgreSQL database port. |
|
|
PostgreSQL database username to connect to. |
|
|
PostgreSQL database password to connect to. |
|
|
|
Redis host name. |
|
Redis port. |
|
|
Redis database name to connect to. |
|
|
Redis database password to connect to. |
|
|
|
Comma separated list of peers to connect to in the following format: |
|
Enable or disable public access of http API. Must be set to true/false. |
|
|
Comma separated list of IPs to enable API access. Format: |
|
|
Comma separated list of delegates to load in the following format: |
|
|
Comma separated list of IPs to enable access to forging endpoints. Format: |
|
|
Rebuilds certain database tables on the basis of the local blockchain data. Must be followed by an integer, that specifies the last delegate round that should be part of the rebuild. If 0 is specified, all rounds are rebuilt. |
|
|
Comma separated list of modules, that shall be loaded in a separate process.
To enable inter process communication, set |
Config file structure
A breakdown of all available options for the configuration file can be found in the Lisk SDK docs.