doc(config): expand peering docs
Steven Allen committed
Jun 11, 2020 at 17:58 UTC
ea55e747f253de3223ecc3b0eea5413b2198f7ed
1 file changed
+17
-4
docs/config.md
+17
-4
@@ -745,15 +745,28 @@ Peering can be asymmetric or symmetric:
745
746
#### `Peering.Peers`
747
748
-The set of peers with which to peer. Each entry is of the form:
748
+The set of peers with which to peer.
749
750
-```js
750
+```json
751
{
752
- "ID": "QmSomePeerID", # The peers ID.
753
- "Addrs": ["/ip4/1.2.3.4/tcp/1234"] # Known addresses for the peer. If none are specified, the DHT will be queried.
752
+ "Peering": {
753
+ "Peers": [
754
+ {
755
+ "ID": "QmPeerID1",
756
+ "Addrs": ["/ip4/18.1.1.1/tcp/4001"]
757
+ },
758
+ {
759
+ "ID": "QmPeerID2",
760
+ "Addrs": ["/ip4/18.1.1.2/tcp/4001", "/ip4/18.1.1.2/udp/4001/quic"]
761
+ }
762
+ ]
763
+ }
764
+ ...
765
}
766
```
767
768
+Where `ID` is the peer ID and `Addrs` is a set of known addresses for the peer. If no addresses are specified, the DHT will be queried.
769
+
770
Additional fields may be added in the future.
771
772
## `Reprovider`