Skip to content

Commit 05c0392

Browse files
committed
Update docs
1 parent 1e24660 commit 05c0392

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

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

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,10 +81,21 @@ A minimal version of this file looks like this:
8181
DNS domain `y.y.y.y` (assuming they are), and try to maintain a connection with at least `1` of the
8282
resolved IPs.
8383

84-
* `valency` tells the node how many connections your node should try to pick
85-
from the given group. If a DNS address is given, valency governs to how many
84+
* `valency` (or `hotValency`) tells the node how many connections your node should try to
85+
pick from the given group. If a DNS address is given, valency governs to how many
8686
resolved ip addresses should we maintain active (hot) connection.
8787

88+
- `warmValency` is an optional field similar to `valency`/`hotValency` that tells the node
89+
how many peers the node should maintain as established (warm). As said, this field is
90+
optional and defaults to the value set in the `valency`/`hotValency` field. The
91+
`warmValency` value set should be greater than or equal to the one specified in
92+
`valency`/`hotValency` otherwise `valency`/`hotValency` will be truncated to this value.
93+
We recommend users to set `warmValency` value to `hotValency` + 1 in order to keep at
94+
least 1 backup peer to be promoted to hot in case something happens.
95+
96+
Check [here](https://github.com/input-output-hk/ouroboros-network/issues/4565) for more
97+
context on this `WarmValency` addition.
98+
8899
* Local roots groups shall be non-overlapping.
89100

90101
Your __block-producing__ node must __ONLY__ talk to your __relay nodes__, and the relay node should talk to other relay nodes in the network.

0 commit comments

Comments
 (0)