Hector Sanjuan 85651ae8cb Issue #55 : Move tooling information to it's own README in the subprojects.

Add LICENSE there too, so that the build tool for distributions includes
it in the tar files.

License: MIT
Signed-off-by: Hector Sanjuan <hector@protocol.ai>

2017-03-03 16:13:09 +01:00

5.0 KiB

Raw Blame History

ipfs-cluster

Collective pinning and composition for IPFS.

THIS SOFTWARE IS ALPHA

ipfs-cluster allows to replicate content (by pinning) in multiple IPFS nodes:

Works on top of the IPFS daemon by running one cluster peer per IPFS node (ipfs-cluster-service)
A replication_factor controls how many times a CID is pinned in the cluster
Re-pins stuff in a different place when a peer goes down
Provides an HTTP API and a command-line wrapper (ipfs-cluster-ctl)
Provides an IPFS daemon API Proxy which intercepts any "pin"/"unpin" requests and does cluster pinning instead
The IPFS Proxy allows to build cluster composition, with a cluster peer acting as an IPFS daemon for another higher-level cluster.
Peers share the state using Raft-based consensus. Uses the LibP2P stack (go-libp2p-raft, go-libp2p-rpc...)

Maintainers and Roadmap
Install
Usage
API
Architecture
Contribute
License

Maintainers and Roadmap

This project is captained by @hsanjuan. See the captain's log for a written summary of current status and upcoming features. You can also check out the project's Roadmap for a high level overview of what's coming and the project's Waffle Board to see what issues are being worked on at the moment.

Install

ipfs-cluster is written in Go. In order to install the ipfs-cluster-service the ipfs-cluster-ctl tool simply download this repository and run make as follows:

$ go get -u -d github.com/ipfs/ipfs-cluster
$ cd $GOPATH/src/github.com/ipfs/ipfs-cluster
$ make install

This will install ipfs-cluster-service and ipfs-cluster-ctl in your $GOPATH/bin folder. See the usage below.

Usage

`ipfs-cluster-service`

For information on how to configure and launch an IPFS Cluster peer see the ipfs-cluster-service README.

`ipfs-cluster-ctl`

For information on how to manage and perform operations on an IPFS Cluster peer see the ipfs-cluster-ctl README.

Go

IPFS Cluster nodes can be launched directly from Go. The Cluster object provides methods to interact with the cluster and perform actions.

Documentation and examples on how to use IPFS Cluster from Go can be found in godoc.org/github.com/ipfs/ipfs-cluster.

Additional docs

You can find more information and detailed guides:

Building and updating an IPFS Cluster

Note: please contribute to improve and add more documentation!

API

TODO: Swagger

This is a quick summary of API endpoints offered by the Rest API component (these may change before 1.0):

Method	Endpoint	Comment
GET	/id	Cluster peer information
GET	/version	Cluster version
GET	/peers	Cluster peers
POST	/peers	Add new peer
DELETE	/peers/{peerID}	Remove a peer
GET	/pinlist	List of pins in the consensus state
GET	/pins	Status of all tracked CIDs
POST	/pins/sync	Sync all
GET	/pins/{cid}	Status of single CID
POST	/pins/{cid}	Pin CID
DELETE	/pins/{cid}	Unpin CID
POST	/pins/{cid}/sync	Sync CID
POST	/pins/{cid}/recover	Recover CID

Architecture

The best place to get an overview of how cluster works, what components exist etc. is the architecture.md doc.

Contribute

PRs accepted.

Small note: If editing the README, please conform to the standard-readme specification.

5.0 KiB Raw Blame History