Skip to content
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

chore: update diagnostic-tools.md #1934

Merged
merged 2 commits into from
Oct 2, 2024
Merged

chore: update diagnostic-tools.md #1934

merged 2 commits into from
Oct 2, 2024

Conversation

lidel
Copy link
Member

@lidel lidel commented Oct 2, 2024

Added glossary links + removed potential footguns.


@[youtube](XeNOQDOrdC0)

Each error type output by the tool can indicate a solution to your problem:

- **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.
- **Could not find address in the DHT** indicates that your machine is either not connected to the Amino DHT (even as a client), or it is not advertising the address that you are using to test.
- **Multihash not advertised in the DHT** indicates that your machine has not advertised that it has the requested content in the Amino 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).
- **Multihash not advertised in the DHT** indicates that your machine has not advertised that it has the requested content in the Amino DHT.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rationale: we know there could be other reasons, such as people just unknowingly disabling announcements via lowpower profile (ipfs/kubo#10524).

Let's remove this kubo-specific suggestion, as it may do more harm than good (we know that it makes Kubo-based gateway perform worse with accelerated client enabled (notes))

Comment on lines -14 to -17
- [Project Apollo archives](https://explore.ipld.io/#/explore/QmSnuWmxptJZdLJpKRarxBMS2Ju2oANVrgbr2xWbie9b2D)
- [IGIS Git repository](https://explore.ipld.io/#/explore/baf4bcfg4ep767tjp5lxyanx5urpjjgx5q2volvy)
- [An Ethereum block](https://explore.ipld.io/#/explore/bagiacgzah24drzou2jlkixpblbgbg6nxfrasoklzttzoht5hixhxz3rlncyq)
- [XKCD archives](https://explore.ipld.io/#/explore/QmdmQXB2mzChmMeKY47C43LxUdg1NDJ5MWcKMKxDu7RgQm)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Example list changed, and some of these no longer work. Main landing page lists up-to-date examples, so removing them from here, saving screen estate.

@lidel lidel requested a review from 2color October 2, 2024 13:34
@lidel lidel marked this pull request as ready for review October 2, 2024 13:34
@lidel lidel merged commit 958f090 into main Oct 2, 2024
4 of 5 checks passed
@lidel lidel deleted the update-diagnostics-page branch October 2, 2024 15:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants