IPFS implementation in Go

IPFS is a global, versioned, peer-to-peer filesystem. It combines good ideas from Git, BitTorrent, Kademlia, SFS, and the Web. It is like a single bittorrent swarm, exchanging git objects. IPFS provides an interface as simple as the HTTP web, but with permanence built in. You can also mount the world at /ipfs.

For more info see: https://github.com/ipfs/ipfs.

Please put all issues regarding IPFS design in the ipfs repo issues. Please put all issues regarding Go IPFS implementation in this repo.

Table of Contents

• Security Issues
• Install
  • Install prebuilt packages
  • Build from Source
  • Prerequisite: Install Go
  • Download + Compile IPFS
  • Development Dependencies
• Updating
• Usage
• Getting Started
  • Some things to try
  • Docker usage
    • Docker usage with VirtualBox/boot2docker (OSX and Windows)
• Troubleshooting
• Contributing
• Todo
• License

Security Issues

The IPFS protocol and its implementations are still in heavy development. This means that there may be problems in our protocols, or there may be mistakes in our implementations. And -- though IPFS is not production-ready yet -- many people are already running nodes in their machines. So we take security vulnerabilities very seriously. If you discover a security issue, please bring it to our attention right away!

If you find a vulnerability that may affect live deployments -- for example, by exposing a remote execution exploit -- please send your report privately to security@ipfs.io. Please DO NOT file a public issue.

If the issue is a protocol weakness that cannot be immediately exploited or something not yet deployed, just discuss it openly.

Install

The canonical download instructions for IPFS are over at: http://ipfs.io/docs/install/. It is highly suggested you follow those instructions if you are not interested in working on IPFS development.

Install prebuilt packages

We host prebuilt binaries over at our distributions page.

From there:

• Click the blue "Download go-ipfs" on the right side of the page.
• Open/extract the archive.
• Move  ipfs  to your path ( install.sh  can do it for you).

Build from Source

Install Go

The build process for ipfs requires Go 1.5+, but we strongly recommend using 1.6.2. If you don't have it: Download Go 1.6.2+.

You'll need to add Go's bin directories to your  $PATH  environment variable e.g., by adding these lines to your  /etc/profile  (for a system-wide installation) or  $HOME/.profile :

normalexport PATH=$PATH:/usr/local/go/bin
export PATH=$PATH:$GOPATH/bin
normal

(If you run into trouble, see the Go install instructions).

Download + Compile IPFS

go-ipfs differs from the vanilla  go get  flow: it uses gx/gx-go for dependency management.

First download  go-ipfs  without installing:

normal$ go get -d github.com/ipfs/go-ipfs

$ cd $GOPATH/src/github.com/ipfs/go-ipfs
normal

Then install  go-ipfs  and its dependencies, including  gx  and  gx-go :

normal$ make install
normal

Troubleshooting

