coosld/kubo
1
0
Fork 0
mirror of https://github.com/ipfs/kubo.git synced 2026-02-22 02:47:48 +08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity
An IPFS implementation in Go
739 Commits 160 Branches 212 Tags 122 MiB
Go 82.9%
Shell 16.4%
Makefile 0.6%
Dockerfile 0.1%
f12a39cd9c
Go to file
Juan Batiz-Benet f12a39cd9c OSX FUSE note.
2014-10-14 02:24:01 -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 fix setupCmdContext() for subcommands (fixes #163) 2014-10-14 10:49:01 +02:00
config fixed a parsing bug on Version.CheckPeriod 2014-10-09 20:31:26 -07:00
core added TODO about reading from io.Reader arg 2014-10-14 09:57:19 +02:00
crypto u.DOut -> log.Debug 2014-10-09 04:50:22 -07:00
daemon added block get and put commands to daemon 2014-10-13 20:47:09 +02:00
diagnostics add diagnostic logging 2014-10-10 13:18:20 -07:00
exchange clean up and add inet.Network to bitswap 2014-10-10 20:43:04 -07:00
fuse u.DOut -> log.Debug 2014-10-09 04:50:22 -07:00
Godeps updated multiaddr for net pkg 2014-10-11 03:07:36 -07:00
importer Rework package structure for unixfs and subpackage 2014-10-08 21:14:18 +00:00
merkledag add plumbing output + logging 2014-10-13 02:40:39 -07:00
msgproto add a package header so the package compiles 2014-07-18 18:29:53 -07:00
namesys fixed resolver test 2014-10-09 03:50:52 -07:00
net move net -> multiaddr/net 2014-10-11 03:24:35 -07:00
path u.DOut -> log.Debug 2014-10-09 04:50:22 -07:00
peer actually put diagCmd into the super command so it can be run 2014-10-10 13:18:19 -07:00
routing handler fixes for tests 2014-10-10 20:48:20 -07:00
server/http updated multiaddr for net pkg 2014-10-11 03:07:36 -07:00
unixfs add another test to try and reproduce data loss issue 2014-10-08 22:38:33 +00:00
updates vendored go-semver 2014-10-09 20:01:49 -07:00
util broke up log file + logging env 2014-10-11 04:44:59 -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 OSX FUSE note. 2014-10-14 02:24:01 -07:00

README.md

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.
  • go-ipfs depends on cgo. In case you've disabled cgo, you'll need to compile with CGO_ENABLED=1
  • If you are interested in development, please install the development dependencies as well.
  • WARNING: older versions of OSX FUSE can cause kernel panics when mounting! We strongly recommend you use the latest version of OSX FUSE. (read these IRC logs for help upgrading)

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