README
¶
ipfs implementation in go. 
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. Then:
go get github.com/jbenet/go-ipfs/cmd/ipfs
cd $GOPATH/src/github.com/jbenet/go-ipfs/cmd/ipfs
go install
NOTE: git and mercurial (hg) are required in order for go get to fetch
all dependencies.
If you are interested in development, please install the development dependencies as well.
Usage
ipfs - global versioned p2p merkledag file system
Basic commands:
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.
version Show ipfs version information.
commands List all available commands.
Advanced Commands:
mount Mount an ipfs read-only mountpoint.
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
arguments it takes. After initialization is complete, you can use ipfs mount,
ipfs add and any of the other commands to explore!
NOTE: if you have previously installed ipfs before and you are running into
problems getting it to work, try deleting (or backing up somewhere else) your
config directory (~/.go-ipfs by default) and rerunning ipfs init.
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/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/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/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/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. |
|
cmd
|
|
|
Package crypto is a generated protocol buffer package.
|
Package crypto is a generated protocol buffer package. |
|
spipe
Package spipe is a generated protocol buffer package.
|
Package spipe is a generated protocol buffer package. |
|
bitswap/message
Package bitswap is a generated protocol buffer package.
|
Package bitswap is a generated protocol buffer package. |
|
fuse
|
|
|
Package merkledag is a generated protocol buffer package.
|
Package merkledag is a generated protocol buffer package. |
|
mux
Package mux is a generated protocol buffer package.
|
Package mux is a generated protocol buffer package. |
|
service
Package service is a generated protocol buffer package.
|
Package service is a generated protocol buffer package. |
|
dht
Package dht is a generated protocol buffer package.
|
Package dht is a generated protocol buffer package. |
Click to show internal directories.
Click to hide internal directories.