Skip to content
This repository has been archived by the owner on Apr 15, 2024. It is now read-only.

Commit

Permalink
chore: linting for import to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jcstein committed Nov 20, 2023
1 parent acc5d07 commit 98b01b7
Showing 1 changed file with 19 additions and 7 deletions.
26 changes: 19 additions & 7 deletions docs/bootstrapper.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -16,17 +20,23 @@ 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:

<!-- markdownlint-disable MD013 -->

| Variable | Explanation | Default value | Required |
| ------------------- | ----------------------------------- | ----------------- | -------- |
| `BOOTSTRAPPER_HOME` | Home directory for the bootstrapper | `~/.bootstrapper` | Optional |

### 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
Expand Down Expand Up @@ -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.

0 comments on commit 98b01b7

Please sign in to comment.