You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
10
10
11
+
<!-- markdown-link-check-disable -->
11
12
@[youtube](-SYDlid7Nqs)
13
+
<!-- markdown-link-check-enable-->
12
14
13
-
:::tip
14
-
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.
15
+
:::tip
16
+
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.
15
17
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,
16
18
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.
17
19
:::
18
20
19
21
## Create a local cluster
20
22
21
-
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. If you'd rather create a production-ready cluster, take a look at the [official IPFS Cluster documentation →](https://cluster.ipfs.io/)
23
+
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.
24
+
25
+
:::tip
26
+
If you'd rather create a production-ready cluster, take a look at the [official IPFS Cluster documentation →](https://cluster.ipfs.io/)
27
+
:::
22
28
23
29
### Prerequisites
24
30
25
-
You must have both [Docker](https://docs.docker.com/install/) and [Docker Compose](https://docs.docker.com/compose/install/) installed. Check that they're both installed properly by asking for their version:
31
+
You must have both [Docker](https://docs.docker.com/install/) and [Docker Compose](https://docs.docker.com/compose/install/) installed. Check that they're both installed properly by checking the version:
26
32
27
33
```shell
28
34
docker version
@@ -39,9 +45,9 @@ docker-compose version
39
45
> ...
40
46
```
41
47
42
-
If you're having issues here, head over to the [official Docker documentation to fix your problem →](https://docs.docker.com/)
48
+
If you're having issues installing or using Docker or Docker-Compose, see the [official documentation →](https://docs.docker.com/).
43
49
44
-
### Steps
50
+
### Procedure
45
51
46
52
1. Download the latest `ipfs-cluster-ctl` package from [dist.ipfs.tech](https://dist.ipfs.tech/#ipfs-cluster-ctl):
47
53
@@ -67,7 +73,11 @@ If you're having issues here, head over to the [official Docker documentation to
You can safely ignore these for now. They're showing because some of the IPFS nodes within the cluster haven't finished spinning up yet. Everything should have loaded after a couple of minutes:
100
+
You can safely ignore these errorsfor now. They're showing because some of the IPFS nodes within the cluster haven't finished spinning up yet. Everything should have loaded after a couple of minutes:
89
101
90
102
```shell
91
103
> ipfs1 | API server listening on /ip4/0.0.0.0/tcp/5001
92
104
> ipfs1 | WebUI: http://0.0.0.0:5001/webui
93
105
> ipfs1 | Gateway (readonly) server listening on /ip4/0.0.0.0/tcp/8080
94
106
> ipfs1 | Daemon is ready
95
107
```
108
+
:::
96
109
97
-
1. You can now interact with your cluster. In a new terminal, navigate to the `ipfs-cluster-ctl` directory and list the peers within the cluster:
110
+
1. Open a new terminal window.
111
+
112
+
1. You can now interact with your cluster. In a new terminal window, navigate to the `ipfs-cluster-ctl` directory.
113
+
114
+
1. List the peers within the cluster:
98
115
99
116
```shell
100
117
./ipfs-cluster-ctl peers ls
@@ -136,9 +153,13 @@ You can safely ignore these for now. They're showing because some of the IPFS no
0 commit comments