提交 02a1feab 作者: Steven Allen

docs: address CR on plugin documentation

License: MIT
Signed-off-by: 's avatarSteven Allen <steven@stebalien.com>
上级 f706bc69
...@@ -32,27 +32,30 @@ Datastore plugins add support for additional datastore backends. ...@@ -32,27 +32,30 @@ Datastore plugins add support for additional datastore backends.
## Available Plugins ## Available Plugins
| Name | Type | Built-In | Description | | Name | Type | Preloaded | Description |
|---------------------------------------------------------------------------------|-----------|----------|------------------------------------------------| |---------------------------------------------------------------------------------|-----------|-----------|------------------------------------------------|
| [git](https://github.com/ipfs/go-ipfs/tree/master/plugin/plugins/git) | IPLD | x | An IPLD format for git objects. | | [git](https://github.com/ipfs/go-ipfs/tree/master/plugin/plugins/git) | IPLD | x | An IPLD format for git objects. |
| [badgerds](https://github.com/ipfs/go-ipfs/tree/master/plugin/plugins/badgerds) | Datastore | x | A high performance but experimental datastore. | | [badgerds](https://github.com/ipfs/go-ipfs/tree/master/plugin/plugins/badgerds) | Datastore | x | A high performance but experimental datastore. |
| [flatfs](https://github.com/ipfs/go-ipfs/tree/master/plugin/plugins/flatfs) | Datastore | x | A stable filesystem-based datastore. | | [flatfs](https://github.com/ipfs/go-ipfs/tree/master/plugin/plugins/flatfs) | Datastore | x | A stable filesystem-based datastore. |
| [levelds](https://github.com/ipfs/go-ipfs/tree/master/plugin/plugins/levelds) | Datastore | x | A stable, flexible datastore backend. | | [levelds](https://github.com/ipfs/go-ipfs/tree/master/plugin/plugins/levelds) | Datastore | x | A stable, flexible datastore backend. |
* **Built-In** plugins are built into the go-ipfs binary and do not need to be * **Preloaded** plugins are built into the go-ipfs binary and do not need to be
installed separately. At the moment, all *known* plugins are built-in as installed separately. At the moment, all in-tree plugins are preloaded.
they're mature and have proven themselves to be useful.
## Installing Plugins ## Installing Plugins
External plugins must be installed in `$IPFS_PATH/plugins/` (usually Go-ipfs supports two types of plugins: External and Preloaded.
`~/.ipfs/plugins/`). Alternatively, plugins can be preloaded and built into the
go-ipfs binary itself. * External plugins must be installed in `$IPFS_PATH/plugins/` (usually
`~/.ipfs/plugins/`).
* Preloaded plugins are built-into the go-ipfs when it's compiled.
### External Plugin ### External Plugin
At the moment, this method is only supported on Linux and MacOS. Users of other The advantage of an external plugin is that it can be built, packaged, and
operating systems should follow the instructions for preloaded plugins. installed independently of go-ipfs. Unfortunately, this method is only supported
on Linux and MacOS at the moment. Users of other operating systems should follow
the instructions for preloaded plugins.
#### In-tree #### In-tree
...@@ -92,6 +95,11 @@ Finally, as with in-tree plugins: ...@@ -92,6 +95,11 @@ Finally, as with in-tree plugins:
### Preloaded Plugins ### Preloaded Plugins
The advantages of preloaded plugins are:
1. They're bundled with the go-ipfs binary.
2. They work on all platforms.
To preload a go-ipfs plugin: To preload a go-ipfs plugin:
1. Add the plugin to the preload list: `plugin/loader/preload_list` 1. Add the plugin to the preload list: `plugin/loader/preload_list`
......
Markdown 格式
0%
您添加了 0 到此讨论。请谨慎行事。
请先完成此评论的编辑!
注册 或者 后发表评论