Skip to content

Commit f9e7a19

Browse files
committed
fix: use IPFS Check for troubleshooting
remove pl-diagnose which isn't maintained and operated
1 parent 4554f6f commit f9e7a19

File tree

1 file changed

+28
-21
lines changed

1 file changed

+28
-21
lines changed

docs/how-to/gateway-troubleshooting.md

Lines changed: 28 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -26,29 +26,35 @@ When troubleshooting IPFS gateways, ensure that you are familiar with [how gatew
2626

2727
To further narrow down the root cause, use one of the following methods:
2828

29-
- If you want an automated, browser based tool that does the majority of the diagnosing and debugging for you, use [pl-diagnose](#debug-with-pl-diagnose).
29+
- If you want an automated, browser based tool that does the majority of the diagnosing and debugging for you, use [IPFS Check](#debug-with-ipfs-check).
3030
- If you are running an IPFS Kubo node, you can [manually debug using kubo and IPFS check](#debug-manually).
3131

32-
## Debug with pl-diagnose
32+
## Debug with IPFS Check
3333

34-
The pl-diagnose tool is a browser-based software application that automates a large part of the process described in [Debug manually](#debug-manually). Specifically, this tool can help you answer these questions:
34+
The IPFS Check tool is a browser-based software application that automates a large part of the process described in [Debug manually](#debug-manually). Specifically, IPFS Check can help you answer these questions:
3535

36-
- Is a given piece of content, identified with a with a certain CID available on the IPFS network, and which peers does the DHT list as hosts for that content?
37-
- Which addresses are listed in the DHT for a given IPFS node?
38-
- Is an IPFS node accessible by other peers?
39-
- Is specific content available from an IPFS node?
36+
1. Is a given CID routable on IPFS Mainnet, in other words, is the CID announced to the DHT or the IPNI?
37+
2. Is the data for the CID retrievable from the providers that are announcing it?
38+
3. What multiaddresses and network transports are used to connect to successful providers for a CID?
39+
4. Was NAT hole punching necessary to retrieve the data?
4040

41-
To use the tool, do the following:
41+
IPFS Check provides an _outside perspective_ of IPFS node's network setup, and whether they are correctly configured.
4242

43-
1. Navigate to the [application page](https://pl-diagnose.on.fleek.co/#/diagnose/access-content).
44-
1. In the **Backend URL** field, enter the address of the node you are trying to check.
45-
1. In the menu, select from one of the options depending on your specific needs:
43+
### How to use IPFS Check
4644

47-
- **Is my content on the DHT?** - Given a CID on the node you are checking, determine if is listed in the DHT.
48-
- **Is my peer in the DHT?** - Given a public network address of a node, determine if the node is listed in the DHT.
49-
- **Is my node accessible by other peers?** - Given a public network address of a node, determine if that node is reachable by peers.
50-
- **Is my node serving the content?** - Determine if the node is actually serving the content.
45+
IPFS Check supports two modes of operation:
5146

47+
1. **CID-only checks**: you can check whether a CID is available from _any_ provider, without needing to pass a specific provider's multiaddr. In this mode, IPFS Check will search for providers both in the IPNI and the DHT.
48+
2. **Multiaddr-based checks**: you can check whether a CID is available from a specific provider, by passing the provider's multiaddr.
49+
50+
To use IPFS Check, do the following:
51+
52+
1. Navigate to the [IPFS Check](https://check.ipfs.network/) tool.
53+
2. In the **CID** field, enter the CID you are trying to check
54+
3. (Optional) In the **Multiaddr field**, enter the multiaddress of the IPFS node you are trying to check.
55+
56+
57+
@[youtube](XeNOQDOrdC0)
5258

5359
## Debug manually
5460

@@ -62,13 +68,14 @@ This procedure assumes that you have the latest version of kubo installed. To de
6268
ipfs routing findprovs <CID>
6369
```
6470

65-
**If providers are found in DHT**, their Peer IDs are returned. Example output:
71+
**If providers are found**, their Peer IDs are returned. Example output:
6672

6773
```
68-
12D3KooWChhhfGdB9GJy1GbhghAAKCUR99oCymMEVS4eUcEy67nt
69-
12D3KooWJkNYFckQGPdBF57kVCLdkqZb1ZmZXAphe9MZkSh16UfP
70-
QmQzqxhK82kAmKvARFZSkUVS6fo9sySaiogAnx5EnZ6ZmC
71-
12D3KooWSH5uLrYe7XSFpmnQj1NCsoiGeKSRCV7T5xijpX2Po2aT
74+
12D3KooWSvjCTS6w6f6nyJQ615p4ipiW3L7BTbt9XvpR6Kxi385m
75+
12D3KooWDCNa4MmDPHr3916gpk2PcQJbJXyKxfByTL6UBmSwBM2H
76+
12D3KooWDEYGGZAH4v1Hu75nqyF4vnN8UyfgCCwerTD98F1Z8Q1z
77+
12D3KooWHr9MZJVKwe7tZyD6Z8uRcZFQ7XUqhM2nQvpeQxDyAN4E
78+
12D3KooWGLyBGRMdNQe5KnkeT2g3QYp7uM71tpn77somfRHaWmmS
7279
```
7380

7481
In this case, complete the steps described in [Providers returned](#providers-returned).
@@ -139,5 +146,5 @@ With this in mind, if no providers are returned, do the following:
139146
3. Manually trigger a reprovide run:
140147

141148
```shell
142-
ipfs bitswap reprovide
149+
ipfs routing reprovide
143150
```

0 commit comments

Comments
 (0)