1
0
mirror of https://github.com/ipfs/kubo.git synced 2025-07-29 07:03:35 +08:00
Files
kubo/docs/plugins.md
Jeromy Johnson be6935924f Update plugins.md
License: MIT
Signed-off-by: Jeromy <jeromyj@gmail.com>
2017-10-05 02:18:11 -07:00

50 lines
1.1 KiB
Markdown

# Plugins
Since 0.4.11 go-ipfs has an experimental plugin system that allows augmenting
the daemons functionality without recompiling.
When an IPFS node is created, it will load plugins from the `$IPFS_PATH/plugins`
directory (by default `~/.ipfs/plugins`).
### Plugin types
#### IPLD
IPLD plugins add support for additional formats to `ipfs dag` and other IPLD
related commands.
### Supported plugins
| Name | Type |
|------|------|
| git | IPLD |
#### Installation
##### Linux
1. Build included plugins:
```bash
go-ipfs$ make build_plugins
go-ipfs$ ls plugin/plugins/*.so
```
3. Copy desired plugins to `$IPFS_PATH/plugins`
```bash
go-ipfs$ mkdir -p ~/.ipfs/plugins/
go-ipfs$ cp plugin/plugins/git.so ~/.ipfs/plugins/
go-ipfs$ chmod +x ~/.ipfs/plugins/git.so # ensure plugin is executable
```
4. Restart daemon if it is running
##### Other
Go currently only supports plugins on Linux, for other platforms you will need
to compile them into IPFS binary.
1. Uncomment plugin entries in `plugin/loader/preload_list`
2. Build ipfs
```bash
go-ipfs$ make build
```