From 33b785ebd9f5c224f5c14b386800043f9549ccd2 Mon Sep 17 00:00:00 2001 From: Adin Schmahmann Date: Tue, 19 Dec 2023 16:52:07 -0500 Subject: [PATCH] docs(customizing.md): add kubo binary imports description --- docs/customizing.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/customizing.md b/docs/customizing.md index 4db3c3431..0f078999f 100644 --- a/docs/customizing.md +++ b/docs/customizing.md @@ -36,6 +36,12 @@ For more information about the different types of Kubo plugins, see [plugins.md] Kubo plugins can also be injected at runtime using Go plugins (see below), but these are hard to use and not well supported by Go, so we don't recommend them. +### Kubo binary imports + +It is possible to depend on the package `cmd/ipfs/kubo` as a way of using Kubo plugins that is an alternative to recompiling Kubo with additional preloaded plugins. + +This gives a more Go-centric dependency updating flow to building a new binary with preloaded plugins by simply requiring updating a Kubo dependency rather than needing to update Kubo source code and recompile. + ## Bespoke Extension Points Certain Kubo functionality may have their own extension points. For example: