Install IPFS

You can install the Go IPFS implementation from source or from prebuilt packages.

Prebuilt Packages

We use gobuilder.me to do automated builds.

Download a binary for your platform (more coming):

Then, unzip the archive, and move ipfs somewhere in your $PATH:

mv ipfs /usr/local/bin/ipfs

Test it out:

> ipfs version
ipfs version 0.3.8

That's it!

Getting Started with IPFS   

Note: if you're concerned about security, build from source, as either gobuilder.me or github.com could introduce vulnerabilites. We will be doing signed releases soon. Post here if you'd like this sooner.


From Source

Dependencies:

Then run:

go get -u github.com/ipfs/go-ipfs/cmd/ipfs

This will download ipfs and its dependencies, and compile ipfs.

Note: If you're new to Go, you'll need to do a few things to make sure you setup your PATH and your GOPATH (the location Go looks for libraries):

  • Create a folder. e.g. mkdir ~/go
  • Add the following to your shell config file (.bashrc, .profile, etc.)
    • export GOPATH=$HOME/go;
    • export PATH="$GOPATH/bin:$PATH:";
    • export PATH="$PATH:/usr/local/opt/go/libexec/bin";

Test it out:

> ipfs version
ipfs version 0.3.8

That's it!

Getting Started with IPFS   



Troubleshooting

Help!

If you have any problems, come get live help at #ipfs or via the mailing list.

Check Go Version

IPFS works with Go 1.5+. To check what go version you have installed, type go version. Here's what I get:

> go version
go version go1.5.1 darwin/amd64

If you need to update, it is recommended to install from the canonical Go packages. Package managers often contain out-of-date Go packages.

Install FUSE

For more details on setting up FUSE (so that you can mount the filesystem), see github.com/ipfs/go-ipfs/blob/master/docs/fuse.md