README
¶
go-ipfs
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 the Go IPFS implementation in this repo.
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
ipfsto your path (install.shcan do it for you).
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.
gitis required in order forgo getto fetch all dependencies.- Package managers often contain out-of-date
golangpackages. Ensure thatgo versionreports 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.
Development Dependencies
If you make changes to the protocol buffers, you will need to install the protoc compiler.
Updating
Updating 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!
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.
Want to hack on IPFS?
Want to read our code?
Some places to get you started. (WIP)
Main file: cmd/ipfs/main.go
CLI Commands: core/commands/
Bitswap (the data trading engine): exchange/bitswap/
DHT: https://github.com/libp2p/go-libp2p-kad-dht
PubSub: https://github.com/libp2p/go-floodsub
libp2p: https://github.com/libp2p/go-libp2p
License
MIT
Documentation
¶
Overview ¶
IPFS is a global, versioned, peer-to-peer filesystem
There are sub-packages within the ipfs package for various low-level utilities, which are in turn assembled into:
core/...:
The low-level API that gives consumers all the knobs they need, which we try hard to keep stable.
shell/...:
The high-level API that gives consumers easy access to common operations (e.g. create a file node from a reader without wrapping with metadata). We work really hard to keep this stable.
Then on top of the core/... and shell/... Go APIs, we have:
cmd/...:
Command-line executables
test/...:
Integration tests, etc.
To avoid cyclic imports, imports should never pull in higher-level APIs into a lower-level package. For example, you could import all of core and shell from cmd/... or test/..., but you couldn't import any of shell from core/....
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Godeps
|
|
|
_workspace/src/github.com/hashicorp/golang-lru
This package provides a simple LRU cache.
|
This package provides a simple LRU cache. |
|
blocks
|
|
|
blockstoreutil
Package blockstoreutil provides utility functions for Blockstores.
|
Package blockstoreutil provides utility functions for Blockstores. |
|
package blockservice implements a BlockService interface that provides a single GetBlock/AddBlock interface that seamlessly retrieves data either locally or from a remote peer through the exchange.
|
package blockservice implements a BlockService interface that provides a single GetBlock/AddBlock interface that seamlessly retrieves data either locally or from a remote peer through the exchange. |
|
cmd
|
|
|
ipfs
command
cmd/ipfs implements the primary CLI binary for ipfs
|
cmd/ipfs implements the primary CLI binary for ipfs |
|
ipfswatch
command
|
|
|
seccat
command
package main provides an implementation of netcat using the secio package.
|
package main provides an implementation of netcat using the secio package. |
|
Package core implements the IpfsNode object and related methods.
|
Package core implements the IpfsNode object and related methods. |
|
commands
Package commands implements the ipfs command interface Using github.com/ipfs/go-ipfs/commands to define the command line and HTTP APIs.
|
Package commands implements the ipfs command interface Using github.com/ipfs/go-ipfs/commands to define the command line and HTTP APIs. |
|
coreapi
Package coreapi provides direct access to the core commands in IPFS.
|
Package coreapi provides direct access to the core commands in IPFS. |
|
coreapi/interface
Package iface defines IPFS Core API which is a set of interfaces used to interact with IPFS nodes.
|
Package iface defines IPFS Core API which is a set of interfaces used to interact with IPFS nodes. |
|
corehttp
Package corehttp provides utilities for the webui, gateways, and other high-level HTTP interfaces to IPFS.
|
Package corehttp provides utilities for the webui, gateways, and other high-level HTTP interfaces to IPFS. |
|
corerepo
Package corerepo provides pinning and garbage collection for local IPFS block services.
|
Package corerepo provides pinning and garbage collection for local IPFS block services. |
|
exchange
|
|
|
bitswap
package bitswap implements the IPFS exchange interface with the BitSwap bilateral exchange protocol.
|
package bitswap implements the IPFS exchange interface with the BitSwap bilateral exchange protocol. |
|
bitswap/decision
package decision implements the decision engine for the bitswap service.
|
package decision implements the decision engine for the bitswap service. |
|
bitswap/message/pb
Package bitswap_message_pb is a generated protocol buffer package.
|
Package bitswap_message_pb is a generated protocol buffer package. |
|
bitswap/wantlist
package wantlist implements an object for bitswap that contains the keys that a given peer wants.
|
package wantlist implements an object for bitswap that contains the keys that a given peer wants. |
|
Package filestore implements a Blockstore which is able to read certain blocks of data directly from its original location in the filesystem.
|
Package filestore implements a Blockstore which is able to read certain blocks of data directly from its original location in the filesystem. |
|
pb
Package datastore_pb is a generated protocol buffer package.
|
Package datastore_pb is a generated protocol buffer package. |
|
fuse
|
|
|
ipns
package fuse/ipns implements a fuse filesystem that interfaces with ipns, the naming system for ipfs.
|
package fuse/ipns implements a fuse filesystem that interfaces with ipns, the naming system for ipfs. |
|
mount
package mount provides a simple abstraction around a mount point
|
package mount provides a simple abstraction around a mount point |
|
readonly
package fuse/readonly implements a fuse filesystem to access files stored inside of ipfs.
|
package fuse/readonly implements a fuse filesystem to access files stored inside of ipfs. |
|
Package importer implements utilities used to create IPFS DAGs from files and readers.
|
Package importer implements utilities used to create IPFS DAGs from files and readers. |
|
balanced
Package balanced provides methods to build balanced DAGs.
|
Package balanced provides methods to build balanced DAGs. |
|
trickle
Package trickle allows to build trickle DAGs.
|
Package trickle allows to build trickle DAGs. |
|
Package merkledag implements the IPFS Merkle DAG data structures.
|
Package merkledag implements the IPFS Merkle DAG data structures. |
|
pb
Package merkledag_pb is a generated protocol buffer package.
|
Package merkledag_pb is a generated protocol buffer package. |
|
traverse
Package traverse provides merkledag traversal functions
|
Package traverse provides merkledag traversal functions |
|
package mfs implements an in memory model of a mutable IPFS filesystem.
|
package mfs implements an in memory model of a mutable IPFS filesystem. |
|
Package namesys implements resolvers and publishers for the IPFS naming system (IPNS).
|
Package namesys implements resolvers and publishers for the IPFS naming system (IPNS). |
|
Package path contains utilities to work with ipfs paths.
|
Package path contains utilities to work with ipfs paths. |
|
resolver
Package resolver implements utilities for resolving paths within ipfs.
|
Package resolver implements utilities for resolving paths within ipfs. |
|
Package pin implements structures and methods to keep track of which objects a user wants to keep stored locally.
|
Package pin implements structures and methods to keep track of which objects a user wants to keep stored locally. |
|
gc
Package gc provides garbage collection for go-ipfs.
|
Package gc provides garbage collection for go-ipfs. |
|
internal/pb
Package pb is a generated protocol buffer package.
|
Package pb is a generated protocol buffer package. |
|
config
package config implements the ipfs config file datastructures and utilities.
|
package config implements the ipfs config file datastructures and utilities. |
|
fsrepo
package fsrepo TODO explain the package roadmap...
|
package fsrepo TODO explain the package roadmap... |
|
test
|
|
|
api-startup
command
|
|
|
bench/bench_cli_ipfs_add
command
|
|
|
bench/offline_add
command
|
|
|
dependencies/go-sleep
command
|
|
|
dependencies/go-timeout
command
|
|
|
dependencies/ma-pipe-unidir
command
|
|
|
sharness/lib
package randomdep is here to introduce a dependency in random for godep to function properly.
|
package randomdep is here to introduce a dependency in random for godep to function properly. |
|
thirdparty
|
|
|
notifier
Package notifier provides a simple notification dispatcher meant to be embedded in larger structres who wish to allow clients to sign up for event notifications.
|
Package notifier provides a simple notification dispatcher meant to be embedded in larger structres who wish to allow clients to sign up for event notifications. |
|
pollEndpoint
command
pollEndpoint is a helper utility that waits for a http endpoint to be reachable and return with http.StatusOK
|
pollEndpoint is a helper utility that waits for a http endpoint to be reachable and return with http.StatusOK |
|
Package unixfs implements a data format for files in the IPFS filesystem It is not the only format in ipfs, but it is the one that the filesystem assumes
|
Package unixfs implements a data format for files in the IPFS filesystem It is not the only format in ipfs, but it is the one that the filesystem assumes |
|
archive
Package archive provides utilities to archive and compress a [Unixfs] DAG.
|
Package archive provides utilities to archive and compress a [Unixfs] DAG. |
|
archive/tar
Package tar provides functionality to write a unixfs merkledag as a tar archive.
|
Package tar provides functionality to write a unixfs merkledag as a tar archive. |
|
hamt
Package hamt implements a Hash Array Mapped Trie over ipfs merkledag nodes.
|
Package hamt implements a Hash Array Mapped Trie over ipfs merkledag nodes. |
|
io
Package io implements convenience objects for working with the ipfs unixfs data format.
|
Package io implements convenience objects for working with the ipfs unixfs data format. |
|
mod
Package mod provides DAG modification utilities to, for example, insert additional nodes in a unixfs DAG or truncate them.
|
Package mod provides DAG modification utilities to, for example, insert additional nodes in a unixfs DAG or truncate them. |
|
pb
Package unixfs_pb is a generated protocol buffer package.
|
Package unixfs_pb is a generated protocol buffer package. |