Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
221 lines (153 sloc) 6.25 KB
title menu weight
Install IPFS
guides
parent
guides
1

There are a variety of ways to install a copy of IPFS on your system. We generally recommend installing a prebuilt package, but here are a few other supported options:

Note these instructions all make use of the command line. We use $ to indicate the command prompt — commands to type are on lines that are prefixed with that, while output lines are un-prefixed.


Installing from a Prebuilt Package

First, download the right version of IPFS for your platform:

Download IPFS for your platform   

Mac OS X and Linux

After downloading, untar the archive, and move the ipfs binary somewhere in your executables $PATH using the install.sh script:

$ tar xvfz go-ipfs.tar.gz
$ cd go-ipfs
$ ./install.sh

Test it out:

$ ipfs help
USAGE:

    ipfs - Global p2p merkle-dag filesystem.
...

Congratulations! You now have a working IPFS installation on your computer.

<a class="button button-primary" href="{{< relref "usage.md" >}}" role="button"> General Usage   

Windows

After downloading, unzip the archive, and move ipfs.exe somewhere in your %PATH%.

Test it out:

$ ipfs help
USAGE:

    ipfs - Global p2p merkle-dag filesystem.
...

Congratulations! You now have a working IPFS installation on your computer.

<a class="button button-primary" href="{{< relref "usage.md" >}}" role="button"> General Usage   


Installing with ipfs-update

ipfs-update is a command-line tool to install and upgrade the ipfs binary.

Getting ipfs-update

ipfs-update can be downloaded for your platform at: https://dist.ipfs.io/#ipfs-update

If you have a working Go environment (>=1.8), you can also install it with:

$ go get -u github.com/ipfs/ipfs-update

When installing new versions of ipfs or upgrading make sure you are using the latest version of ipfs-update.

Installing ipfs with ipfs-update

ipfs-update versions lists all the available ipfs versions which are available for download:

$ ipfs-update versions
v0.3.2
v0.3.4
v0.3.5
v0.3.6
v0.3.7
v0.3.8
v0.3.9
v0.3.10
v0.3.11
v0.4.0
v0.4.1
v0.4.2
v0.4.3
v0.4.4
v0.4.5
v0.4.6
v0.4.7-rc1

ipfs-update install latest will install the latest available version:

$ ipfs-update install latest
fetching go-ipfs version v0.4.7-rc1
binary downloaded, verifying...
success!
stashing old binary
installing new binary to /home/hector/go/bin/ipfs
checking if repo migration is needed...
Installation complete!

Note that the latest available version may not be stable (i.e. release candidates in the form vX.X.X-rcX). So it is recommended to specify the version you want to install, for example: ipfs-update install v0.4.6.


Building from Source

Warning: In the past you could install IPFS using go get. This does not work anymore!

If you want, you can also build IPFS from source. If you are on Mac OS X or Linux take a look at the readme for install instructions. If you are on Windows take a look at this document for instructions.


Upgrading IPFS

ipfs upgrades (and downgrades) may involve a repository upgrade process performed by the fs-repo-migrations tool.

Upgrading using ipfs-update

ipfs-update install will download and run fs-repo-migrations when needed, during the installation of a newer or older ipfs version (as explained above). This is the easiest way of upgrading.

Warning: Make sure that the ipfs daemon is not running during an upgrade

Upgrading manually

In order to perform a manual upgrade of ipfs, you will need to manually run any repository migrations. The procedure is as follows:

  • Stop the ipfs daemon if it is running
  • Optionally backup your ipfs data folder (i.e. cp -aL ~/.ipfs ~/.ipfs.bk)
  • Download and install the latest version of ipfs from https://dist.ipfs.io/#go-ipfs
  • Run ipfs daemon.

When a repository migration is necessary, ipfs will inform the user, download and install fs-repo-migrations and perform the upgrade. If you wish the procedure to happen unattended, launch the daemon with the --migrate flag.

Migrations can be also run manually by downloading the latest version of fs-repo-migrations from https://dist.ipfs.io/#fs-repo-migrations and following these instructions.


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.7.0 or later. To check what go version you have installed, type go version. Here's what I get:

$ go version
go version go1.7 linux/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

You can’t perform that action at this time.