Skip to content

Commit 42e1ded

Browse files
authored
Update server install copy with features
2 parents ef56dee + 77ffedb commit 42e1ded

File tree

1 file changed

+24
-3
lines changed

1 file changed

+24
-3
lines changed

docs/install/server-infrastructure.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,37 @@ current-ipfs-cluster-version: v1.0.4
88

99
If you want to install IPFS in a server environment and offer IPFS as a service, you should look at [IPFS Cluster](https://cluster.ipfs.io/) as a way to scale your IPFS deployment beyond a single IPFS daemon. IPFS Cluster provides data orchestration across a swarm of IPFS daemons by allocating, replicating, and tracking a global pin-set distributed among multiple peers. This makes it significantly easier to manage multiple IPFS nodes and ensure that data is available across an internal network.
1010

11-
<!-- markdown-link-check-disable -->
12-
@[youtube](-SYDlid7Nqs)
13-
<!-- markdown-link-check-enable-->
11+
IPFS Cluster is a distributed application that works as a sidecar to IPFS peers, maintaining a global cluster pinset and intelligently allocating its items to the IPFS peers. This makes it significantly easier to manage multiple IPFS nodes and ensure that data is available across an internal network. IPFS Cluster powers large IPFS storage services like [nft.storage](https://nft.storage/) and [web3.storage](https://web3.storage/).
1412

1513
:::tip
1614
As a Kubernetes user, you can use a Kubernetes operator for IPFS called [IPFS operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) to easily create and manage clusters consisting of hundreds of peers.
1715
The IPFS operator is in active development and not yet recommended for production use cases. If the operator is something you would like to include in your infrastructure,
1816
check out the [official documentation](https://ipfs-operator.readthedocs.io/) and [operator source code](https://github.com/redhat-et/ipfs-operator) for instructions and the latest progress.
1917
:::
2018

19+
## Features
20+
21+
IPFS Cluster has the following features:
22+
23+
- _Easy to run_: Runs independently from IPFS and the IPFS daemon’s API.
24+
- _Handles replication of millions of pins to hundreds of IPFS daemons:_ Tracks pin lifetime asynchronously, asks IPFS to pin things at a sustainable rate and retries pinning in case of failures.
25+
- _Clever pinning prioritization:_ New pins are prioritized over pin requests that are old or have repeatedly failed to pin.
26+
- _Ingest pins at scale:_ Pins can be added at a rate hundreds of pins per second into the cluster from that moment they are tracked and managed by the cluster peers.
27+
- _Balanced allocation:_ Distributes pins evenly among peers in different groups and subgroups (i.e regions, availability zones), ultimately choosing those with most free storage space available.
28+
- _API and CLI_: Provides a command-line client and a fully featured Cluster HTTP REST API.
29+
_No central server to manage:_ Cluster peers form a distributed network and maintain a global, replicated, conflict-free list of pins.
30+
- _Baked-in permissions:_ The embedded permission model supports peers with permissions to change the cluster pinset and peers which store content as instructed but that cannot modify the pinset.
31+
- _Name your pins:_ Supports custom replication factors, names and metadata for every pin.
32+
- _Multi-peer add:_ Ingests IPFS content to multiple daemons directly.
33+
- _CAR import support:_ Directly imports CAR-archived content using custom DAGs.
34+
- _IPFS proxy API:_ Cluster peers provide an additional IPFS proxy API that behaves exactly like the IPFS daemon’s API does.
35+
- _Integration-ready:_ Cluster peers can be programmatically launched and controlled using Go and Javascript clients for its API.
36+
- _Powered by [libp2p](https://libp2p.io/):_ Built on libp2p, the battle-tested, next-generation p2p networking library used by IPFS, Filecoin and Ethereum V2.
37+
38+
<!-- markdown-link-check-disable -->
39+
@[youtube](-SYDlid7Nqs)
40+
<!-- markdown-link-check-enable-->
41+
2142
## Create a local cluster
2243

2344
To see if IPFS Cluster is suitable for your project, follow this quick start guide and spin up a local IPFS Cluster instance. At the end of this guide, you will have a solid understanding of how IPFS Cluster is set up and how to interact with it. To create a local cluster, complete the prerequisites. Then, follow the procedure.

0 commit comments

Comments
 (0)