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
1,115 Commits 160 Branches 212 Tags 122 MiB
Go 82.9%
Shell 16.4%
Makefile 0.6%
Dockerfile 0.1%
402fdd2db9
Go to file
Jeromy 402fdd2db9 changes from PR
2014-11-03 01:45:45 +00:00
blocks address comments from PR 2014-11-01 16:07:56 -07:00
blockservice benchmark secure channel 2014-11-01 16:07:56 -07:00
blockstore cleanup from CR 2014-11-01 16:07:56 -07:00
cmd/ipfs move OSX specific calls to build tagged files 2014-10-31 19:46:42 +00:00
commands go-vet friendly codebase 2014-10-25 03:46:39 -07:00
config tour: command 2014-10-26 08:32:08 -07:00
core some small cleanup of logging 2014-11-01 16:07:56 -07:00
crypto remove signed pipe 2014-11-01 16:07:56 -07:00
daemon fix(all) log.Debug -> log.Debugf 2014-10-30 06:35:29 -07:00
diagnostics go-vet friendly codebase 2014-10-25 03:46:39 -07:00
exchange benchmark secure channel 2014-11-01 16:07:56 -07:00
fuse fix(all) log.Debug -> log.Debugf 2014-10-30 06:35:29 -07:00
Godeps Godeps GoVersion off devel 2014-11-01 17:53:11 -07:00
importer more memory tweaks 2014-11-01 16:07:56 -07:00
merkledag make FetchGraph waitable 2014-11-01 16:07:56 -07:00
namesys fix(all) log.Debug -> log.Debugf 2014-10-30 06:35:29 -07:00
net changes from PR 2014-11-03 01:45:45 +00:00
path fix(all) log.Debug -> log.Debugf 2014-10-30 06:35:29 -07:00
peer go-vet friendly codebase 2014-10-25 03:46:39 -07:00
pin fix(all) log.Debug -> log.Debugf 2014-10-30 06:35:29 -07:00
routing cleanup from CR 2014-11-01 16:07:56 -07:00
server/http updated multiaddr for net pkg 2014-10-11 03:07:36 -07:00
test Add test script for ipfs init 2014-10-26 10:10:22 +01:00
tour tour: command 2014-10-26 08:32:08 -07:00
unixfs finish addressing PR concerns 2014-11-01 16:07:56 -07:00
updates updates: dont count dev versions as older 2014-10-26 01:38:44 -07:00
util changes from PR 2014-11-03 01:45:45 +00:00
.gitignore Save ipfs version used to initialize config 2014-10-09 19:57:59 -07:00
.travis.yml Remove Travis testing of Go 1.2 2014-11-01 17:55:59 -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 feat(docker) build a daemon 2014-11-01 17:32:49 -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

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