Private network configuration options

This reference describes the syntax of the Besu private network configuration options.

Important

This reference contains options that apply to only private networks. For options that apply to both private and public networks, see the public network options reference.

You can specify options:

• On the command line. Options are part of the command line interface (CLI); run besu --help to display all options and subcommands.

• As an environment variable.

• In a configuration file.

If you specify an option in more than one place, the order of priority is command line, environment variable, configuration file.

If using Bash or Z shell, you can view option suggestions by entering -- and pressing the Tab key twice.

besu --Tab+Tab

warning

Characters such as smart quotes and long (em) hyphens don't work in Besu command line options. Ensure quotes aren't automatically converted to smart quotes, or double hyphens combined into em hyphens.

---

permissions-accounts-config-file

Command line example

--permissions-accounts-config-file=/home/me/me_configFiles/myPermissionsFile

Environment variable example

BESU_PERMISSIONS_ACCOUNTS_CONFIG_FILE=/home/me/me_configFiles/myPermissionsFile

Config file example

permissions-accounts-config-file="/home/me/me_configFiles/myPermissionsFile"

The accounts permissions configuration file. The default is the permissions_config.toml file in the data directory.

tip

--permissions-accounts-config-file and --permissions-nodes-config-file can use the same file.

---

permissions-accounts-config-file-enabled

Command line example

--permissions-accounts-config-file-enabled=true

Environment variable example

BESU_PERMISSIONS_ACCOUNTS_CONFIG_FILE_ENABLED=true

Config file example

permissions-accounts-config-file-enabled=true

Enables or disables file-based account level permissions. The default is false.

---

permissions-nodes-config-file

Command line example

--permissions-nodes-config-file=/home/me/me_configFiles/myPermissionsFile

Environment variable example

BESU_PERMISSIONS_NODES_CONFIG_FILE=/home/me/me_configFiles/myPermissionsFile

Config file example

permissions-nodes-config-file="/home/me/me_configFiles/myPermissionsFile"

The nodes permissions configuration file. The default is the permissions_config.toml file in the data directory.

tip

--permissions-nodes-config-file and --permissions-accounts-config-file can use the same file.

---

permissions-nodes-config-file-enabled

Command line example

--permissions-nodes-config-file-enabled=true

Environment variable example

BESU_PERMISSIONS_NODES_CONFIG_FILE_ENABLED=true

Config file example

permissions-nodes-config-file-enabled=true

Enables or disables file-based node level permissions. The default is false.

---

poa-block-txs-selection-max-time

Command line example

--poa-block-txs-selection-max-time=80

Environment variable example

BESU_POA_BLOCK_TXS_SELECTION_MAX_TIME=80

Config file example

poa-block-txs-selection-max-time=80

The maximum time that can be spent selecting transactions to be included in a block, as a percentage of the fixed block time of the network. The default is 75, or 75%.

note

This option only applies to proof-of-authority networks. For proof-of-stake networks, see --block-txs-selection-max-time.

---

poa-discovery-retry-bootnodes

Command line example

--poa-discovery-retry-bootnodes=true

Environment variable example

BESU_POA_DISCOVERY_RETRY_BOOTNODES=true

Config file example

poa-discovery-retry-bootnodes=true

When enabled, Besu always uses bootnodes during peer table refresh on Proof of Authority (PoA) networks. When disabled, bootnodes are only used on first startup. If bootnodes are unavailable after startup, the node may not discover new peers until it is restarted. The default is true.

note

This option only applies to proof of authority (private) networks.