73 lines
3.2 KiB
Markdown
73 lines
3.2 KiB
Markdown
# IPFS Cluster
|
|
|
|
[](https://protocol.ai)
|
|
[](http://github.com/ipfs-cluster)
|
|
[](https://discuss.ipfs.io/c/help/help-ipfs-cluster/24)
|
|
[](https://app.element.io/#/room/#ipfs-cluster:ipfs.io)
|
|
[](https://pkg.go.dev/github.com/ipfs-cluster/ipfs-cluster)
|
|
[](https://goreportcard.com/report/github.com/ipfs-cluster/ipfs-cluster)
|
|
[](https://codecov.io/gh/ipfs-cluster/ipfs-cluster)
|
|
|
|
> Pinset orchestration for IPFS
|
|
|
|
<p align="center">
|
|
<img src="https://ipfscluster.io/cluster/png/IPFS_Cluster_color_no_text.png" alt="logo" width="300" height="300" />
|
|
</p>
|
|
|
|
[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.
|
|
|
|
There are 3 different applications:
|
|
|
|
* A cluster peer application: `ipfs-cluster-service`, to be run along with `go-ipfs` as a sidecar.
|
|
* A client CLI application: `ipfs-cluster-ctl`, which allows easily interacting with the peer's HTTP API.
|
|
* An additional "follower" peer application: `ipfs-cluster-follow`, focused on simplifying the process of configuring and running follower peers.
|
|
|
|
---
|
|
|
|
### Are you using IPFS Cluster?
|
|
|
|
Please participate in the [IPFS Cluster user registry](https://docs.google.com/forms/d/e/1FAIpQLSdWF5aXNXrAK_sCyu1eVv2obTaKVO3Ac5dfgl2r5_IWcizGRg/viewform).
|
|
|
|
---
|
|
|
|
## Table of Contents
|
|
|
|
- [Documentation](#documentation)
|
|
- [News & Roadmap](#news--roadmap)
|
|
- [Install](#install)
|
|
- [Usage](#usage)
|
|
- [Contribute](#contribute)
|
|
- [License](#license)
|
|
|
|
|
|
## Documentation
|
|
|
|
Please visit https://ipfscluster.io/documentation/ to access user documentation, guides and any other resources, including detailed **download** and **usage** instructions.
|
|
|
|
## News & Roadmap
|
|
|
|
We regularly post project updates to https://ipfscluster.io/news/ .
|
|
|
|
The most up-to-date *Roadmap* is available at https://ipfscluster.io/roadmap/ .
|
|
|
|
## Install
|
|
|
|
Instructions for different installation methods (including from source) are available at https://ipfscluster.io/download .
|
|
|
|
## Usage
|
|
|
|
Extensive usage information is provided at https://ipfscluster.io/documentation/ , including:
|
|
|
|
* [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/)
|
|
|
|
## Contribute
|
|
|
|
PRs accepted. As part of the IPFS project, we have some [contribution guidelines](https://ipfscluster.io/support/#contribution-guidelines).
|
|
|
|
## License
|
|
|
|
This library is dual-licensed under Apache 2.0 and MIT terms.
|
|
|
|
© 2022. Protocol Labs, Inc.
|