diff --git a/plugin/plugin.go b/plugin/plugin.go index 35e618747..1ff569699 100644 --- a/plugin/plugin.go +++ b/plugin/plugin.go @@ -5,7 +5,12 @@ type Environment struct { // Path to the IPFS repo. Repo string - // The plugin's config, if specified. + // The plugin's config, if specified in the + // Plugins.Plugins["plugin-name"].Config field of the user's go-ipfs + // config. See docs/plugins.md for details. + // + // This is an arbitrary JSON-like object unmarshaled into an interface{} + // according to https://golang.org/pkg/encoding/json/#Unmarshal. Config interface{} }