README
¶
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/jbenet/ipfs
Please put all issues regarding IPFS design in the ipfs repo issues. Please put all issues regarding go IPFS implementation in this repo.
Install
Install Go 1.3+. Then:
go get github.com/jbenet/go-ipfs/cmd/ipfs
cd $GOPATH/src/github.com/jbenet/go-ipfs/cmd/ipfs
go install
NOTES:
gitis required in order forgo getto fetch all dependencies.- Package managers often contain out-of-date
golangpackages. Compilation from source is recommended. - 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/jbenet/go-ipfs/issues/177)
Usage
ipfs - global versioned p2p merkledag file system
Basic commands:
init Initialize ipfs local configuration.
add <path> Add an object to ipfs.
cat <ref> Show ipfs object data.
ls <ref> List links from an object.
refs <ref> List link hashes from an object.
Tool commands:
config Manage configuration.
update Download and apply go-ipfs updates.
version Show ipfs version information.
commands List all available commands.
Advanced Commands:
mount Mount an ipfs read-only mountpoint.
serve Serve an interface to ipfs.
net-diag Print network diagnostic
Plumbing commands:
block Interact with raw blocks in the datastore
object Interact with raw dag nodes
Use "ipfs help <command>" for more information about a command.
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 help init 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>
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 config directory (~/.go-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
go-ipfs is MIT licensed open source software. We welcome contributions big and small! Please make sure to check the issues. Search the closed ones before reporting things, and help us with the open ones.
Guidelines:
- see the dev pseudo-roadmap
- please adhere to the protocol described in the main ipfs repo and paper.
- please make branches + pull-request, even if working on the main repository
- ask questions or talk about things in Issues or #ipfs on freenode.
- ensure you are able to contribute (no legal issues please-- we'll probably setup a CLA)
- run
go fmtbefore pushing any code - run
golintandgo vettoo -- some things (like protobuf files) are expected to fail. - if you'd like to work on ipfs part-time (20+ hrs/wk) or full-time (40+ hrs/wk), contact @jbenet
- have fun!
Todo
IPFS is nearing an alpha release. Things left to be done are all marked as Issues
Development Dependencies
If you make changes to the protocol buffers, you will need to install the protoc compiler.
License
MIT
Documentation
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Godeps
|
|
|
_workspace/src/bazil.org/fuse
Package fuse enables writing FUSE file systems on Linux, OS X, and FreeBSD.
|
Package fuse enables writing FUSE file systems on Linux, OS X, and FreeBSD. |
|
_workspace/src/bazil.org/fuse/fs/bench
Package bench contains benchmarks.
|
Package bench contains benchmarks. |
|
_workspace/src/bazil.org/fuse/hellofs
Hellofs implements a simple "hello world" file system.
|
Hellofs implements a simple "hello world" file system. |
|
_workspace/src/bazil.org/fuse/syscallx
Package syscallx provides wrappers that make syscalls on various platforms more interoperable.
|
Package syscallx provides wrappers that make syscalls on various platforms more interoperable. |
|
_workspace/src/bitbucket.org/kardianos/osext
Extensions to the standard "os" package.
|
Extensions to the standard "os" package. |
|
_workspace/src/code.google.com/p/go-uuid/uuid
The uuid package generates and inspects UUIDs.
|
The uuid package generates and inspects UUIDs. |
|
_workspace/src/code.google.com/p/go.crypto/blowfish
Package blowfish implements Bruce Schneier's Blowfish encryption algorithm.
|
Package blowfish implements Bruce Schneier's Blowfish encryption algorithm. |
|
_workspace/src/code.google.com/p/go.crypto/sha3
Package sha3 implements the SHA3 hash algorithm (formerly called Keccak) chosen by NIST in 2012.
|
Package sha3 implements the SHA3 hash algorithm (formerly called Keccak) chosen by NIST in 2012. |
|
_workspace/src/code.google.com/p/go.net/context
Package context defines the Context type, which carries deadlines, cancelation signals, and other request-scoped values across API boundaries and between processes.
|
Package context defines the Context type, which carries deadlines, cancelation signals, and other request-scoped values across API boundaries and between processes. |
|
_workspace/src/code.google.com/p/gogoprotobuf/proto
Package proto converts data structures to and from the wire format of protocol buffers.
|
Package proto converts data structures to and from the wire format of protocol buffers. |
|
_workspace/src/code.google.com/p/goprotobuf/proto
Package proto converts data structures to and from the wire format of protocol buffers.
|
Package proto converts data structures to and from the wire format of protocol buffers. |
|
_workspace/src/code.google.com/p/snappy-go/snappy
Package snappy implements the snappy block-based compression format.
|
Package snappy implements the snappy block-based compression format. |
|
_workspace/src/github.com/gonuts/flag
Package flag implements command-line flag parsing.
|
Package flag implements command-line flag parsing. |
|
_workspace/src/github.com/gorilla/context
Package context stores values shared during a request lifetime.
|
Package context stores values shared during a request lifetime. |
|
_workspace/src/github.com/gorilla/mux
Package gorilla/mux implements a request router and dispatcher.
|
Package gorilla/mux implements a request router and dispatcher. |
|
_workspace/src/github.com/inconshreveable/go-update
go-update allows a program to update itself by replacing its executable file with a new version.
|
go-update allows a program to update itself by replacing its executable file with a new version. |
|
_workspace/src/github.com/jbenet/commander
commander helps creating command line programs whose arguments are flags, commands and subcommands.
|
commander helps creating command line programs whose arguments are flags, commands and subcommands. |
|
_workspace/src/github.com/jbenet/go-base58
Package base58 provides base58-check encoding.
|
Package base58 provides base58-check encoding. |
|
_workspace/src/github.com/jbenet/go-datastore/keytransform
Package keytransform introduces a Datastore Shim that transforms keys before passing them to its child.
|
Package keytransform introduces a Datastore Shim that transforms keys before passing them to its child. |
|
_workspace/src/github.com/jbenet/go-datastore/namespace
Package namespace introduces a namespace Datastore Shim, which basically mounts the entire child datastore under a prefix.
|
Package namespace introduces a namespace Datastore Shim, which basically mounts the entire child datastore under a prefix. |
|
_workspace/src/github.com/jbenet/go-is-domain
Package isdomain package allows users to check whether strings represent domain names.
|
Package isdomain package allows users to check whether strings represent domain names. |
|
_workspace/src/github.com/jbenet/go-logging
Package logging implements a logging infrastructure for Go.
|
Package logging implements a logging infrastructure for Go. |
|
_workspace/src/github.com/jbenet/go-multiaddr
Package multiaddr provides an implementation of the Multiaddr network address format.
|
Package multiaddr provides an implementation of the Multiaddr network address format. |
|
_workspace/src/github.com/jbenet/go-multiaddr/net
Package manet provides Multiaddr specific versions of common functions in stdlib's net package.
|
Package manet provides Multiaddr specific versions of common functions in stdlib's net package. |
|
_workspace/src/github.com/kr/binarydist
Package binarydist implements binary diff and patch as described on http://www.daemonology.net/bsdiff/.
|
Package binarydist implements binary diff and patch as described on http://www.daemonology.net/bsdiff/. |
|
_workspace/src/github.com/syndtr/goleveldb/leveldb
Package leveldb provides implementation of LevelDB key/value database.
|
Package leveldb provides implementation of LevelDB key/value database. |
|
_workspace/src/github.com/syndtr/goleveldb/leveldb/cache
Package cache provides interface and implementation of a cache algorithms.
|
Package cache provides interface and implementation of a cache algorithms. |
|
_workspace/src/github.com/syndtr/goleveldb/leveldb/comparer
Package comparer provides interface and implementation for ordering sets of data.
|
Package comparer provides interface and implementation for ordering sets of data. |
|
_workspace/src/github.com/syndtr/goleveldb/leveldb/filter
Package filter provides interface and implementation of probabilistic data structure.
|
Package filter provides interface and implementation of probabilistic data structure. |
|
_workspace/src/github.com/syndtr/goleveldb/leveldb/iterator
Package iterator provides interface and implementation to traverse over contents of a database.
|
Package iterator provides interface and implementation to traverse over contents of a database. |
|
_workspace/src/github.com/syndtr/goleveldb/leveldb/journal
Package journal reads and writes sequences of journals.
|
Package journal reads and writes sequences of journals. |
|
_workspace/src/github.com/syndtr/goleveldb/leveldb/memdb
Package memdb provides in-memory key/value database implementation.
|
Package memdb provides in-memory key/value database implementation. |
|
_workspace/src/github.com/syndtr/goleveldb/leveldb/opt
Package opt provides sets of options used by LevelDB.
|
Package opt provides sets of options used by LevelDB. |
|
_workspace/src/github.com/syndtr/goleveldb/leveldb/storage
Package storage provides storage abstraction for LevelDB.
|
Package storage provides storage abstraction for LevelDB. |
|
_workspace/src/github.com/syndtr/goleveldb/leveldb/table
Package table allows read and write sorted key/value.
|
Package table allows read and write sorted key/value. |
|
_workspace/src/github.com/syndtr/goleveldb/leveldb/util
Package util provides utilities used throughout leveldb.
|
Package util provides utilities used throughout leveldb. |
|
_workspace/src/github.com/tuxychandru/pubsub
Package pubsub implements a simple multi-topic pub-sub library.
|
Package pubsub implements a simple multi-topic pub-sub library. |
|
package blocks contains the lowest level of ipfs data structures, the raw block with a checksum.
|
package blocks contains the lowest level of ipfs data structures, the raw block with a checksum. |
|
bloom
package bloom implements a simple bloom filter.
|
package bloom implements a simple bloom filter. |
|
set
package set contains various different types of 'BlockSet's
|
package set contains various different types of 'BlockSet's |
|
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. |
|
package blockstore implements a thin wrapper over a datastore, giving a clean interface for Getting and Putting block objects.
|
package blockstore implements a thin wrapper over a datastore, giving a clean interface for Getting and Putting block objects. |
|
cmd
|
|
|
package config implements the ipfs config file datastructures and utilities.
|
package config implements the ipfs config file datastructures and utilities. |
|
package crypto implements various cryptographic utilities used by ipfs.
|
package crypto implements various cryptographic utilities used by ipfs. |
|
internal/pb
Package crypto_pb is a generated protocol buffer package.
|
Package crypto_pb is a generated protocol buffer package. |
|
spipe
package spipe handles establishing secure communication between two peers.
|
package spipe handles establishing secure communication between two peers. |
|
spipe/internal/pb
Package spipe_pb is a generated protocol buffer package.
|
Package spipe_pb is a generated protocol buffer package. |
|
package diagnostics implements a network diagnostics service that allows a request to traverse the network and gather information on every node connected to it.
|
package diagnostics implements a network diagnostics service that allows a request to traverse the network and gather information on every node connected to it. |
|
internal/pb
Package diagnostics_pb is a generated protocol buffer package.
|
Package diagnostics_pb is a generated protocol buffer package. |
|
package exchange defines the IPFS Exchange interface
|
package exchange defines the IPFS Exchange interface |
|
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/message/internal/pb
Package bitswap_message_pb is a generated protocol buffer package.
|
Package bitswap_message_pb is a generated protocol buffer package. |
|
offline
package offline implements an object that implements the exchange interface but returns nil values to every request.
|
package offline implements an object that implements the exchange interface but returns nil values to every request. |
|
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. |
|
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 |
|
chunk
package chunk implements streaming block splitters
|
package chunk implements streaming block splitters |
|
package merkledag implements the ipfs Merkle DAG datastructures.
|
package merkledag implements the ipfs Merkle DAG datastructures. |
|
internal/pb
Package merkledag_pb is a generated protocol buffer package.
|
Package merkledag_pb is a generated protocol buffer package. |
|
internal/pb
Package namesys_pb is a generated protocol buffer package.
|
Package namesys_pb is a generated protocol buffer package. |
|
package net provides an interface for ipfs to interact with the network through
|
package net provides an interface for ipfs to interact with the network through |
|
handshake
package handshake implements the ipfs handshake protocol
|
package handshake implements the ipfs handshake protocol |
|
handshake/pb
Package handshake_pb is a generated protocol buffer package.
|
Package handshake_pb is a generated protocol buffer package. |
|
mux
package mux implements a protocol muxer.
|
package mux implements a protocol muxer. |
|
mux/internal/pb
Package mux_pb is a generated protocol buffer package.
|
Package mux_pb is a generated protocol buffer package. |
|
service/internal/pb
Package service_pb is a generated protocol buffer package.
|
Package service_pb is a generated protocol buffer package. |
|
swarm
package swarm implements a connection muxer with a pair of channels to synchronize all network communication.
|
package swarm implements a connection muxer with a pair of channels to synchronize all network communication. |
|
package path implements utilities for resolving paths within ipfs.
|
package path implements utilities for resolving paths within ipfs. |
|
package peer implements an object used to represent peers in the ipfs network.
|
package peer implements an object used to represent peers in the ipfs network. |
|
package pin implemnts structures and methods to keep track of which objects a user wants to keep stored locally.
|
package pin implemnts structures and methods to keep track of which objects a user wants to keep stored locally. |
|
package routing defines the interface for a routing system used by ipfs.
|
package routing defines the interface for a routing system used by ipfs. |
|
dht
package dht implements a distributed hash table that satisfies the ipfs routing interface.
|
package dht implements a distributed hash table that satisfies the ipfs routing interface. |
|
dht/pb
Package dht_pb is a generated protocol buffer package.
|
Package dht_pb is a generated protocol buffer package. |
|
kbucket
package kbucket implements a kademlia 'k-bucket' routing table.
|
package kbucket implements a kademlia 'k-bucket' routing table. |
|
server
|
|
|
http
package http implements an http server that serves static content from ipfs
|
package http implements an http server that serves static content from ipfs |
|
test
|
|
|
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. |
|
Package format 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 format 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 |
|
io
package unixfs/io implements convenience objects for working with the ipfs unixfs data format.
|
package unixfs/io implements convenience objects for working with the ipfs unixfs data format. |
|
pb
Package unixfs_pb is a generated protocol buffer package.
|
Package unixfs_pb is a generated protocol buffer package. |
|
package util implements various utility functions used within ipfs that do not currently have a better place to live.
|
package util implements various utility functions used within ipfs that do not currently have a better place to live. |
Click to show internal directories.
Click to hide internal directories.