Skip to content

Commit 3a83bac

Browse files
authored
Adds reference page on diagnostic tools (ipfs#1532)
1 parent 68da24c commit 3a83bac

File tree

2 files changed

+62
-0
lines changed

2 files changed

+62
-0
lines changed

docs/.vuepress/config.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -251,6 +251,7 @@ module.exports = {
251251
}
252252
],
253253
'/reference/': [
254+
'/reference/diagnostic-tools',
254255
'/reference/http/gateway',
255256
'/reference/js/api',
256257
'/reference/go/api',

docs/reference/diagnostic-tools.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
title: Diagnostic tools
3+
description: Diagnostic tools to assist with debugging, troubleshooting, and developing with IPFS.
4+
---
5+
6+
# Diagnostic tools
7+
8+
The IPFS ecosystem contains various open-source tools for the investigation, diagnosis and troubleshooting of common issues that occur when using an IPFS implementation or tool. Tools along with a summary of functionality are listed below.
9+
10+
## IPLD Explorer
11+
12+
[IPLD Explorer](https://explore.ipld.io/) allows you to visualize and explore the IPLD DAG representing a given CID or CAR file. The tool provides the following featured datasets to explore:
13+
14+
- [Project Apollo archives](https://explore.ipld.io/#/explore/QmSnuWmxptJZdLJpKRarxBMS2Ju2oANVrgbr2xWbie9b2D)
15+
- [IGIS Git repository](https://explore.ipld.io/#/explore/baf4bcfg4ep767tjp5lxyanx5urpjjgx5q2volvy)
16+
- [An Ethereum block](https://explore.ipld.io/#/explore/bagiacgzah24drzou2jlkixpblbgbg6nxfrasoklzttzoht5hixhxz3rlncyq)
17+
- [XKCD archives](https://explore.ipld.io/#/explore/QmdmQXB2mzChmMeKY47C43LxUdg1NDJ5MWcKMKxDu7RgQm)
18+
19+
## IPFS check
20+
21+
[IPFS check](https://check.ipfs.network/) determines the retrievability of a given CID from an IPFS node given its multiaddress. Each error type output by the tool can indicate a solution to your problem:
22+
23+
- **Could not connect to the multiaddr** indicates that machines on the internet cannot talk to your machine. Fix your firewall, add port forwarding, or use a relay.
24+
- **Could not find address in the dht** indicates that your machine is either not connected to the IPFS Public DHT (even as a client), or it is not advertising the address that you are using to test.
25+
- **Multihash not advertised in the dht** indicates that your machine has not advertised that it has the requested content in the IPFS Public DHT. If you're using kubo, enable the [Accelerated DHT Client](https://github.com/ipfs/go-ipfs/blob/master/docs/experimental-features.md#accelerated-dht-client).
26+
- **Peer has not responded that it has the CID** indicates that your node cannot find the data that you believe it has, or that there may be some other sort of network latency.
27+
28+
## CID inspector
29+
30+
[CID inspector](http://cid.ipfs.tech/) breaks down a given CID into information that can be useful for understanding CIDs. Specifically, the tool provides:
31+
32+
- A human-readable form of the CID
33+
- Information on the CID components
34+
- The length of the binary and Base32 encoded CID
35+
- The CIDv1 representation, if applicable
36+
37+
:::callout
38+
Learn more about CID concepts, including components and versions in the [content addressing concepts guide](../concepts/content-addressing.md).
39+
:::
40+
41+
## IPFS Gateway Checker
42+
43+
IPFS [Gateway Checker]() provides status information for public IPFS gateways. This information is useful in deciding on which public gateway provider to use, or troubleshooting problems with your current public gateway provider.
44+
45+
## DAG builder visualiser
46+
47+
[DAG builder visualiser](https://dag.ipfs.tech/) allows you to upload a CAR file and visualize it as a DAG. You can toggle parameters that determine how the DAG will be visualized, such as typ (Balanced, Trickle, Flat) and max amount of children.
48+
49+
## CAR Builder
50+
51+
[CAR Builder](https://car.ipfs.io/) allows you to upload a data file and export it as an IPFS CAR file. The tool automatically chunks and hashes your files to automatically produce an IPFS compatible content-addressed archive.
52+
53+
## pl-diagnose
54+
55+
[pl-diagnose](https://pl-diagnose.on.fleek.co/#/diagnose/access-content) is a browser-based software application that automates diagnosis of various issues with an IPFS node. Specifically, this tool can help you answer these questions:
56+
57+
- Is a given CID available on the IPFS network and, if so, which peers are listed in the DHT as providers?
58+
- Which addresses are listed in the DHT for a given IPFS node?
59+
- Is an IPFS node accessible by other peers?
60+
- Is specific content available from an IPFS node?
61+

0 commit comments

Comments
 (0)