Skip to content

docs(netbird): document STUN networking setup#68

Merged
mikkeldamsgaard merged 1 commit intomainfrom
docs/67-stun-networking
Apr 12, 2026
Merged

docs(netbird): document STUN networking setup#68
mikkeldamsgaard merged 1 commit intomainfrom
docs/67-stun-networking

Conversation

@mikkeldamsgaard
Copy link
Copy Markdown
Contributor

Summary

  • Add "STUN Networking" section to the netbird README explaining why STUN needs a dedicated service (UDP can't go through HTTP ingress)
  • Document three networking options: separate LoadBalancer (default), shared static IP, and NodePort
  • Expand inline comments in values.yaml for stunPorts and stunService
  • Add STUN DNS guidance and kubectl get svc command to post-install NOTES.txt
  • Update architecture diagram with protocol annotation

Closes #67

Test plan

  • helm lint charts/netbird — passes
  • helm unittest charts/netbird — 193/193 tests pass
  • helm install --dry-run renders NOTES.txt correctly for both ClusterIP and LoadBalancer

🤖 Generated with Claude Code

Explain why the STUN service needs a separate Kubernetes Service (UDP
cannot traverse HTTP ingress) and document three networking options:
separate LoadBalancer, shared static IP, and NodePort.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@mikkeldamsgaard mikkeldamsgaard merged commit 98bcb8c into main Apr 12, 2026
12 checks passed
@mikkeldamsgaard mikkeldamsgaard deleted the docs/67-stun-networking branch April 12, 2026 15:53
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.

Kubernetes service (netbird-server-stun) type ClusterIP instead of LoadBalancer

1 participant