Skip to content

chore(docs): use RFC 5737 documentation addresses instead of a LAN host in examples - #425

Merged
davidamacey merged 3 commits into
mainfrom
chore/doc-example-addresses
Nov 1, 2026
Merged

davidamacey merged 3 commits into
mainfrom
chore/doc-example-addresses

Conversation

@davidamacey

Copy link
Copy Markdown
Owner

Found by the 2026-11-01 Docker Hub audit: a real LAN host address (10.10.10.20) was used as an example in a docstring (src/core/request_origin.py), the monitoring docs page and two test files, and it shipped in the 0.4.0-0.6.0 API images.

  • Every use of it is replaced with the RFC 5737 documentation address 192.0.2.10. Tests change both sides consistently, and their behaviour is unchanged.
  • Generic private fixtures (10.0.0.5, 192.168.1.x, 172.16-31.x) are left alone: they are the point of the private-vs-public classification tests.
  • The naming-leak scan gains Scan D, which rejects that exact address anywhere in the tracked tree, anchored so 10.10.10.200 is not flagged. 10/8 as a whole is not banned.

Checks: naming scan exit 0; docs vs code 0 problems; 61 tests pass in the touched files; docs-site build OK; pre-commit passes.

@davidamacey
davidamacey merged commit 8e5ecb9 into main Nov 1, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant