libp2p / libp2p/docs

Describe NAT hole punching in the NAT overview

Open
#339 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
72
Forks
97
PR merge metrics
No merged PRs in 30d

Description

Currently, the only "main approaches to NAT traversal available in libp2p today" is Automatic Router Configuration, according to https://docs.libp2p.io/concepts/nat/overview/. It would be helpful to list some other options, including NAT hole punching.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the NAT overview at https://docs.libp2p.io/concepts/nat/overview/ and review how its current list of NAT traversal approaches is structured. Update the page to include NAT hole punching and other relevant options, ensuring the overview no longer presents Automatic Router Configuration as the only approach.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, networking
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.