doc(plugin): document plugin config
fixes #7308
Steven Allen committed
May 12, 2020 at 21:56 UTC
0cc3d7a1f40d9634e5739c1e2483bc42559da29f
1 file changed
+6
-1
plugin/plugin.go
+6
-1
@@ -5,7 +5,12 @@ type Environment struct {
5
// Path to the IPFS repo.
6
Repo string
7
8
- // The plugin's config, if specified.
8
+ // The plugin's config, if specified in the
9
+ // Plugins.Plugins["plugin-name"].Config field of the user's go-ipfs
10
+ // config. See docs/plugins.md for details.
11
+ //
12
+ // This is an arbitrary JSON-like object unmarshaled into an interface{}
13
+ // according to https://golang.org/pkg/encoding/json/#Unmarshal.
14
Config interface{}
15
}
16