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 Go 1.3+. 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 forgo 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 ipfs#177)
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.
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
.
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
andgo 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!
IPFS is nearing an alpha release. Things left to be done are all marked as Issues
If you make changes to the protocol buffers, you will need to install the protoc compiler.
MIT