Skip to content

GitLab

Switch branch/tag
History Find file
Clone
commands/cli,http: Make sure required file arguments are provided
Matt Bell authored
9333c504
Name Last commit Last update
Godeps deps(eventlog) no need to augment Logger
blocks write a few package doc strings to improve look of godoc
blockservice write a few package doc strings to improve look of godoc
blockstore write a few package doc strings to improve look of godoc
cmd core/commands2: Fixed commands to use string arguments
commands commands/cli,http: Make sure required file arguments are provided
config revert to debug error
core core/commands2: Fixed commands to use string arguments
crypto write a few package doc strings to improve look of godoc
daemon fix(all) log.Debug -> log.Debugf
daemon2 revert to debug error
diagnostics fix(2/diag) match ipfs output
exchange chore(tests) add Short() -> SkipNow() to slowest tests
fuse mount: move Mount func into mount obj
importer chore(tests) add Short() -> SkipNow() to slowest tests
merkledag write a few package doc strings to improve look of godoc
namesys address comments from PR
net net: expose GetConnections
path write a few package doc strings to improve look of godoc
peer implement ipfs id in the new commands library
pin add in a default file hash and cleaned up init functiona bit
routing fix(misc) address PR comments
server/http daemon: listen for term signals
test test: cat test actual output
tour daemon: listen for term signals
unixfs
updates
util
.gitignore
.travis.yml
Dockerfile
LICENSE
Makefile
README.md
dev.md
doc.go
README.md

ipfs implementation in go.

GoDoc Build Status

Ipfs is a global, versioned, peer-to-peer filesystem. It combines good ideas from Git, BitTorrent, Kademlia, SFS, and the Web. It is like a single bittorrent swarm, exchanging git objects. IPFS provides an interface as simple as the HTTP web, but with permanence built in. You can also mount the world at /ipfs.

For more info 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.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 is 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:

    init          Initialize ipfs local configuration.
    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.
    update        Download and apply go-ipfs updates.
    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.
    net-diag      Print network diagnostic

Plumbing commands:

    block         Interact with raw blocks in the datastore
    object        Interact with raw dag nodes


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 the optional arguments it takes. After initialization is complete, you can use ipfs mount, ipfs add and any of the other commands to explore!

Some things to try

Basic proof of 'ipfs working' locally:

echo "hello world" > hello
ipfs add hello
# This should output a hash string that looks something like:
# QmT78zSuBmuS4z925WZfrqQ1qHaJ56DQaTfyMUF7F8ff5o
ipfs cat <that hash>

Troubleshooting

If you have previously installed ipfs before and you are running into problems getting a newer version to work, try deleting (or backing up somewhere else) your config directory (~/.go-ipfs by default) and rerunning ipfs init. This will reinitialize the config file to its defaults and clear out the local datastore of any bad entries.

For any other problems, check the issues list and if you dont see your problem there, either come talk to us on irc (freenode #ipfs) or file an issue of your own!

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