• Separate instructions are available for building on Windows.
•  git  is required in order for  go get  to fetch all dependencies.
• Package managers often contain out-of-date  golang  packages. Ensure that  go version  reports at least 1.5.2. See above for how to install go.
• If you are interested in development, please install the development dependencies as well.
• WARNING: Older versions of OSX FUSE (for Mac OS X) can cause kernel panics when mounting! We strongly recommend you use the latest version of OSX FUSE. (See https://github.com/ipfs/go-ipfs/issues/177)
• For more details on setting up FUSE (so that you can mount the filesystem), see the docs folder.
• Shell command completion is available in  misc/completion/ipfs-completion.bash . Read docs/command-completion.md to learn how to install it.
• See the init examples for how to connect IPFS to systemd or whatever init system your distro uses.

Development Dependencies

If you make changes to the protocol buffers, you will need to install the protoc compiler.

Updating

IPFS has an updating tool that can be accessed through  ipfs update . The tool is not installed alongside IPFS in order to keep that logic independent of the main codebase. To install  ipfs update , either download it here or install it from source with  go get -u github.com/ipfs/ipfs-update .

Usage

normal  ipfs - Global p2p merkle-dag filesystem.

  ipfs [<flags>] <command> [<arg>] ...

SUBCOMMANDS
  BASIC COMMANDS
    init          Initialize ipfs local configuration
    add <path>    Add a file to ipfs
    cat <ref>     Show ipfs object data
    get <ref>     Download ipfs objects
    ls <ref>      List links from an object
    refs <ref>    List hashes of links from an object

  DATA STRUCTURE COMMANDS
    block         Interact with raw blocks in the datastore
    object        Interact with raw dag nodes
    files         Interact with objects as if they were a unix filesystem

  ADVANCED COMMANDS
    daemon        Start a long-running daemon process
    mount         Mount an ipfs read-only mountpoint
    resolve       Resolve any type of name
    name          Publish or resolve IPNS names
    dns           Resolve DNS links
    pin           Pin objects to local storage
    repo          Manipulate an IPFS repository

  NETWORK COMMANDS
    id            Show info about ipfs peers
    bootstrap     Add or remove bootstrap peers
    swarm         Manage connections to the p2p network
    dht           Query the DHT for values or peers
    ping          Measure the latency of a connection
    diag          Print diagnostics

  TOOL COMMANDS
    config        Manage configuration
    version       Show ipfs version information
    update        Download and apply go-ipfs updates
    commands      List all available commands

  Use 'ipfs <command> --help' to learn more about each command.

  ipfs uses a repository in the local file system. By default, the repo is located
  at ~/.ipfs. To change the repo location, set the $IPFS_PATH environment variable:

    export IPFS_PATH=/path/to/ipfsrepo
normal

Getting Started

See also: http://ipfs.io/docs/getting-started/

To start using IPFS, you must first initialize IPFS's config files on your system, this is done with  ipfs init . See  ipfs init --help  for information on the optional arguments it takes. After initialization is complete, you can use  ipfs mount ,  ipfs add  and any of the other commands to explore!

Some things to try

Basic proof of 'ipfs working' locally:

normalecho "hello world" > hello
ipfs add hello
# This should output a hash string that looks something like:
# QmT78zSuBmuS4z925WZfrqQ1qHaJ56DQaTfyMUF7F8ff5o
ipfs cat <that hash>
normal

Docker usage

An IPFS docker image is hosted at hub.docker.com/r/ipfs/go-ipfs. To make files visible inside the container you need to mount a host directory with the  -v  option to docker. Choose a directory that you want to use to import/export files from IPFS. You should also choose a directory to store IPFS files that will persist when you restart the container.

normalexport ipfs_staging=</absolute/path/to/somewhere/>
export ipfs_data=</absolute/path/to/somewhere_else/>
normal

Make sure docker can access these folders:

normalsudo chmod -R 777 /absolute/path/to/somewhere/
sudo chmod -R 777 /absolute/path/to/somewhere_else/
normal

Start a container running ipfs and expose ports 4001, 5001 and 8080:

normaldocker run -d --name ipfs_host -v $ipfs_staging:/export -v $ipfs_data:/data/ipfs -p 8080:8080 -p 4001:4001 -p 5001:5001 ipfs/go-ipfs:latest
normal

Watch the ipfs log:

normaldocker logs -f ipfs_host
normal

Wait for ipfs to start. ipfs is running when you see:

normalGateway (readonly) server
listening on /ip4/0.0.0.0/tcp/8080
normal

You can now stop watching the log.

Run ipfs commands:

normaldocker exec ipfs_host ipfs <args...>
normal

For example: connect to peers

normaldocker exec ipfs_host ipfs swarm peers
normal

Add files:

normalcp -r <something> $ipfs_staging
docker exec ipfs_host ipfs add -r /export/<something>
normal

Stop the running container:

normaldocker stop ipfs_host
normal

Docker usage with VirtualBox/boot2docker (OSX and Windows)

Since docker is running in the boot2docker VM, you need to forward relevant ports from the VM to your host for IPFS to act normally. This is accomplished with the following command:

normalboot2docker ssh -L 5001:localhost:5001 -L 4001:localhost:4001 -L 8080:localhost:8080 -fN
normal

Troubleshooting

If you have previously installed IPFS before and you are running into problems getting a newer version to work, try deleting (or backing up somewhere else) your IPFS config directory (~/.ipfs by default) and rerunning  ipfs init . This will reinitialize the config file to its defaults and clear out the local datastore of any bad entries.

For any other problems, check the issues list and if you dont see your problem there, either come talk to us on irc (freenode #ipfs) or file an issue of your own!

Contributing

Please see Contribute.md!

Todo

An IPFS alpha version has been released in February 2015. Things left to be done are all marked as issues.

License

MIT