Skip to content

chore: cleanup outdated services and old links #2108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Aug 15, 2025
Merged
8 changes: 6 additions & 2 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,9 @@ module.exports = {
sidebarDepth: 1,
collapsable: false,
children: [
['/quickstart/retrieve','Retrieve with IPFS'],
['/quickstart/retrieve','Retrieve from IPFS'],
['/quickstart/pin','Pin with Browser'],
['/quickstart/pin-cli','Pin with Command Line'],
['/how-to/websites-on-ipfs/deploy-github-action', 'Deploy to IPFS with GitHub Actions' ],
]
},
Expand All @@ -123,7 +125,9 @@ module.exports = {
sidebarDepth: 1,
collapsable: false,
children: [
['/quickstart/retrieve','Retrieve with IPFS'],
['/quickstart/retrieve','Retrieve from IPFS'],
['/quickstart/pin','Pin with Browser'],
['/quickstart/pin-cli','Pin with Command Line'],
['/how-to/websites-on-ipfs/deploy-github-action', 'Deploy to IPFS with GitHub Actions' ],

]
Expand Down
2 changes: 2 additions & 0 deletions docs/.vuepress/redirects
Original file line number Diff line number Diff line change
Expand Up @@ -77,3 +77,5 @@
/reference/api/http/ /reference/http/api
/reference/go/overview/ /reference/go/api
/reference/js/overview/ /reference/js/api
/quickstart/publish /quickstart/pin
/quickstart/publish_cli /quickstart/pin-cli
2 changes: 1 addition & 1 deletion docs/concepts/cod.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@

IPVM uses [WebAssembly (Wasm)](https://webassembly.org/), content addressing, [simple public key infrastructure (SPKI)](https://en.wikipedia.org/wiki/Simple_public-key_infrastructure), and object capabilities to liberate computation from specific, prenegotiated services, such as large cloud computing providers. By default, execution scales flexibly on-device, all the way up to edge points-of-presence (PoPs) and data centers.

The core, Rust-based implementation and runtime of IPVM is the [Homestar project](https://github.com/ipvm-wg/homestar/). IPVM supports interoperability with [Bacalhau](https://bacalhau.org) and [Web3Storage](https://web3.storage/)
The core, Rust-based implementation and runtime of IPVM is the [Homestar project](https://github.com/ipvm-wg/homestar/). IPVM supports interoperability with [Bacalhau](https://bacalhau.org) and [Storacha (formerly web3.storage)](https://storacha.network/)

Check failure on line 42 in docs/concepts/cod.md

View workflow job for this annotation

GitHub Actions / pr-content-check

[vale] reported by reviewdog 🐶 [docs.PLNSpelling] Did you really mean 'Bacalhau'? Raw Output: {"message": "[docs.PLNSpelling] Did you really mean 'Bacalhau'?", "location": {"path": "docs/concepts/cod.md", "range": {"start": {"line": 42, "column": 159}}}, "severity": "ERROR"}

### More IPVM resources

Expand Down
2 changes: 1 addition & 1 deletion docs/concepts/persistence.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Some of the pinning services listed below are operated by third party companies.
- [NFT.Storage](https://nft.storage/)
- [Pinata](https://pinata.cloud/)
- [Scaleway](https://labs.scaleway.com/en/ipfs-pinning/)
- [Web3.Storage](https://web3.storage/)
- [Storacha (formerly web3.storage)](https://storacha.network/)

See how to [work with remote pinning services](../how-to/work-with-pinning-services.md).

Expand Down
4 changes: 2 additions & 2 deletions docs/how-to/gateway-best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Learn best practices for working with IPFS HTTP Gateways

# Best practices for HTTP Gateways

Various best practices for the use of IPFS gateways are listed below. To learn more about the concepts behind IPFS gateways, including how they work, available providers, types and FAQs, see [IPFS Gateway](../concepts/ipfs-gateway.md). For troubleshooting information, see [Troubleshooting](./gateway-troubleshooting.md).
Various best practices for the use of IPFS gateways are listed below. To learn more about the concepts behind IPFS gateways, including how they work, available providers, types and FAQs, see [IPFS Gateway](../concepts/ipfs-gateway.md). For troubleshooting information, see [Troubleshooting](./troubleshooting.md).

## Selecting a gateway type to use

Expand Down Expand Up @@ -33,7 +33,7 @@ If you are running an IPFS node that is also configured as an IPFS gateway, each
- If your node is not reachable because you are behind NAT, see the [NAT configuration](https://docs.ipfs.tech/how-to/nat-configuration/#ipv6) docs.
- Ensure that you are correctly returning HTTP cache headers to the client if the IPFS gateway node is behind a reverse proxy. Pay extra attention to `Etag`, `Cache-Control`, and `Last-Modified headers`. Consider leveraging the list of CIDs in `X-Ipfs-Roots` for smarter HTTP caching strategies.
- Put a CDN like Cloudflare in front of the IPFS gateway.
- Consider enabling the [Accelerated DHT Client](https://github.com/ipfs/go-ipfs/blob/master/docs/experimental-features.md#accelerated-dht-client).
- Consider enabling the [Accelerated DHT Client](https://github.com/ipfs/kubo/blob/master/docs/config.md#routingaccelerateddhtclient).
- Test and monitor your internet connection speed, with a tool like [Speedtest CLI](https://www.speedtest.net/apps/cli).
- Monitor disk I/O and make sure that no other processes are causing disk I/O bottlenecks with a tool like [iotop](https://github.com/Tomas-M/iotop) or [iostat](https://github.com/sysstat/sysstat).

Expand Down
2 changes: 1 addition & 1 deletion docs/how-to/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ With this in mind, if no providers are returned, do the following:

2. Note the value for `LastReprovideDuration`. If it is close to 48 hours, or if you notice a "reprovide taking too long" warning in your `ipfs daemon` output log, select one of the following options, keeping in mind that each has tradeoffs:

- **Enable the [Accelerated DHT Client](https://github.com/ipfs/go-ipfs/blob/master/docs/experimental-features.md#accelerated-dht-client) in Kubo**. This configuration improves content providing times significantly by maintaining more connections to peers and a larger routing table and batching advertising of provider records. However, this performance boost comes at the cost of increased resource consumption, most notably network connections to other peers, and can lead to degraded network performance in home networks.
- **Enable the [Accelerated DHT Client](https://github.com/ipfs/kubo/blob/master/docs/config.md#routingaccelerateddhtclient) in Kubo**. This configuration improves content providing times significantly by maintaining more connections to peers and a larger routing table and batching advertising of provider records. However, this performance boost comes at the cost of increased resource consumption, most notably network connections to other peers, and can lead to degraded network performance in home networks.

- **Change the [Reprovider Strategy](https://github.com/ipfs/kubo/blob/master/docs/config.md#reproviderstrategy) from `all` to either `pinned+mfs` or `roots`.** In both cases, only provider records for explicitly pinned content are advertised. Differences and tradeoffs are noted below:
- The `pinned+mfs` strategy will advertise both the root CIDs and child block CIDs (the entire DAG) of explicitly pinned content and the locally available part of MFS.
Expand Down
6 changes: 5 additions & 1 deletion docs/install/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ Anyone can use IPFS to store files in a _decentralized_ way. The easiest way to

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)

### Pin files with a pinning service

Do you want to quickly and easily publish content with IPFS without complex tools? See the [Pin with IPFS quickstart](../quickstart/pin.md), where you'll learn how to use third-party pinning services to pin and provide files to the IPFS network.

### Deploy static sites to the IPFS network with a GitHub Action

Do you want to quickly and easily automate the deployment of static websites to the IPFS network? See the [Deploy static sites to the IPFS network with GitHub Actions](../how-to/websites-on-ipfs/deploy-github-action.md), where you'll learn how to use [GitHub Actions](https://github.com/ipshipyard/ipfs-deploy-action) to automatically deploy static websites to the IPFS network.
Expand Down Expand Up @@ -53,7 +57,7 @@ To get started with a hands-on example, see [Helia 101](https://github.com/ipfs-
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).
:::

### Boxo SDK for GO
### Boxo SDK for Go

[Boxo](https://github.com/ipfs/boxo#readme) is a set of reference libraries for building IPFS applications and implementations in Go.

Expand Down
2 changes: 1 addition & 1 deletion docs/install/command-line.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ This reduces daemon overhead on the system but may degrade content discovery and
This section describes how to download and install the Kubo binary from `dist.ipfs.tech` on Windows, MacOS, Linux, FreeBSD and OpenBSD operating systems. The IPFS team publishes the latest, official prebuilt Kubo binaries on the [dist.ipfs.tech website](https://dist.ipfs.tech#kubo). New IPFS Kubo binary releases are automatically shown on the Kubo page on `dist.ipfs.tech`.

:::callout
If you are unable to access [dist.ipfs.tech](https://dist.ipfs.tech#kubo), you can also download Kubo (go-ipfs) from the project's GitHub [releases](https://github.com/ipfs/kubo/releases/latest) page or `/ipns/dist.ipfs.tech` at the [dweb.link](https://dweb.link/ipns/dist.ipfs.tech#kubo) gateway.
If you are unable to access [dist.ipfs.tech](https://dist.ipfs.tech#kubo), you can also download Kubo from the project's GitHub [releases](https://github.com/ipfs/kubo/releases/latest) page or `/ipns/dist.ipfs.tech` at the [dweb.link](https://dweb.link/ipns/dist.ipfs.tech#kubo) gateway.
:::

For installation instructions for your operating system, select the appropriate tab.
Expand Down
10 changes: 5 additions & 5 deletions docs/install/server-infrastructure.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ current-ipfs-cluster-version: v1.1.4

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.

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

:::tip
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.
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,
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,
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.
:::

## Features
## Features

IPFS Cluster has the following features:

Expand Down Expand Up @@ -109,7 +109,7 @@ If you're having issues installing or using Docker or Docker-Compose, see the [o
> Recreating cluster2 ... done
> ...
```

:::warning

Errors such as the following may display:
Expand All @@ -131,7 +131,7 @@ If you're having issues installing or using Docker or Docker-Compose, see the [o
1. Open a new terminal window.

1. You can now interact with your cluster. In a new terminal window, navigate to the `ipfs-cluster-ctl` directory.

1. List the peers within the cluster:

```shell
Expand Down
Binary file removed docs/quickstart/images/account-console.png
Binary file not shown.
Binary file removed docs/quickstart/images/login-web3-storage.png
Binary file not shown.
Binary file removed docs/quickstart/images/web3-file-after-upload.png
Binary file not shown.
Binary file removed docs/quickstart/images/web3-file-uploaded.png
Binary file not shown.
Binary file removed docs/quickstart/images/web3-upload-button.png
Binary file not shown.
Binary file removed docs/quickstart/images/web3-upload-tab.png
Binary file not shown.
Loading
Loading