Browse Source

docs: add explanation of p2p configuration options (#5397)

## Description

Add information on p2p settings in documentation 

Closes: #XXX
pull/5413/head
Marko 4 years ago
committed by GitHub
parent
commit
b802e9c9c3
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 0 deletions
  1. +14
    -0
      docs/tendermint-core/configuration.md

+ 14
- 0
docs/tendermint-core/configuration.md View File

@ -476,3 +476,17 @@ Here's a brief summary of the timeouts:
- `timeout_commit` = how long we wait after committing a block, before starting - `timeout_commit` = how long we wait after committing a block, before starting
on the new height (this gives us a chance to receive some more precommits, on the new height (this gives us a chance to receive some more precommits,
even though we already have +2/3) even though we already have +2/3)
## P2P settings
This section will cover settings within the p2p section of the `config.toml`.
- `external_address` = is the address that will be advertised for other nodes to use. We recommend setting this field with your public IP and p2p port.
- `seeds` = is a list of comma separated seed nodes that you will connect upon a start and ask for peers. A seed node is a node that does not participate in consensus but only helps propagate peers to nodes in the networks
- `persistent_peers` = is a list of comma separated peers that you will always want to be connected to. If you're already connected to the maximum number of peers, persistent peers will not be added.
- `max_num_inbound_peers` = is the maximum number of peers you will accept inbound connections from at one time (where they dial your address and initiate the connection).
- `max_num_outbound_peers` = is the maximum number of peers you will initiate outbound connects to at one time (where you dial their address and initiate the connection).
- `unconditional_peer_ids` = is similar to `persistent_peers` except that these peers will be connected to even if you are already connected to the maximum number of peers. This can be a validator node ID on your sentry node.
- `pex` = turns the peer exchange reactor on or off. Validator node will want the `pex` turned off so it would not begin gossiping to unknown peers on the network. PeX can also be turned off for statically configured networks with fixed network connectivity. For full nodes on open, dynamic networks, it should be turned on.
- `seed_mode` = is used for when node operators want to run their node as a seed node. Seed node's run a variation of the PeX protocol that disconnects from peers after sending them a list of peers to connect to. To minimize the servers usage, it is recommended to set the mempool's size to 0.
- `private_peer_ids` = is a comma separated list of node ids that you would not like exposed to other peers (ie. you will not tell other peers about the private_peer_ids). This can be filled with a validators node id.

Loading…
Cancel
Save