docs(kubo): flag server-profile reverse-proxy gotcha#2275
Open
Conversation
Kubo's `server` profile filters loopback in `Swarm.AddrFilters`, which silently breaks any setup that fronts a `127.0.0.1` listener with a local reverse proxy (a common pattern for `/ws` bootstrappers). Kubo 0.42 will log an explicit ERROR at startup, but ipfs-docs had no on-ramp pointing readers at the override they need to apply, and the existing `server`-profile mention in the quickstart understated what the profile actually does. - `command-line-quick-start.md`: replace the data-center one-liner with a more accurate description (local discovery off, non-globally- routable connections refused) and link to the kubo `server` profile reference, including the reverse-proxy override row. - `troubleshooting-kubo.md`: add a short "A configured Swarm listener appears unreachable" section that quotes the kubo 0.42 ERROR line verbatim and links to the override table. - `nat-configuration.md`: add a tip clarifying that `Addresses.NoAnnounce` (publish-side) and `Swarm.AddrFilters` (connection gate) are different, since the existing example shows both as empty arrays without context.
Contributor
🚀 Build Preview on IPFS ready
|
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.
Kubo's
serverprofile filters loopback inSwarm.AddrFilters, which silently breaks any setup that fronts a127.0.0.1listener with a local reverse proxy (a common pattern for/wsbootstrappers). Kubo 0.42 will log an explicit ERROR at startup:but ipfs-docs had no on-ramp pointing readers at the override they need to apply, and the existing
server-profile mention in the quickstart understated what the profile actually does.This PR adds minimal pointers so users and LLMs can avoid footgun of blocking themselves.
This is a second-order effect of libp2p changes described in
AllAddrsmethod to return all interface addrs and not just the primary interface libp2p/go-libp2p#3460