Overview

Welcome to the IPFS Cluster Guide! Whether you’re just looking to use IPFS for production systems, want to dive into how to manage multiple IPFS nodes, or are looking for ready-to-use examples, this is the place to start.

Getting Started

If you are looking for a getting started on IPFS Cluster, this is the place to start.

• Installing IPFS Cluster
• Play with IPFS Cluster
• Explore more

Deep Dive

Learn Why do we need IPFS Cluster, What is it and How it works. We will go through the different use-cases and examples of IPFS Cluster.

• Architecture overview
• Consensus components
• Adding and Pinning data
• Security and Ports
• Data, backups and recovery
• Peerset management
• Cluster metrics
• Upgrades
• Troubleshooting
• Tracing and Monitoring
• Deployment on Kubernetes

Collaborative Clusters

• Hosting a collaborative cluster
• Joining a collaborative cluster

Reference

• Configuration
• REST API
• IPFS Proxy
• ipfs-cluster-ctl
• ipfs-cluster-follow
• ipfs-cluster-service

Using IPFS Cluster with JS

• Using Cluster with Javascript

IPFS Cluster for Production Systems

Learn How to use IPFS Cluster for Production Systems.

• Download and setup
• Bootstrapping the Cluster
• Deployment automations

Interesting Examples

Some Cool Applications made using IPFS Cluster.

• Building a Twitter Bot using IPFS Cluster 🤖
• Ansible roles for IPFS and IPFS Cluster
• Peer Base Pinner
• Smart Contract Based IPFS Storage for DAOs

App Store

Explore apps, tools and projects built by the IPFS Cluster Community.

Build software better, together

GitHub is where people build software. More than 40 million people use GitHub to discover, fork, and contribute to over 100 million projects.

GitHub