IPFS Cluster

Pinset orchestration for IPFS.

IPFS Cluster is a stand-alone application and a CLI client that allocates, replicates, and tracks pins across a cluster of IPFS daemons.

It provides:

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

Are you using IPFS Cluster?

Please participate in the IPFS Cluster user registry.

Table of Contents

• Documentation
• News & Roadmap
• Install
• Usage
• Contribute
• License

Documentation

Please visit https://cluster.ipfs.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://cluster.ipfs.io/news/ .

The most up-to-date Roadmap is available at https://cluster.ipfs.io/roadmap/ .

Install

Instructions for different installation methods (including from source) are available at https://cluster.ipfs.io/download .

Usage

Extensive usage information is provided at https://cluster.ipfs.io/documentation/ , including:

• Docs for ipfs-cluster-service
• Docs for ipfs-cluster-ctl

Contribute

PRs accepted. As part of the IPFS project, we have some contribution guidelines.

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

License

This library is dual-licensed under Apache 2.0 and MIT terms.

© 2019. Protocol Labs, Inc.