Commit c2b72b25 authored by Steven Allen's avatar Steven Allen

doc(options): document that disabling values/providers should only be done on forked dhts

parent 52747fc1
......@@ -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
}
......
......@@ -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
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment