diff --git a/dht.go b/dht.go index 5689652..de1377e 100644 --- a/dht.go +++ b/dht.go @@ -74,6 +74,9 @@ type IpfsDHT struct { maxRecordAge time.Duration + // Allows disabling dht subsystems. These should _only_ be set on + // "forked" DHTs (e.g., DHTs with custom protocols and/or private + // networks). enableProviders, enableValues bool } diff --git a/opts/options.go b/opts/options.go index 5bdf733..74529d2 100644 --- a/opts/options.go +++ b/opts/options.go @@ -185,6 +185,9 @@ func DisableAutoRefresh() Option { // EnableProviders enables storing and retrieving provider records. // // Defaults to true. +// +// WARNING: do not change this unless you're using a forked DHT (i.e., a private +// network and/or distinct DHT protocols with the `Protocols` option). func EnableProviders(enable bool) Option { return func(o *Options) error { o.EnableProviders = enable @@ -195,6 +198,9 @@ func EnableProviders(enable bool) Option { // EnableValues enables storing and retrieving value records. // // Defaults to true. +// +// WARNING: do not change this unless you're using a forked DHT (i.e., a private +// network and/or distinct DHT protocols with the `Protocols` option). func EnableValues(enable bool) Option { return func(o *Options) error { o.EnableValues = enable