2018-04-26 10:02:39 +00:00
# IPFS Cluster
2016-07-01 19:01:27 +00:00
2017-07-26 15:33:04 +00:00
[![Made by ](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square )](https://protocol.ai)
[![Main project ](https://img.shields.io/badge/project-ipfs-blue.svg?style=flat-square )](http://github.com/ipfs/ipfs)
[![IRC channel ](https://img.shields.io/badge/freenode-%23ipfs--cluster-blue.svg?style=flat-square )](http://webchat.freenode.net/?channels=%23ipfs-cluster)
2016-12-02 18:33:39 +00:00
[![standard-readme compliant ](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square )](https://github.com/RichardLitt/standard-readme)
2016-12-08 16:47:43 +00:00
[![GoDoc ](https://godoc.org/github.com/ipfs/ipfs-cluster?status.svg )](https://godoc.org/github.com/ipfs/ipfs-cluster)
2017-01-24 11:39:08 +00:00
[![Go Report Card ](https://goreportcard.com/badge/github.com/ipfs/ipfs-cluster )](https://goreportcard.com/report/github.com/ipfs/ipfs-cluster)
2016-12-08 16:47:43 +00:00
[![Build Status ](https://travis-ci.org/ipfs/ipfs-cluster.svg?branch=master )](https://travis-ci.org/ipfs/ipfs-cluster)
[![Coverage Status ](https://coveralls.io/repos/github/ipfs/ipfs-cluster/badge.svg?branch=master )](https://coveralls.io/github/ipfs/ipfs-cluster?branch=master)
2018-04-26 10:02:39 +00:00
> Pinset orchestration for IPFS.
2016-07-01 19:01:27 +00:00
2018-04-26 10:02:39 +00:00
< p align = "center" >
< img src = "https://cluster.ipfs.io/cluster/png/IPFS_Cluster_color_no_text.png" alt = "logo" width = "300" height = "300" / >
< / p >
2016-07-01 19:01:27 +00:00
2018-04-26 10:02:39 +00:00
IPFS Cluster allows to allocate, replicate and track Pins across a cluster of IPFS daemons.
2016-07-01 19:01:27 +00:00
2018-04-26 10:02:39 +00:00
It provides:
2016-10-10 16:43:59 +00:00
2018-04-26 10:02:39 +00:00
* A cluster peer application: `ipfs-cluster-service` , to be run along with `go-ipfs` .
* A client CLI application: `ipfs-cluster-ctl` , which allows easily interacting with the peer's HTTP API.
2016-10-10 16:43:59 +00:00
2016-12-02 18:33:39 +00:00
## Table of Contents
2016-10-10 16:43:59 +00:00
2018-04-26 10:02:39 +00:00
- [Documentation ](#documentation )
- [News & Roadmap ](#news--roadmap )
2016-12-02 18:33:39 +00:00
- [Install ](#install )
- [Usage ](#usage )
- [Contribute ](#contribute )
- [License ](#license )
2018-04-26 10:02:39 +00:00
## Documentation
2017-03-10 12:12:30 +00:00
2018-04-26 10:02:39 +00:00
Please visit https://cluster.ipfs.io/documentation/ to access user documentation, guides and any other resources, including detailed **download** and **usage** instructions.
2017-03-10 12:12:30 +00:00
2018-04-26 10:02:39 +00:00
## News & Roadmap
2017-03-10 12:12:30 +00:00
2018-04-26 10:02:39 +00:00
We regularly post project updates to https://cluster.ipfs.io/news/ .
2017-03-10 12:12:30 +00:00
2018-04-26 10:02:39 +00:00
The most up-to-date *Roadmap* is available at https://cluster.ipfs.io/roadmap/ .
2017-03-10 12:12:30 +00:00
2018-04-26 10:02:39 +00:00
## Install
2016-12-21 19:04:28 +00:00
2018-04-26 10:02:39 +00:00
Instructions for different installation methods (including from source) are available at https://cluster.ipfs.io/documentation/download .
2016-12-02 18:33:39 +00:00
## Usage
2018-04-26 10:02:39 +00:00
Extensive usage information is provided at https://cluster.ipfs.io/documentation/ , including:
2017-02-15 14:16:16 +00:00
2018-04-26 10:02:39 +00:00
* [Docs for `ipfs-cluster-service` ](https://cluster.ipfs.io/documentation/ipfs-cluster-service/ )
* [Docs for `ipfs-cluster-ctl` ](https://cluster.ipfs.io/documentation/ipfs-cluster-ctl/ )
2017-02-15 14:16:16 +00:00
2016-12-02 18:33:39 +00:00
## Contribute
2018-04-26 10:02:39 +00:00
PRs accepted. As part of the IPFS project, we have some [contribution guidelines ](https://cluster.ipfs.io/developer/contribute ).
2016-12-02 18:33:39 +00:00
Small note: If editing the README, please conform to the [standard-readme ](https://github.com/RichardLitt/standard-readme ) specification.
## License
MIT © Protocol Labs, Inc.