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
Copy file name to clipboardExpand all lines: docs/how-to/gateway-troubleshooting.md
+28-21Lines changed: 28 additions & 21 deletions
Original file line number
Diff line number
Diff line change
@@ -26,29 +26,35 @@ When troubleshooting IPFS gateways, ensure that you are familiar with [how gatew
26
26
27
27
To further narrow down the root cause, use one of the following methods:
28
28
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).
30
30
- If you are running an IPFS Kubo node, you can [manually debug using kubo and IPFS check](#debug-manually).
31
31
32
-
## Debug with pl-diagnose
32
+
## Debug with IPFS Check
33
33
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:
35
35
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?
40
40
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.
42
42
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
46
44
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:
51
46
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)
52
58
53
59
## Debug manually
54
60
@@ -62,13 +68,14 @@ This procedure assumes that you have the latest version of kubo installed. To de
62
68
ipfs routing findprovs <CID>
63
69
```
64
70
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:
0 commit comments