Document how to load external profiles (#1650)

* Document how to load external profiles Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net> * remove .toml extension Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net> --------- Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net> Co-authored-by: Alexandra Tran <alexandra.tran@consensys.net> Co-authored-by: Joan E <153745173+joaniefromtheblock@users.noreply.github.com>
hyperledger · Jul 18, 2024 · 091bf90 · 091bf90
1 parent 616f4a0
commit 091bf90
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 0 deletions.
diff --git a/docs/public-networks/how-to/use-configuration-file/profile.md b/docs/public-networks/how-to/use-configuration-file/profile.md
@@ -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
@@ -80,3 +86,21 @@ 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
+file name, without the `.toml` extension.
+For example, to load the `profiles/custom_profile.toml` profile, run:
+
+```bash
+besu --profile=custom_profile
+```
+
+:::note
+You can overwrite the directory in which to place external profiles using the `besu.profiles.dir`
+system property.
+:::
diff --git a/docs/public-networks/reference/cli/options.md b/docs/public-networks/reference/cli/options.md
@@ -2961,6 +2961,8 @@ 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),
+ without the `.toml` extension
 
 ### `random-peer-priority-enabled`