docs: guide to replace public gateways with self-hosted IPFS#2285
Open
lidel wants to merge 6 commits into
Open
docs: guide to replace public gateways with self-hosted IPFS#2285lidel wants to merge 6 commits into
lidel wants to merge 6 commits into
Conversation
New how-to for non-browser clients and web apps still calling ipfs.io or dweb.link, routing each case to a drop-in replacement: - backend retrieve-only -> Rainbow, with trustless-only config for public hostnames - backend retrieve and publish -> Kubo, plus pinning services or IPFS Cluster for redundancy - browser JS -> @helia/verified-fetch, with self-hosted Someguy and Rainbow/Kubo to stay independent of public utilities Linked from the IPFS Gateway sidebar group and the how-to index.
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Contributor
🚀 Build Preview on IPFS ready
|
Point readers from the gateway and public-utility docs to the migration guide, and reorder it to match how readers choose a path. - guide: lead with @helia/verified-fetch, then Rainbow, then Kubo, matching the "Pick your path" table order - link the guide from public-utilities, ipfs-gateway, ipfs-in-web-apps, address-ipfs-on-web, and gateway-best-practices - note verified-fetch can deserialize a trustless response client-side, so apps needing files still work against a trustless-only endpoint - note RAINBOW_SUBDOMAIN_GATEWAY_DOMAINS needs localhost or a Public Suffix List hostname for browser origin isolation - sidebar: place the guide before troubleshooting
Address the legitimate LanguageTool findings; the rest were false positives on code fences, domains, and shell snippets. - add comma after introductory "By default" - "install steps" -> "installation steps"
Switch the reporter to check-run annotations and silence rules that misfire on code and domains, so pushes stop stacking duplicate review comments and addressed findings clear themselves. - reporter github-pr-review -> github-pr-check (annotations replace per run, no duplicate comments, fixed findings drop on the next run) - disable rules that fire on code fences, inline code, shell snippets, and domain names, on top of the action defaults
Touching ipfs-gateway.md made the link checker scan it and surfaced two pre-existing dead links; the prose also used terms missing from the Vale vocabulary. - accept.txt: add hotlink, subresource, navigation, deserialize, env - ipfs-gateway: gateway-troubleshooting.md -> troubleshooting.md - mlc config: ignore gnu.org (valid URL, 403s the checker bot)
The vale Vocab is not enabled in .vale.ini, so accept.txt was dead config; PLNSpelling reads pln-ignore.txt. Move the words there and revert the accept.txt change. - pln-ignore: deserializes, dnslinks, env, fastly, hotlinked, iostat, iotop, navigations, speedtest, subresource(s)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
New how-to for non-browser clients and web apps still calling ipfs.io or dweb.link, routing each case to a drop-in replacement:
Linked from the IPFS Gateway sidebar group and the how-to index.