Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document how to load external profiles #1650

Merged
merged 5 commits into from
Jul 18, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/public-networks/how-to/use-configuration-file/profile.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,12 @@ You can use the following profiles:
- [Staker profile](#staker-profile)
- [Enterprise/Private profile](#enterpriseprivate-profile)

You can also [load external profiles](#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
Expand Down Expand Up @@ -80,3 +86,20 @@ 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`](../../reference/cli/options.md#profile) set to the external profile.
For example, to load the `profiles/custom_profile.toml` profile, run:

```bash
besu --profile=custom_profile.toml
alexandratran marked this conversation as resolved.
Show resolved Hide resolved
```

:::note
You can overwrite the directory in which to place external profiles using the `besu.profiles.dir`
system property.
:::
1 change: 1 addition & 0 deletions docs/public-networks/reference/cli/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -2960,6 +2960,7 @@ Possible values are:
- [`minimalist_staker`](../../how-to/use-configuration-file/profile.md#minimalist-staker-profile)
- [`staker`](../../how-to/use-configuration-file/profile.md#staker-profile)
- [`enterprise` or `private`](../../how-to/use-configuration-file/profile.md#enterpriseprivate-profile) (aliases for the same profile)
- File name of an [external profile](../../how-to/use-configuration-file/profile.md#load-external-profiles)

### `random-peer-priority-enabled`

Expand Down
Loading