docs: Add some docs on plugins #4255
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Stebalien
reviewed
Sep 20, 2017
docs/plugins.md
Outdated
| ### Plugin types | ||
|
|
||
| #### IPLD | ||
| IPLD plugins add support for additional LD formats to `ipfs dag` and other IPLD |
There was a problem hiding this comment.
s/additional LD/additional IPLD/. We don't support other LD formats (JSON-LD etc...).
docs/plugins.md
Outdated
|
|
||
| Since 0.4.11 go-ipfs has a plugin system for various added functionality. | ||
|
|
||
| When IPFS node is created, it will load plugins from `.ipfs/plugins` directory. |
There was a problem hiding this comment.
To be precise, this should probably say "will load plugins from $IPFS_PATH/plugins (where $IPFS_PATH defaults to ~/.ipfs)" or something like that.
docs/plugins.md
Outdated
| @@ -0,0 +1,33 @@ | |||
| # Plugins | |||
|
|
|||
| Since 0.4.11 go-ipfs has a plugin system for various added functionality. | |||
There was a problem hiding this comment.
Should also note that this only works on Linux.
There was a problem hiding this comment.
Also, we should explicitly state that this is "experimental".
magik6k
force-pushed
the
docs/plugin
branch
from
f531c16
to
9a55a13
Compare
|
Updated with section on preload |
|
Cool thanks, this looks good! Could you also:
|
Kubuxu
reviewed
Sep 21, 2017
docs/plugins.md
Outdated
| ```bash | ||
| go-ipfs$ mkdir -p ~/.ipfs/plugins/ | ||
| go-ipfs$ cp plugin/plugins/git.so ~/.ipfs/plugins/ | ||
| ``` |
There was a problem hiding this comment.
I would add a step that checks if plugins have executable permission set.
magik6k
force-pushed
the
docs/plugin
branch
from
9a55a13
to
cd5d027
Compare
whyrusleeping
approved these changes
Sep 22, 2017
whyrusleeping
approved these changes
Oct 5, 2017
License: MIT Signed-off-by: Łukasz Magiera <[email protected]>
License: MIT Signed-off-by: Jeromy <[email protected]>
whyrusleeping
force-pushed
the
docs/plugin
branch
from
f03bf0a
to
be69359
Compare
|
LGTM |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #4243