Private network command line options

This reference describes the syntax of the Besu private network command line interface (CLI) 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.

Specify options

You can specify Besu options:

• On the command line.

  besu [OPTIONS] [SUBCOMMAND]

• As an environment variable. For each command line option, the equivalent environment variable is:

  • Uppercase.
  • _ replaces -.
  • Has a BESU_ prefix.

  For example, set --miner-coinbase using the BESU_MINER_COINBASE 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

caution

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.

Options

permissions-accounts-config-file

Syntax

--permissions-accounts-config-file=<FILE>

Example

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

Environment variable

BESU_PERMISSIONS_ACCOUNTS_CONFIG_FILE=/home/me/me_configFiles/myPermissionsFile

Configuration file

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

Syntax

--permissions-accounts-config-file-enabled[=<true|false>]

Example

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

Environment variable

BESU_PERMISSIONS_ACCOUNTS_CONFIG_FILE_ENABLED=true

Configuration file

permissions-accounts-config-file-enabled=true

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

permissions-nodes-config-file

Syntax

--permissions-nodes-config-file=<FILE>

Example

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

Environment variable

BESU_PERMISSIONS_NODES_CONFIG_FILE=/home/me/me_configFiles/myPermissionsFile

Configuration file

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

Syntax

--permissions-nodes-config-file-enabled[=<true|false>]

Example

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

Environment variable

BESU_PERMISSIONS_NODES_CONFIG_FILE_ENABLED=true

Configuration file

permissions-nodes-config-file-enabled=true

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

poa-block-txs-selection-max-time

Syntax

--poa-block-txs-selection-max-time=<INTEGER>

Example

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

Environment variable

BESU_POA_BLOCK_TXS_SELECTION_MAX_TIME=80

Example configuration file

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 and proof-of-work networks, see --block-txs-selection-max-time.