install go-ipfs from npm
Table of Contents
Install the latest go-ipfs binary.
npm install -g go-ipfs
Installs from https://gobuilder.me/github.com/ipfs/go-ipfs/cmd/ipfs.
# Install globally > npm install -g go-ipfs > ipfs version ipfs version v0.4.22 # Install locally > npm install go-ipfs > ./node_modules/.bin/ipfs ipfs version v0.4.22
Warning: this module uses the latest version of ipfs. If there is a strong need to vendor an older version, let us know. We care about versions very much :( but for a number of reasons, this is easier for us all right now.
Warning: the file
bin/ipfs is a placeholder, when downloading stuff, it gets replaced. so if you run
node install.js it will then be dirty in the git repo. Do not commit this file, as then you would be commiting a big binary and publishing it to npm. (TODO: add a pre-commit or pre-publish hook that warns about this)
Publish a new version
You should be able to just run
./publish.sh for example:
> ./publish.sh usage ./publish.sh <version> publish a version of go-ipfs to npm > ./publish.sh 0.3.11
- check the version is indeed a tag in https://github.com/ipfs/go-ipfs
- check the size of
bin/ipfsis right (must be the checked in file)
- update the version numbers in
git committhe changes
- push to https://github.com/ipfs/npm-go-ipfs
- publish to
Open an issue in the repo if you run into trouble.
Publish a new version of this module with exact same go-ipfs version
If some problem happens, and you need to publish a new version of this module targetting the same go-ipfs version, then please follow this convention:
- Clean up bad stuff: unpublish all modules with this exact same
- Add a "hacky" version suffix: use version:
- Publish version: publish the module. Since it's the only one with the go-ipfs version, then it should be installed.
Why do this?
Well, if you previously published npm module
email@example.com and there was a problem, we now must publish a different version, but we want to keep the version number the same. so the strategy is to publish as
firstname.lastname@example.org, and unpublish
Because it is unlikely to be a legitimate go-ipfs version, and we want to support go-ipfs versions like
Do i have to say
-hacky<num>or can i just use
-<num> won't work, as link-ipfs.js expects
-hacky<num>. If you want to
change the convention, go for it, and update this readme accordingly.
Feel free to join in. All welcome. Open an issue!
This repository falls under the IPFS Code of Conduct.