2018-04-26 10:02:39 +00:00
# IPFS Cluster
2016-07-01 19:01:27 +00:00
2022-06-15 13:11:38 +00:00
[![Made by ](https://img.shields.io/badge/By-Protocol%20Labs-000000.svg?style=flat-square )](https://protocol.ai)
[![Main project ](https://img.shields.io/badge/project-ipfs--cluster-ef5c43.svg?style=flat-square )](http://github.com/ipfs-cluster)
[![Discord ](https://img.shields.io/badge/forum-discuss.ipfs.io-f9a035.svg?style=flat-square )](https://discuss.ipfs.io/c/help/help-ipfs-cluster/24)
[![Matrix channel ](https://img.shields.io/badge/matrix-%23ipfs--cluster-3c8da0.svg?style=flat-square )](https://app.element.io/#/room/#ipfs-cluster:ipfs.io)
2022-06-15 09:19:17 +00:00
[![pkg.go.dev ](https://pkg.go.dev/badge/github.com/ipfs-cluster/ipfs-cluster )](https://pkg.go.dev/github.com/ipfs-cluster/ipfs-cluster)
[![Go Report Card ](https://goreportcard.com/badge/github.com/ipfs-cluster/ipfs-cluster )](https://goreportcard.com/report/github.com/ipfs-cluster/ipfs-cluster)
[![codecov ](https://codecov.io/gh/ipfs-cluster/ipfs-cluster/branch/master/graph/badge.svg )](https://codecov.io/gh/ipfs-cluster/ipfs-cluster)
2016-12-08 16:47:43 +00:00
2022-06-15 09:19:17 +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" >
2022-06-15 09:30:23 +00:00
< img src = "https://ipfscluster.io/cluster/png/IPFS_Cluster_color_no_text.png" alt = "logo" width = "300" height = "300" / >
2018-04-26 10:02:39 +00:00
< / p >
2016-07-01 19:01:27 +00:00
2022-06-15 09:47:43 +00:00
[IPFS Cluster ](https://ipfscluster.io ) provides data orchestration across a swarm of IPFS daemons by allocating, replicating and tracking a global pinset distributed among multiple peers.
2016-07-01 19:01:27 +00:00
2022-06-15 09:19:17 +00:00
There are 3 different applications:
2016-10-10 16:43:59 +00:00
2023-02-03 23:52:40 +00:00
* A cluster peer application: `ipfs-cluster-service` , to be run along with `kubo` (`go-ipfs`) as a sidecar.
2018-04-26 10:02:39 +00:00
* A client CLI application: `ipfs-cluster-ctl` , which allows easily interacting with the peer's HTTP API.
2019-12-20 13:12:17 +00:00
* An additional "follower" peer application: `ipfs-cluster-follow` , focused on simplifying the process of configuring and running follower peers.
2016-10-10 16:43:59 +00:00
2018-07-24 15:14:01 +00:00
---
### Are you using IPFS Cluster?
Please participate in the [IPFS Cluster user registry ](https://docs.google.com/forms/d/e/1FAIpQLSdWF5aXNXrAK_sCyu1eVv2obTaKVO3Ac5dfgl2r5_IWcizGRg/viewform ).
---
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
2022-06-15 09:30:23 +00:00
Please visit https://ipfscluster.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
2022-06-15 09:30:23 +00:00
We regularly post project updates to https://ipfscluster.io/news/ .
2017-03-10 12:12:30 +00:00
2022-06-15 09:30:23 +00:00
The most up-to-date *Roadmap* is available at https://ipfscluster.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
2022-06-15 09:30:23 +00:00
Instructions for different installation methods (including from source) are available at https://ipfscluster.io/download .
2016-12-02 18:33:39 +00:00
## Usage
2022-06-15 09:30:23 +00:00
Extensive usage information is provided at https://ipfscluster.io/documentation/ , including:
2017-02-15 14:16:16 +00:00
2022-06-15 09:30:23 +00:00
* [Docs for `ipfs-cluster-service` ](https://ipfscluster.io/documentation/reference/service/ )
* [Docs for `ipfs-cluster-ctl` ](https://ipfscluster.io/documentation/reference/ctl/ )
* [Docs for `ipfs-cluster-follow` ](https://ipfscluster.io/documentation/reference/follow/ )
2017-02-15 14:16:16 +00:00
2016-12-02 18:33:39 +00:00
## Contribute
2022-06-15 09:30:23 +00:00
PRs accepted. As part of the IPFS project, we have some [contribution guidelines ](https://ipfscluster.io/support/#contribution-guidelines ).
2016-12-02 18:33:39 +00:00
## License
2019-03-01 20:12:19 +00:00
This library is dual-licensed under Apache 2.0 and MIT terms.
2022-06-15 09:19:17 +00:00
© 2022. Protocol Labs, Inc.