coosld/kubo
1
0
Fork 0
mirror of https://github.com/ipfs/kubo.git synced 2026-02-21 10:27:46 +08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity
a11bb713d6
kubo/docs/plugins.md
Łukasz Magiera a11bb713d6 docs: Add some docs on plugins 
License: MIT
Signed-off-by: Łukasz Magiera <magik6k@gmail.com>
2017-10-05 02:18:11 -07:00

1.0 KiB
Raw Blame History

Plugins

Since 0.4.11 go-ipfs has an experimental plugin system for various added functionality.

When IPFS node is created, it will load plugins from $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:
go-ipfs$ make build_plugins
go-ipfs$ ls plugin/plugins/*.so
  1. Copy desired plugins to $IPFS_PATH/plugins
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
  1. 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
go-ipfs$ make build