From 220eced48a64c4bc9800bda4360d21db3490660e Mon Sep 17 00:00:00 2001 From: Josh Stein <46639943+jcstein@users.noreply.github.com> Date: Mon, 20 Nov 2023 14:30:37 -0500 Subject: [PATCH] chore: linting for import to docs (#605) --- docs/bootstrapper.md | 26 +++++++++++++++++++------- 1 file changed, 19 insertions(+), 7 deletions(-) diff --git a/docs/bootstrapper.md b/docs/bootstrapper.md index a1c55903..38a610f0 100644 --- a/docs/bootstrapper.md +++ b/docs/bootstrapper.md @@ -1,12 +1,16 @@ # Blobstream bootstrapper -To bootstrap the Blobstream P2P network, we use the bootstrapper Blobstream node type to accept connections from freshly created orchestrators/relayers and share its peer table with them. +To bootstrap the Blobstream P2P network, we use the bootstrapper Blobstream +node type to accept connections from freshly created orchestrators/relayers +and share its peer table with them. ## How to run ### Install the Blobstream binary -Make sure to have the Blobstream binary installed. Check [the Blobstream binary page](https://docs.celestia.org/nodes/blobstream-binary) for more details. +Make sure to have the Blobstream binary installed. Check +[the Blobstream binary page](https://docs.celestia.org/nodes/blobstream-binary) +for more details. ### Init the store @@ -16,7 +20,11 @@ Before starting the bootstrapper, we will need to init the store: blobstream bootstrapper init ``` -By default, the store will be created un `~/.bootstrapper`. However, if you want to specify a custom location, you can use the `--home` flag. Or, you can use the following environment variable: +By default, the store will be created un `~/.bootstrapper`. However, +if you want to specify a custom location, you can use the `--home` flag. +Or, you can use the following environment variable: + + | Variable | Explanation | Default value | Required | | ------------------- | ----------------------------------- | ----------------- | -------- | @@ -24,9 +32,11 @@ By default, the store will be created un `~/.bootstrapper`. However, if you want ### Add keys -The P2P private key is optional, and a new one will be generated automatically on the start if none is provided. +The P2P private key is optional, and a new one will be generated automatically +on the start if none is provided. -The `p2p` sub-command will help you set up this key if you want to use a specific one: +The `p2p` sub-command will help you set up this key if you want to use a specific +one: ```sh blobstream bootstrapper p2p --help @@ -55,8 +65,10 @@ Use "blobstream bootstrapper [command] --help" for more information about a comm ### Open the P2P port -In order for the bootstrapper node to work, you will need to expose the P2P port, which is by default `30000`. +In order for the bootstrapper node to work, you will need to expose the P2P +port, which is by default `30000`. #### Systemd service -An example of a systemd service that can be used for bootstrappers can be found in the orchestrator documentation. +An example of a systemd service that can be used for bootstrappers can be +found in the orchestrator documentation.