IPFS implementation in Go
Switch branches/tags
Clone or download
Latest commit 9bf4e41 Oct 13, 2018
Permalink
Failed to load latest commit information.
.gx release 0.4.17 Jul 27, 2018
assets gx: update yamux and refmt Oct 12, 2018
bin fix: maketarball.sh for OSX Oct 9, 2018
blocks/blockstoreutil gx: update stuff Oct 5, 2018
ci switch to go 1.11 Oct 9, 2018
cmd gx: update go-buffer-pool Oct 10, 2018
commands gx: update go-ipfs-config, iptb Oct 5, 2018
core fix infinite loop in `stats bw` Oct 13, 2018
coverage remove Godeps Sep 11, 2018
dagutils gx: update yamux and refmt Oct 12, 2018
docs add version, usage, and planning info for urlstore Oct 2, 2018
exchange/reprovide gx: update yamux and refmt Oct 12, 2018
filestore gx: update yamux and refmt Oct 12, 2018
fuse gx: update yamux and refmt Oct 12, 2018
keystore gx: update go-log go-ipld-cbor Sep 24, 2018
misc remove bitswap unwant Aug 28, 2018
mk switch to go 1.11 Oct 9, 2018
namesys gx: update yamux and refmt Oct 12, 2018
p2p gx: update go-buffer-pool Oct 10, 2018
pin gx: update yamux and refmt Oct 12, 2018
plugin Merge pull request #5187 from ipfs/feat/datastore-plugins Oct 5, 2018
repo gx: update stuff Oct 5, 2018
tar gx: update yamux and refmt Oct 12, 2018
test gx: update yamux and refmt Oct 12, 2018
thirdparty gx: update stuff Oct 5, 2018
.codeclimate.yml disable codeclimate 'maintainability' checks Dec 31, 2017
.dockerignore added binary executable files to .dockerignore Sep 29, 2018
.gitattributes fix test data on windows Feb 4, 2018
.gitignore mk: add tarball support Apr 5, 2018
.travis.yml switch to go 1.11 Oct 9, 2018
CHANGELOG.md fix changelog Jul 27, 2018
CODEOWNERS misc: create CODEOWNERS file Mar 5, 2018
Dockerfile switch to go 1.11 Oct 9, 2018
Dockerfile.fast switch to go 1.11 Oct 9, 2018
ISSUE_TEMPLATE.md github: remove go-ipfs version from issue template Apr 18, 2018
LICENSE Change year Aug 29, 2016
Makefile update protobuf files in go-ipfs Aug 15, 2018
README.md link to go-{libp2p,ipld} package tables Sep 10, 2018
Rules.mk update protobuf files in go-ipfs Aug 15, 2018
appveyor.yml appveyor: remove 'make toolkit_upgrade' May 16, 2016
circle.yml switch to go 1.11 Oct 9, 2018
codecov.yml misc: allow for some coverage fall on commit Mar 23, 2018
contribute.md misc: Fix a few typos Mar 30, 2018
doc.go doc: Add some docs explaining the sub-package layout May 2, 2015
package-list.json update pkg list Aug 30, 2018
package.json downgrade iptb to a 1.3 patch release Oct 12, 2018
version.go move version.go to top level package Aug 9, 2018

README.md

go-ipfs

banner

standard-readme compliant GoDoc Build Status

Project Status

Throughput Graph

Weekly Core Dev Calls

What is IPFS?

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:

Table of Contents

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. The GPG key for security@ipfs.io is 4B9665FB 92636D17 7C7A86D3 50AAE8A9 59B13AF3.

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.

System Requirements

IPFS can run on most Linux, macOS, and Windows systems. We recommend running it on a machine with at least 2 GB of RAM (it’ll do fine with only one CPU core), but it should run fine with as little as 1 GB of RAM. On systems with less memory, it may not be completely stable.

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).

You can also download go-ipfs from this project's GitHub releases page if you are unable to access ipfs.io.

From Linux package managers

Arch Linux

In Arch Linux go-ipfs is available as go-ipfs package.

$ sudo pacman -S go-ipfs

Development version of go-ipfs is also on AUR under go-ipfs-git. You can install it using your favourite AUR Helper or manually from AUR.

Nix

For Linux and MacOSX you can use the purely functional package manager Nix:

$ nix-env -i ipfs

You can also install the Package by using it's attribute name, which is also ipfs.

Snap

With snap, in any of the supported Linux distributions:

$ sudo snap install ipfs

Build from Source

Install Go

The build process for ipfs requires Go 1.10 or higher. If you don't have it: Download Go 1.10+.

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:

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

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

Download and Compile IPFS

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

$ cd $GOPATH/src/github.com/ipfs/go-ipfs
$ make install

If you are building on FreeBSD instead of make install use gmake install.

Building on less common systems

If your operating system isn't officially supported, but you still want to try building ipfs anyways (it should work fine in most cases), you can do the following instead of make install:

$ make install_unsupported

Note: This process may break if gx (used for dependency management) or any of its dependencies break as go get will always select the latest code for every dependency, often resulting in mismatched APIs.

Troubleshooting

  • Separate instructions are available for building on Windows.
  • Also, instructions for OpenBSD.
  • 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.10. 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.

Updating go-ipfs

Using ipfs-update

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, download it here.

Downloading IPFS builds using IPFS

List the available versions of go-ipfs:

$ ipfs cat /ipns/dist.ipfs.io/go-ipfs/versions

Then, to view available builds for a version from the previous command ($VERSION):

