Configuration

A complete command reference with all available options for starting Klayr Core can be found in Klayr Core CLI’s reference page.

Using a network-specific default configuration

To quickly connect your Klayr Core node to a specific network, specify the desired network with the --network or -n flag.

This will use the default config file for the specific network when starting Klayr Core. The default configurations are located in the config folder of Klayr Core.

klayr-core start --network=NETWORK

NETWORK may be mainnet, testnet, or devnet.

Using a custom config file

Klayr Core uses the default config for connecting to the mainnet by default.

However, it is possible to use Klayr Core with a custom config, by specifying the path to the config file with the --config or -c flag.

The custom config file needs to follow the JSON config structure of Klayr Core. A straightforward method is to copy one of the network-specific default configs of Klayr Core and adjust it to suit your requirements.

/home/klayr/
cp .klayr/klayr-core/config/testnet/config.json custom-config.json
vim custom-config.json
If you intend to connect the node to the mainnet, change the testnet to the mainnet in the snippet above.
klayr-core start --config=/home/klayr/custom-config.json --overwrite-config
Remember to restart the node for the new config changes to take effect.

Enabling plugins

Plugins are not enabled by default. Dedicated flags can be used to enable them on the application start.

However, to enable the following plugins it is recommended to view the following detailed guides here, on how to register and enable the Misbehavior plugin, and also the Dashboard plugin.