ipfs/kubo

User option to advertise relay addresses

Open

#4230 opened on Sep 14, 2017

View on GitHub
 (13 comments) (5 reactions) (0 assignees)Go (13,906 stars) (2,725 forks)batch import
help wanted

Description

Type: Enhancement

Description:

We currently filter relay addresses by default, with thre rationale that it is an experimental feature. We do want to make it easy for node operators to use however, especially when they know a priori that they are behind an impenetrable NAT.

We should implement a configuration option, Swarm.AdvertiseRelayAddress with default of false, that disables the filtering of relay addresses. When the option is set, the unspecific p2p-circuit address will not be filtered, which will allow peers to automatically attempt dialing through known relays.

Contributor guide

Tech stack
go
Domain
backendinfrastructure
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic knowledge of IPFSUnderstanding of NAT traversalFamiliarity with Go configuration patterns
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
The issue requests a new configuration option 'Swarm.AdvertiseRelayAddress' (default false) to disable filtering of relay addresses. The implementation should modify the configuration parsing in the kubo repository, likely in files related to swarm configuration (e.g., 'config/types.go' or 'core/node/swarm.go'). The option should affect address filtering logic in 'p2p/circuit' package. After implementing, add tests and update documentation. Review the discussion in the issue comments for any additional constraints.