coosld/kubo
1
0
Fork 0
mirror of https://github.com/ipfs/kubo.git synced 2026-02-22 19:07:48 +08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity
An IPFS implementation in Go
665 Commits 160 Branches 212 Tags 122 MiB
Go 82.9%
Shell 16.4%
Makefile 0.6%
Dockerfile 0.1%
dc2dbdbb02
Go to file
Juan Batiz-Benet dc2dbdbb02 vendor things 
cc @whyrusleeping
2014-10-08 04:17:52 -07:00
blocks removed error from return type of blocks.NewBlock() 2014-10-07 20:46:01 +00:00
blockservice make tests pass 2014-10-08 04:25:51 +00:00
blockstore one last failed test 2014-10-07 21:35:33 -07:00
cmd/ipfs init SetupLoggers 2014-10-08 02:50:42 -07:00
config ipfs + ipns mounts with flags + config 2014-10-02 03:05:49 -07:00
core New NameSystem interface 2014-10-08 04:14:52 -07:00
crypto changed logging, in dht and elsewhere 2014-10-07 21:33:59 -07:00
daemon updated multiaddr use across codebase 2014-10-06 04:13:43 -07:00
exchange bugfix: use consistent interface 2014-10-07 21:32:17 -07:00
fuse New NameSystem interface 2014-10-08 04:14:52 -07:00
Godeps updated multiaddr 2014-10-06 04:07:22 -07:00
importer vendor things 2014-10-08 04:17:52 -07:00
merkledag deprecate merkledag.Node.Update 2014-10-08 03:11:29 -07:00
msgproto add a package header so the package compiles 2014-07-18 18:29:53 -07:00
namesys New NameSystem interface 2014-10-08 04:14:52 -07:00
net Obviated need for .ID.Pretty() all over the place. 2014-10-06 04:23:55 -07:00
path loggers: set level 2014-10-04 03:53:21 -07:00
peer changed logging, in dht and elsewhere 2014-10-07 21:33:59 -07:00
routing changed logging, in dht and elsewhere 2014-10-07 21:33:59 -07:00
server/http updated multiaddr use across codebase 2014-10-06 04:13:43 -07:00
util init SetupLoggers 2014-10-08 02:50:42 -07:00
.gitignore implement dagmodifier and tests. 2014-10-06 23:49:45 +00:00
.travis.yml 1.1 fails with multihash 2014-07-30 01:53:29 -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 moved http to server/http and implemented serve http subcommand 2014-09-30 22:59:53 +03:00

README.md

ipfs implementation in go. GoDoc

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