An IPFS implementation in Go
Go to file
Christian Couder aeb019f2b8 Add test/Makefile to run the test scripts
You can use it like this to launch all the
test scripts in order:

$ cd test
$ make
 rm -r test-results
 *** t0010-basic-commands.sh ***
 ok 1 - current dir is writable
 ok 2 - ipfs version succeeds
 ok 3 - ipfs version output looks good
 ok 4 - ipfs help succeeds
 ok 5 - ipfs help output looks good
 # passed all 5 test(s)
 1..5
 ./test-aggregate-results.sh
 fixed   0
 success 5
 failed  0
 broken  0
 total   5

Or you can just run one test like this:

$ make t0010-basic-commands.sh
 *** t0010-basic-commands.sh ***
 ok 1 - current dir is writable
 ok 2 - ipfs version succeeds
 ok 3 - ipfs version output looks good
 ok 4 - ipfs help succeeds
 ok 5 - ipfs help output looks good
 # passed all 5 test(s)
 1..5
2014-10-25 14:12:27 +02:00
blocks fixed pin json marshal 2014-10-22 02:55:22 -07:00
blockservice renamed datastore.go -> go-datastore 2014-10-21 15:10:58 -07:00
blockstore renamed datastore.go -> go-datastore 2014-10-21 15:10:58 -07:00
cmd/ipfs ipfs cmd help now shows update 2014-10-22 15:22:01 -07:00
commands commands: Added Request#SetStream 2014-10-21 18:27:39 -07:00
config config: custom AutoUpdate type for validity 2014-10-22 11:25:30 +02:00
core fixed --force flag for shutdown after update 2014-10-22 12:42:13 +02:00
crypto refactor(crypto) mv proto PBPublicKey -> PublicKey, etc. 2014-10-22 21:49:43 -07:00
daemon updateApply: force shutdown check on daemon (TODO: force flag in cli) 2014-10-22 11:25:30 +02:00
diagnostics fix(diag) rename proto package -> diagnostics_pb 2014-10-22 15:54:18 -07:00
exchange refactor(bitswap) mv proto PBMessage -> Message 2014-10-22 21:49:46 -07:00
fuse refactor(unixfs/pb) mv proto PBData -> Data, etc. 2014-10-22 21:52:59 -07:00
Godeps Merge pull request #192 from jbenet/dhtfixes 2014-10-22 22:20:36 -07:00
importer Rework package structure for unixfs and subpackage 2014-10-08 21:14:18 +00:00
merkledag fix(merkledag/pb) rename proto package -> merkledag_pb 2014-10-22 15:54:18 -07:00
namesys fix(namesys/pb) rename proto package -> namesys_pb 2014-10-22 15:54:18 -07:00
net Merge pull request #192 from jbenet/dhtfixes 2014-10-22 22:20:36 -07:00
path u.DOut -> log.Debug 2014-10-09 04:50:22 -07:00
peer handshake3 (addrs) 2014-10-22 05:25:31 -07:00
pin fixed pin json marshal 2014-10-22 02:55:22 -07:00
routing fix for #141, routing table segmentation 2014-10-22 15:08:32 -07:00
server/http updated multiaddr for net pkg 2014-10-11 03:07:36 -07:00
test Add test/Makefile to run the test scripts 2014-10-25 14:12:27 +02:00
unixfs refactor(unixfs/pb) mv proto PBData -> Data, etc. 2014-10-22 21:52:59 -07:00
updates equinox.io app id 2014-10-22 15:17:03 -07:00
util nicer, greppable logging 2014-10-22 03:24:05 -07:00
.gitignore Save ipfs version used to initialize config 2014-10-09 19:57:59 -07:00
.travis.yml skip ipns fuse tests in travis 2014-10-09 02:59:56 -07:00
dev.md update readme and dev guide 2014-09-19 05:34:39 +00:00
doc.go docs(godoc) add doc.go in project root 2014-09-14 04:28:34 -07:00
Dockerfile fix(docker) listen on all interfaces 2014-09-16 03:47:31 -07:00
LICENSE added MIT license 2014-07-10 12:16:22 -07:00
Makefile vendor dependencies with godep 2014-09-09 22:39:42 -07:00
README.md rewrote HOME dir lookup (no cgo) 2014-10-15 11:58:25 +02:00

ipfs implementation in go. GoDoc Build Status

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.2+. Then:

go get github.com/jbenet/go-ipfs/cmd/ipfs
cd $GOPATH/src/github.com/jbenet/go-ipfs/cmd/ipfs
go install

NOTES:

  • git and mercurial (hg) are required in order for go get to fetch all dependencies.
  • Package managers often contain out-of-date golang packages. 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:

    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.
    serve         Serve an interface to ipfs.

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 fmt before pushing any code
  • run golint and go vet too -- 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