https://github.com/ipfs-cluster/ipfs-cluster

Pinset orchestration for IPFS
https://github.com/ipfs-cluster/ipfs-cluster

ipfs ipfs-cluster libp2p

Last synced: 11 days ago
JSON representation

Pinset orchestration for IPFS

• Host: GitHub
• URL: https://github.com/ipfs-cluster/ipfs-cluster
• Owner: ipfs-cluster
• License: other
• Created: 2016-07-01T18:41:15.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2025-04-16T23:27:04.000Z (18 days ago)
• Last Synced: 2025-04-23T06:59:19.305Z (11 days ago)
• Topics: ipfs, ipfs-cluster, libp2p
• Language: Go
• Homepage: https://ipfscluster.io
• Size: 13.3 MB
• Stars: 1,507
• Watchers: 92
• Forks: 296
• Open Issues: 122
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome - ipfs-cluster/ipfs-cluster - Pinset orchestration for IPFS (Go)
• awesome-starred - ipfs-cluster/ipfs-cluster - Pinset orchestration for IPFS (ipfs)

README

        
# IPFS Cluster

[![Made by](https://img.shields.io/badge/By-IP%20Shipyard-000000.svg?style=flat-square)](https://ipshipyard.com)

[![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)

[![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)

> Pinset orchestration for IPFS







[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 `kubo` (`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.

---

## 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.