doc(config): document pubsub
Steven Allen committed
May 19, 2020 at 19:24 UTC
b29f9e995900bb480def3b26a17929280b9bdd48
1 file changed
+32
docs/config.md
+32
@@ -136,6 +136,9 @@ documented in `ipfs config profile --help`.
136
- [`Mounts.IPFS`](#mountsipfs)
137
- [`Mounts.IPNS`](#mountsipns)
138
- [`Mounts.FuseAllowOther`](#mountsfuseallowother)
139
+- [`Pubsub`](#pubsub)
140
+ - [`Pubsub.Router`](#pubsubrouter)
141
+ - [`Pubsub.DisableSigning`](#pubsubdisablesigning)
142
- [`Reprovider`](#reprovider)
143
- [`Reprovider.Interval`](#reproviderinterval)
144
- [`Reprovider.Strategy`](#reproviderstrategy)
@@ -660,6 +663,35 @@ Mountpoint for `/ipns/`.
663
664
Sets the FUSE allow other option on the mountpoint.
665
666
+## `Pubsub`
667
+
668
+Pubsub configures the `ipfs pubsub` subsystem. To use, it must be enabled by
669
+passing the `--enable-pubsub-experiment` flag to the daemon.
670
+
671
+### `Pubsub.Router`
672
+
673
+Sets the default router used by pubsub to route messages to peers. This can be one of:
674
+
675
+* `"floodsub"` - floodsub is a basic router that simply _floods_ messages to all
676
+ connected peers. This router is extremely inefficient but _very_ reliable.
677
+* `"gossipsub"` - [gossipsub][] is a more advanced routing algorithm that will
678
+ build an overlay mesh from a subset of the links in the network.
679
+
680
+Default: `"gossipsub"`
681
+
682
+[gossipsub]: https://github.com/libp2p/specs/tree/master/pubsub/gossipsub
683
+
684
+### `Pubsub.DisableSigning`
685
+
686
+Disables message signing and signature verification. Enable this option if
687
+you're operating in a completely trusted network.
688
+
689
+It is _not_ safe to disable signing even if you don't care _who_ sent the
690
+message because spoofed messages can be used to silence real messages by
691
+intentionally re-using the real message's message ID.
692
+
693
+Default: `false`
694
+
695
## `Reprovider`
696
697
### `Reprovider.Interval`