syncthing / syncthing/docs

listen address under IPv6

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

Nobody has claimed this yet.

Dominant language
Python
Stars
327
Forks
653
PR merge metrics
No merged PRs in 30d

Description

related to: https://github.com/syncthing/syncthing/issues/7581
related to: https://github.com/syncthing/syncthing/issues/2316
and here: https://github.com/golang/go/blob/d26fc68aa10dc8eda5ccdcc80d790e7df2fd9823/src/net/url/url.go#L223-L235

There ( https://github.com/syncthing/docs/blob/main/users/config.rst?plain=1#L1423 ) could be a hint, that you need to replace the single % with the %25. Especially the link-local IPv6 address needs it.

TCP IPv6 address and port (tcp6://[2001:db8::42]:22000, tcp6://[fe80::42:deff:fed4:b1bd]%25enp0s8)
This results in Syncthing listening on the specified address and port, IPv6
only. In the case of binding to a specific interface, the scope ID is needed and is added after the IPv6 address + #25 + scopeID

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 at users/config.rst around the IPv6 TCP listen-address example and compare its scope-ID wording with the linked Go URL parsing reference and related issues. Verify the documented percent-encoding and update the example and explanation so the link-local interface syntax is unambiguous; done when the documentation matches the supported address format.

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
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.