go-ipfs-dep

Install go-ipfs from npm as a dependency of your project

Install the latest go-ipfs binary from http://dist.ipfs.io

Installation

npm install go-ipfs-dep --save

See IPFS getting-started. If anything goes wrong, try using: http://ipfs.io/docs/install.

Development

Warning: The binary gets put in the go-ipfs folder inside the module folder.

Which go-ipfs version this package downloads?

Can be specified in package.json with a field go-ipfs.version, eg:

"go-ipfs": {
  "version": "v0.4.13"
},

Using local IPFS daemon as the package download url

Can be specified in package.json with a field go-ipfs.version, eg:

"go-ipfs": {
  "version": "v0.4.3",
  "distUrl": "http://localhost:8080/ipfs/QmSoNtqW22htkg9mtHWNBvZLUEmqfq8su7957meS1iQfeL"
},

Where QmSoNtqW22htkg9mtHWNBvZLUEmqfq8su7957meS1iQfeL is the root of the distributions web site.

Or when run with node src/bin.js, the dist url can be passed via an environment variable GO_IPFS_DIST_URL, eg:

GO_IPFS_DIST_URL=http://localhost:8080/ipfs/QmSoNtqW22htkg9mtHWNBvZLUEmqfq8su7957meS1iQfeL node binsrc/bin.js

Arguments

When used via node src/bin.js, you can specify the target platform, version and architecture via environment variables: TARGET_OS, TARGET_VERSION and TARGET_ARCH.

We fetch the versions dynamically from https://dist.ipfs.io/go-ipfs/versions and the OSes and architectures from https://dist.ipfs.io/go-ipfs/${VERSION}/dist.json.

Or via command line arguments in the order of:

node src/bin.js <version> <platform> <architecture> <install directory>

node src/bin.js v0.4.3 linux amd64 ./go-ipfs

Deployment

Prerelease

You have made changes and want to triple check everything is working. You can! If you publish with a numeric prerelease identifier then go-ipfs-dep will strip it and install the corresponding version e.g. 0.4.19-0 installs go-ipfs version 0.4.19.

To deploy a new version with a prerelease identifier run the following command:

npx aegir release --type prepatch --preid '' --dist-tag next --no-lint --no-test --no-build
# Note: change "--type prepatch" to the appropriate prerelease type.
# e.g. prepatch: 0.4.18 => 0.4.19-0, preminor: 0.4.18 => 0.5.0-0 etc.

This publishes to the "next" tag meaning that the current "latest" version of go-ipfs-dep will remain the same.

Changelog

0.4.19 (2019-03-13)

<a name="0.4.19-0"></a>