Skip to content

Commit 4460c07

Browse files
committed
Reword where to get peers from in understanding-config-files.md
Fixes input-output-hk/ouroboros-network#3691
1 parent 3b06d90 commit 4460c07

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

doc/getting-started/understanding-config-files.md

+13-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@ Tells your node to which nodes in the network it should talk to. A minimal versi
1919

2020
* `valency` tells the node how many connections your node should have. It only has an effect for dns addresses. If a dns address is given, valency governs to how many resolved ip addresses should we maintain active (hot) connection; for ip addresses, valency is used as a Boolean value, where `0` means to ignore the address.
2121

22-
Your __block-producing__ node must __ONLY__ talk to your __relay nodes__, and the relay node should talk to other relay nodes in the network. Go to our telegram channel to find out IP addresses and ports of peers.
22+
Your __block-producing__ node must __ONLY__ talk to your __relay nodes__, and
23+
the relay node should talk to other relay nodes in the network.
2324

2425
#### The P2P topology.json file
2526

@@ -94,6 +95,17 @@ signal to the `cardano-node` process, e.g. `pkill -HUP cardano-node`. After rece
9495
signal, `cardano-node` will re-read the file and restart all dns resolution. Please
9596
**note** that this only applies to the topology configuration file!
9697

98+
If you are synchronizing the network for the first time, please connect to IOG
99+
relays `relays.cardano-node.iohk.io` by adding it to your local root peers and
100+
set `useLedgerAfterSlot` to `0` (to disable ledger peers). You can use
101+
different relays as long as you trust them to provide you the honest chain.
102+
When the node is synced, you can remove it from the local root peers, you
103+
should also manually check if other stake pool relays are on the same chain as
104+
you are. Once you enabled ledger peers by setting `useLedgerAfterSlot` the
105+
node will connect to relays registered on the chain, and churn through them by
106+
randomly picking new peers (weighted by stake distribution) and forgetting 20%
107+
least performing ones.
108+
97109
#### The genesis.json file
98110

99111
The genesis file is generated with the `cardano-cli` by reading a `genesis.spec.json` file, which is out of scope for this document.

0 commit comments

Comments
 (0)