Skip to content

Commit 725e5cf

Browse files
committed
feat: revamped /install landing
Wanted to add Rainbow and Someguy to /install page, but realized the page was not very intuitive, so I've separated it into three sections: 1. User-Friendly Options 2. Command-Line & Infrastructure Tools 3. Software Development Updated some links and applied minor fixes along the way.
1 parent 0266af7 commit 725e5cf

File tree

4 files changed

+59
-26
lines changed

4 files changed

+59
-26
lines changed

docs/.vuepress/config.js

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,16 @@ const SPEEDCURVE_ID = process.env.SPEEDCURVE_ID || ''
55
const pageSuffix = '/'
66

77
const installMenuChildren = [
8-
['/install/command-line','IPFS Kubo for Go'],
9-
['/install/run-ipfs-inside-docker', 'IPFS Kubo in Docker'],
10-
['https://github.com/ipfs/helia','IPFS Helia for JavaScript'],
11-
['https://iroh.computer/docs/install/', "IPFS Iroh for Rust"],
128
['/install/ipfs-desktop', 'IPFS Desktop App'],
139
['/install/ipfs-companion', 'IPFS Companion Browser Extension'],
14-
['/install/server-infrastructure', 'IPFS Cluster']
10+
['/install/command-line','Kubo Daemon & CLI'],
11+
['/install/run-ipfs-inside-docker', 'Kubo in Docker'],
12+
['/install/server-infrastructure', 'IPFS Cluster'],
13+
['https://github.com/ipfs/rainbow#readme', 'Rainbow Gateway'],
14+
['https://github.com/ipfs/someguy#readme', 'Someguy Delegated Router'],
15+
['https://github.com/ipfs/helia#readme','Helia SDK for JS'],
16+
['https://github.com/ipfs/boxo#readme','Boxo SDK for Go'],
17+
['/concepts/ipfs-implementations','Other Implementations']
1518
]
1619

