Skip to main content

Use a profile

To help you get started quickly, Besu provides pre-configured profiles containing custom settings for some common use cases. You can load these profiles using the --profile CLI option. For example:

besu --config-file=config.toml --profile=staker

In this example, config.toml is the user-provided configuration file, and staker is the pre-configured profile containing custom settings.

Any configuration options explicitly set in the configuration file or command line will overwrite the same options set in the profile. See the configuration order of precedence for more information.

You can use the following profiles:

You can also load external profiles.

note

Run ./besu --help to view all available profiles.

Minimalist staker profile​

For stakers who want to maximize their hardware value but don't want to serve full sets of data to their peers, Besu provides a minimalist staker profile. See the minimalist staker profile on GitHub for the custom settings.

To use the minimalist staker profile, run Besu with --profile set to minimalist_staker:

besu --profile=minimalist_staker

Staker profile​

For stakers who want to maximize their hardware value and also want to serve full sets of data to their peers, Besu providers a staker profile. See the staker profile on GitHub for the custom settings.

To use the staker profile, run Besu with --profile set to staker:

besu --profile=staker

Enterprise/Private profile​

For private network operators who want to minimize confusion by setting sensible defaults, Besu provides an enterprise/private profile. This profile is designed to handle specific use cases for private network operators. See the enterprise/private profile on GitHub for the custom settings.

To use the enterprise/private profile, run Besu with --profile set to enterprise or private:

besu --profile=enterprise

or

besu --profile=private
note

enterprise and private are aliases for the same profile.

Load external profiles​

You can use external profiles to create custom Besu bundles with various plugins and their default options.

Add external profiles to a profiles directory under the root Besu directory. Run Besu with --profile set to the external profile file name, without the .toml extension. For example, to load the profiles/custom_profile.toml profile, run:

besu --profile=custom_profile
note

You can overwrite the directory in which to place external profiles using the besu.profiles.dir system property.