Skip to content

Commit

Permalink
Documentation change (#4815)
Browse files Browse the repository at this point in the history
Co-authored-by: Hubert <[email protected]>
  • Loading branch information
AnjanaRatnayake and LesnyRumcajs authored Sep 30, 2024
1 parent 036a489 commit 9a91934
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 15 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,11 +137,12 @@ forest --config /path/to/your_config.toml
Example of config options available:

```toml
[client]
data_dir = "<directory for all chain and networking data>"
genesis_file = "<relative file path of genesis car file>"

[network]
listening_multiaddr = "<multiaddress>"
listening_multiaddrs = ["<multiaddress>"]
bootstrap_peers = ["<multiaddress>"]
```

Expand Down
29 changes: 15 additions & 14 deletions documentation/src/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,18 +37,19 @@ and provide it to the process with the `--config` flag or through the
The following is an sample configuration file:

```toml
genesis = "/path/to/genesis/file"
rpc = true
port = 1234
token = "0394j3094jg0394jg34g"
metrics-port = 2345
kademlia = true
mdns = true
import-snapshot = /path/to/snapshot/file
import-chain = /path/to/chain/file
skip-load = false
req-window = 100
tipset-sample-size = 10
target-peer-count = 100
encrypt-keystore = false
[client]
encrypt_keystore = false
genesis_file = "/path/to/genesis/file"

[chain]
name = "<NetworkName taken from localnet.json>"
type = "devnet"

[sync]
recent_state_roots = 1
request_window = 100
tipset_sample_size = 10

[network]
bootstrap_peers = ["<multiaddress>"]
```

0 comments on commit 9a91934

Please sign in to comment.