example

package module
Version: v0.0.0-...-da2577d Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 18, 2022 License: MIT Imports: 3 Imported by: 0

README

go-ipfs-example-plugin

standard-readme compliant GoDoc

example plugin for Kubo

This repository contains a set of example Kubo plugins, demonstrating how to integrate external plugins into Kubo.

Packages:

  • delaystore: an example datastore plugin that wraps an inner datastore in a "delayed" datastore.
  • greeter: an example daemon plugin that prints "Hello!" on start and "Goodbye!" on exit.

NOTE 1: Plugins only work on Linux and MacOS at the moment. You can track the progress of this issue here: https://github.com/golang/go/issues/19282

NOTE 2: This plugin exists as an example and a starting point for new plugins. It isn't particularly useful by itself.

Building and Installing

You can build the example plugin by running make build. You can then install it into your local IPFS repo by running make install.

Plugins need to be built against the correct version of Kubo. This package generally tracks the latest Kubo release but if you need to build against a different version, please set the IPFS_VERSION environment variable.

You can set IPFS_VERSION to:

  • vX.Y.Z to build against that version of IPFS.
  • $commit or $branch to build against a specific Kubo commit or branch.
    • Note: if building against a commit or branch make sure to build that commit/branch using the -trimpath flag. For example getting the binary via go get -trimpath github.com/ipfs/kubo/cmd/ipfs@COMMIT
  • /absolute/path/to/source to build against a specific Kubo checkout.

To update the Kubo, run:

> make go.mod IPFS_VERSION=version

Contribute

Feel free to join in. All welcome. Open an issue!

This repository falls under the IPFS Code of Conduct.

Want to hack on IPFS?

License

MIT

Documentation

Index

Constants

This section is empty.

Variables

Plugins is an exported list of plugins that will be loaded by Kubo.

Functions

This section is empty.

Types

This section is empty.

Source Files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL