Configuring Iroha
Iroha is configured via a TOML file and/or Environment Variables.
The path to the configuration file should be passed through the --config CLI argument:
shell
iroha --config iroha_config.tomlIf the peer submits the genesis:
shell
# `iroha_config.toml` should contain `genesis.file` and `genesis.private_key`
iroha --config iroha_config.toml --submit-genesisStructure
- List links to all modules, giving high-level overview of them
- List required parameters
| Module Name | Description | Required fields |
|---|---|---|
| Base | Basic, root-level parameters | chain_id, public_key, private_key |
| Genesis | Genesis block configuration | genesis.public_key, and possibly genesis.file & genesis.private_key |
| Network | ? | network.address |
| Torii | ? | torii.address |
| Sumeragi | ? | sumeragi.trusted_peers if doesn't submit the genesis |
| Kura | ? | |
| Queue | ? | |
| Snapshot | ? | |
| Logger | ? | |
| Telemetry | ? | |
| Chain Wide | ? |
Example Configuration
- Show minimal TOML
- Show same minimal ENVs
- Refer to
peer.template.tomlin the repo, or show it here under the spoiler.
Extends feature
- You can compose configuration files together using the
extendsroot-level field
Required Parameters
public_key: explain the optionprivate_key: explain the optionnetwork.address: explain the optiongenesis.public_key: explain the optiongenesis.private_keyif the peer is the one who submits the genesis. explain the optionsumeragi.trusted_peers: explain the option. It is not strictly required, but you might need to set it in most cases.torii.address: explain the option
Modules Overview
TODO: list each section (sumeragi, torii, kura etc) with links and short explanations of their responsibility.