1720
module.exports = {

docs/concepts/ipfs-implementations.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,20 @@ IPFS is an open-source project that encourages the development of multiple imple
99

1010
You can learn more about the principles that define what an IPFS implementation is [here](./implementations.md).
1111

12-
::: callout TLDR
13-
Looking for an easy, user-friendly way to get started with IPFS?
14-
Try any of the options listed below:
1512

16-
- [IPFS Desktop](../install/ipfs-desktop.md), an user-friendly GUI application that bundles an IPFS Kubo node, file manager, peer manager, and content explorer.
17-
- [IPFS Companion](../install/ipfs-companion.md), a browser extension that compliments IPFS Desktop, loads compatible websites and file paths from a local IPFS Kubo node.
18-
- [IPFS Kubo](../install/command-line.md), standalone demon service with command-line and HTTP RPC interface for power users who don't need GUI.
19-
:::
13+
::: callout Mainnet TLDR
14+
15+
Looking for an easy and opinionated way to get started with IPFS [Mainnet](../concepts/glossary.md#mainnet)?
16+
17+
**User-Friendly Options**
18+
- [IPFS Desktop](../install/ipfs-desktop.md), an user-friendly GUI application that bundles an IPFS Kubo node for self-hosting, file manager, peer manager, and content explorer.
19+
- [IPFS Companion](../install/ipfs-companion.md), a browser extension that compliments IPFS Desktop, loads compatible websites and file paths from a local IPFS Kubo node.
20+
21+
**Command-Line & Infrastructure Tools**
22+
- [Kubo](../install/command-line.md), all-in-one demon service with command-line and HTTP RPC interface for power users who want to self-host, but don't need GUI.
23+
- [IPFS Cluster](../install/server-infrastructure.md), data orchestration across a swarm of IPFS daemons by allocating, replicating and tracking a global pinset distributed among multiple peers.
24+
- [Rainbow](https://github.com/ipfs/rainbow/#readme), production-grade standalone IPFS HTTP [Gateway](../concepts/glossary.md#gateway) service powering [public gateways](../concepts/public-utilities/#public-ipfs-gateways).
25+
:::
2026

2127
## Popular or Actively Maintained
2228

docs/install/README.md

Lines changed: 35 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,30 +7,54 @@ description: There are several different ways you can install and interact with
77

88
IPFS is a collection of protocols, packages, and specifications that allow computers to send and receive data. Because of this, users can interact with and use IPFS in many different ways. A developer building network applications will use a different set of tools to interact with IPFS than someone who wants to store files on IPFS. Pick the one that best suits what you're here to do.
99

10-
## Publish files with a pinning service
10+
Looking for an easy and opinionated way to get started with IPFS [Mainnet](../concepts/glossary.md#mainnet)? Try any of the options listed below:
1111

12-
Do you want to quickly and easily publish content with IPFS without complex tools? See the [Publish with IPFS quickstart](../quickstart/publish.md), where you'll learn how to use pinning services to pin files to the IPFS network.
12+
## User-Friendly Options
1313

14-
## IPFS Desktop
14+
### IPFS Desktop
1515

1616
Anyone can use IPFS to store files in a _decentralized_ way. The easiest way to get up and running is by installing the IPFS Desktop application. This app has Kubo built-in and lets you interact with the network through a simple user-interface. [Check it out →](./ipfs-desktop.md)
1717

18-
## IPFS Kubo Node and CLI
18+
### IPFS Companion
1919

20-
Want to build decentralized applications and store your application data on IPFS? You'll likely want to install the command-line version of IPFS. There's no GUI to deal with, just raw input and output through your terminal. [Find out more →](./command-line.md)
20+
If your browser doesn't support IPFS yet, you can install an IPFS companion extension that will let you view decentralized web content! [Learn more →](./ipfs-companion.md)
21+
22+
### Publish files with a pinning service
23+
24+
Do you want to quickly and easily publish content with IPFS without complex tools? See the [Publish with IPFS quickstart](../quickstart/publish.md), where you'll learn how to use third-party pinning services to pin and provide files to the IPFS network.
25+
26+
## Command-Line & Infrastructure Tools
27+
28+
### Kubo
29+
30+
Want to build decentralized applications and store your application data on IPFS? You'll likely want to install the command-line version of IPFS named Kubo. There's no GUI to deal with, just raw input and output through your terminal. [Find out more →](./command-line.md)
31+
32+
### IPFS Cluster
33+
34+
Planning to set up several Kubo nodes within one network? You'll want to take a look at installing [IPFS Cluster](./server-infrastructure.md), which provides data orchestration across a swarm of IPFS daemons by allocating, replicating and tracking a global pinset distributed among multiple peers.
2135

22-
## IPFS Helia for JS
36+
### Rainbow
37+
38+
If you only want to run production-grade HTTP [Gateway](../concepts/glossary.md#gateway) service using the same software that is powering [public gateways](../concepts/public-utilities/#public-ipfs-gateways), you may want to choose [Rainbow →](https://github.com/ipfs/rainbow/#readme).
39+
40+
### Someguy
41+
42+
If you need to run your own [delegated routing](../concepts/glossary.md#delegated-routing) endpoint that hits both Amino DHT and IPNI, consider running [Someguy →](https://github.com/ipfs/someguy/#readme).
43+
44+
## Software Development
45+
46+
### Helia SDK for JS
2347

2448
[Helia](https://github.com/ipfs/helia) is a new implementation of IPFS in JavaScript that is designed to be more modular and lightweight than the [deprecated js-ipfs project](https://github.com/ipfs/js-ipfs).
2549

2650
To get started with a hands-on example, see [Helia 101](https://github.com/ipfs-examples/helia-examples/blob/main/examples/helia-101/README.md) in [ipfs-examples/helia-examples](https://github.com/ipfs-examples/helia-examples/tree/main).
2751

52+
:::callout
2853
If you are looking for simple [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API)-like API for use on the web, see [@helia/verified-fetch](https://www.npmjs.com/package/@helia/verified-fetch).
54+
:::
2955

30-
## IPFS Cluster
31-
32-
Planning to set up several Kubo nodes within one network? You'll want to take a look at installing [IPFS Cluster →](./server-infrastructure.md)
56+
### Boxo SDK for GO
3357

34-
## IPFS Companion Browser Extension
58+
[Boxo](https://github.com/ipfs/boxo#readme) is a set of reference libraries for building IPFS applications and implementations in Go.
3559

36-
If your browser doesn't support IPFS yet, you can install an IPFS companion extension that will let you view decentralized web content! [Learn more →](./ipfs-companion.md)
60+
To get started, see [boxo/examples](https://github.com/ipfs/boxo/tree/main/examples) or inspect how Boxo is used in [Kubo](https://github.com/ipfs/kubo), [Rainbow](https://github.com/ipfs/rainbow/), [Someguy](https://github.com/ipfs/someguy), [IPFS Cluster](https://github.com/ipfs-cluster/ipfs-cluster/), or non-Mainnet implementations like [Lotus](https://github.com/filecoin-project/lotus/).

docs/install/server-infrastructure.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ current-ipfs-cluster-version: v1.1.1
66

77
# Set up server infrastructure with IPFS Cluster
88

9-
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.
9+
If you want to install IPFS in a server environment and offer IPFS as a service, you should look at [IPFS Cluster](https://ipfscluster.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

1111
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/).
1212

@@ -44,7 +44,7 @@ _No central server to manage:_ Cluster peers form a distributed network and main
4444
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.
4545

4646
:::tip
47-
If you'd rather create a production-ready cluster, take a look at the [official IPFS Cluster documentation →](https://cluster.ipfs.io/)
47+
If you'd rather create a production-ready cluster, take a look at the [official IPFS Cluster documentation →](https://ipfscluster.io/)
4848
:::
4949

5050
### Prerequisites
@@ -207,4 +207,4 @@ If you're having issues installing or using Docker or Docker-Compose, see the [o
207207
208208
## Next steps
209209
210-
If you want to delve deeper into IPFS Cluster, check out the project's documentation at [cluster.ipfs.io →](https://cluster.ipfs.io/)
210+
If you want to delve deeper into IPFS Cluster, check out the project's documentation at [ipfscluster.io →](https://ipfscluster.io/)

0 commit comments

Comments
 (0)