Skip to content

Commit 5b5ba84

Browse files
committed
Updated docs
1 parent 9d76b52 commit 5b5ba84

File tree

2 files changed

+25
-1
lines changed

2 files changed

+25
-1
lines changed

docs/docs/get_started/building.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,6 @@ This will create a binary in `./target/release/commit-boost-signer`. To verify i
166166
The signer needs the following environment variables set:
167167
- `CB_CONFIG` = path of your config file.
168168
- `CB_JWTS` = a dummy key-value pair of [JWT](https://en.wikipedia.org/wiki/JSON_Web_Token) values for various services. Since we don't need them for the sake of just testing the binary, we can use something like `"test_jwts=dummy"`.
169-
- `CB_SIGNER_PORT` = the network port to listen for signer requests on. Default is `20000`.
170169

171170
Set these values, create the `keys` and `secrets` directories listed in the configuration file, and run the binary:
172171

docs/docs/get_started/configuration.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,13 @@ Commit-Boost supports both local and remote signers. The signer module is respon
3939
To start a local signer module, you need to include its parameters in the config file
4040

4141
```toml
42+
[pbs]
43+
...
44+
with_signer = true
45+
46+
[signer]
47+
port = 20000
48+
4249
[signer.local.loader]
4350
format = "lighthouse"
4451
keys_path = "/path/to/keys"
@@ -64,6 +71,10 @@ We currently support Lighthouse, Prysm, Teku and Lodestar's keystores so it's ea
6471

6572
#### Config:
6673
```toml
74+
[pbs]
75+
...
76+
with_signer = true
77+
6778
[signer]
6879
port = 20000
6980

@@ -89,7 +100,13 @@ We currently support Lighthouse, Prysm, Teku and Lodestar's keystores so it's ea
89100

90101
#### Config:
91102
```toml
103+
[pbs]
104+
...
105+
with_signer = true
106+
92107
[signer]
108+
port = 20000
109+
93110
[signer.local.loader]
94111
format = "prysm"
95112
keys_path = "wallet/direct/accounts/all-accounts.keystore.json"
@@ -112,6 +129,10 @@ We currently support Lighthouse, Prysm, Teku and Lodestar's keystores so it's ea
112129

113130
#### Config:
114131
```toml
132+
[pbs]
133+
...
134+
with_signer = true
135+
115136
[signer]
116137
port = 20000
117138

@@ -136,6 +157,10 @@ We currently support Lighthouse, Prysm, Teku and Lodestar's keystores so it's ea
136157

137158
#### Config:
138159
```toml
160+
[pbs]
161+
...
162+
with_signer = true
163+
139164
[signer]
140165
port = 20000
141166

0 commit comments

Comments
 (0)