$ ipfs ls /ipns/dist.ipfs.io/go-ipfs/$VERSION

To download a given build of a version:

$ ipfs get /ipns/dist.ipfs.io/go-ipfs/$VERSION/go-ipfs_$VERSION_darwin-386.tar.gz # darwin 32-bit build
$ ipfs get /ipns/dist.ipfs.io/go-ipfs/$VERSION/go-ipfs_$VERSION_darwin-amd64.tar.gz # darwin 64-bit build
$ ipfs get /ipns/dist.ipfs.io/go-ipfs/$VERSION/go-ipfs_$VERSION_freebsd-amd64.tar.gz # freebsd 64-bit build
$ ipfs get /ipns/dist.ipfs.io/go-ipfs/$VERSION/go-ipfs_$VERSION_linux-386.tar.gz # linux 32-bit build
$ ipfs get /ipns/dist.ipfs.io/go-ipfs/$VERSION/go-ipfs_$VERSION_linux-amd64.tar.gz # linux 64-bit build
$ ipfs get /ipns/dist.ipfs.io/go-ipfs/$VERSION/go-ipfs_$VERSION_linux-arm.tar.gz # linux arm build
$ ipfs get /ipns/dist.ipfs.io/go-ipfs/$VERSION/go-ipfs_$VERSION_windows-amd64.zip # windows 64-bit build

Usage

  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

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:

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

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.

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

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

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

Watch the ipfs log:

docker logs -f ipfs_host

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

Gateway (readonly) server
listening on /ip4/0.0.0.0/tcp/8080

You can now stop watching the log.

Run ipfs commands:

docker exec ipfs_host ipfs <args...>

For example: connect to peers

docker exec ipfs_host ipfs swarm peers

Add files:

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

Stop the running container:

docker stop ipfs_host

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.

Please direct general questions and help requests to our forum or our IRC channel (freenode #ipfs).

If you believe you've found a bug, check the issues list and, if you don't see your problem there, either come talk to us on IRC (freenode #ipfs) or file an issue of your own!

Packages

This table is generated using the module package-table with package-table --data=package-list.json.

Listing of the main packages used in the IPFS ecosystem. There are also three specifications worth linking here:

Name CI/Travis CI/Jenkins Coverage Description
Files
go-unixfs Travis CI N/A codecov the core 'filesystem' logic
go-mfs Travis CI jenkins codecov a mutable filesystem editor for unixfs
go-ipfs-posinfo Travis CI N/A codecov helper datatypes for the filestore
go-ipfs-chunker Travis CI N/A codecov file chunkers
Exchange
go-ipfs-exchange-interface Travis CI N/A codecov exchange service interface
go-ipfs-exchange-offline Travis CI N/A codecov (dummy) offline implementation of the exchange service
go-bitswap Travis CI jenkins codecov bitswap protocol implementation
go-blockservice Travis CI N/A codecov service that plugs a blockstore and an exchange together
Datastores
go-datastore Travis CI N/A codecov datastore interfaces, adapters, and basic implementations
go-ipfs-ds-help Travis CI N/A codecov datastore utility functions
go-ds-flatfs Travis CI N/A codecov a filesystem-based datastore
go-ds-measure Travis CI N/A codecov a metric-collecting database adapter
go-ds-leveldb Travis CI N/A codecov a leveldb based datastore
go-ds-badger Travis CI N/A codecov a badgerdb based datastore
Namesys
go-ipns Travis CI N/A codecov IPNS datastructures and validation logic
Repo
go-ipfs-config Travis CI N/A codecov go-ipfs config file definitions
go-fs-lock Travis CI jenkins codecov lockfile management functions
fs-repo-migrations Travis CI N/A codecov repo migrations
Blocks
go-block-format Travis CI N/A codecov block interfaces and implementations
go-ipfs-blockstore Travis CI N/A codecov blockstore interfaces and implementations
go-ipfs-blockstore Travis CI N/A codecov blockstore interfaces and implementations
Commands
go-ipfs-cmds Travis CI N/A codecov CLI & HTTP commands library
go-ipfs-cmdkit Travis CI jenkins codecov helper types for the commands library
go-ipfs-blockstore Travis CI N/A codecov blockstore interfaces and implementations
go-ipfs-api Travis CI N/A codecov a shell for the IPFS HTTP API
Metrics & Logging
go-metrics-interface Travis CI N/A codecov metrics collection interfaces
go-metrics-prometheus Travis CI N/A codecov prometheus-backed metrics collector
go-log Travis CI N/A codecov logging framework
Generics/Utils
go-ipfs-routing Travis CI N/A codecov routing (content, peer, value) helpers
go-ipfs-util Travis CI N/A codecov the kitchen sink
go-ipfs-addr Travis CI N/A codecov utility functions for parsing IPFS multiaddrs

For brevity, we've omitted go-libp2p and go-ipld packages. These package tables can be found in their respective project's READMEs:

Development

Some places to get you started on the codebase:

CLI, HTTP-API, Architecture Diagram

Origin

Description: Dotted means "likely going away". The "Legacy" parts are thin wrappers around some commands to translate between the new system and the old system. The grayed-out parts on the "daemon" diagram are there to show that the code is all the same, it's just that we turn some pieces on and some pieces off depending on whether we're running on the client or the server.

Testing

make test

Development Dependencies

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

Developer Notes

Find more documentation for developers on docs

Contributing

We ❤️ all our contributors; this project wouldn’t be what it is without you! If you want to help out, please see Contribute.md.

This repository falls under the IPFS Code of Conduct.

License

MIT