Skip to content

Commit

Permalink
docs: Add some docs on plugins
Browse files Browse the repository at this point in the history
License: MIT
Signed-off-by: Łukasz Magiera <[email protected]>
  • Loading branch information
magik6k committed Sep 21, 2017
1 parent 2b12a33 commit 9a55a13
Showing 1 changed file with 48 additions and 0 deletions.
48 changes: 48 additions & 0 deletions docs/plugins.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# 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:
```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/
```

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
```

0 comments on commit 9a55a13

Please sign in to comment.