Skip to content

Update docs for the next release - #390

Draft
JackDoan wants to merge 28 commits into
mainfrom
release-docs
Draft

JackDoan wants to merge 28 commits into
mainfrom
release-docs

Conversation

@JackDoan

Copy link
Copy Markdown
Contributor

Brings the docs up to date with nebula master (since v1.11.0) for the next release. Includes the offload and CPU pinning docs from #376 (plus fixes to them), so this supersedes #376.

New pages

  • config/local-api: the control socket and the info API
  • Guide: nebula ctl and the info HTTP API, including the caveat about trusting identity answers
  • Guide: reloading configuration (the reload summary line, entries that now fail a reload, and the settings that need a restart on each platform)
  • Guide: FIPS 140-3 mode

Fixed wrong values

  • tun.tx_queue default is 5000, not 500
  • static_map.lookup_timeout default is 5s, not 250ms
  • pki.disconnect_invalid default is true, not false
  • pki.initiating_version default is 1 or 2 depending on the certs loaded, not 0
  • stats.protocol: only tcp, tcp4 or tcp6 work; udp never did
  • FreeBSD/OpenBSD/NetBSD tun.dev naming
  • logging.timestamp_format, which no longer exists, and the log levels
  • Stale lighthouse DNS TXT output, and old-format log samples
  • The ssh debug command list: profiling commands removed, identity added

Newly documented behavior

  • Offloads and CPU pinning (from Document offload and CPU pinning config #376)
  • IPv6 non-TCP/UDP/ICMP traffic only matches proto: any
  • Firewall group value rules and conntrack timeouts
  • An IPv4 listen.host means Nebula ignores IPv6 underlay addresses
  • The 8937 MTU cap
  • Route entry fields, and macOS unsafe_route ownership
  • Windows network_category and windows_bypass_wdf, and DNS registration being off
  • UDP buffer fallback without CAP_NET_ADMIN
  • handshakes.query_buffer
  • Newer metrics
  • Automatic rekeying
  • When a reload restarts sshd
  • Relay reload behavior
  • Static map lookup failures keeping the last good addresses
  • Reloadable / not reloadable labels across most config pages

Notes for review

  • "Added in v1.12.0" labels assume that's the next version.
  • relay.am_relay now says a relay does not check the target's relay.relays. That matches the code, but the old text promised otherwise.
  • Sidebar positions were renumbered to fit the new pages.

🤖 Generated with Claude Code

JackDoan and others added 28 commits October 26, 2026 11:51
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…r fallback and reloadability, and listen.windows_bypass_wdf
@github-actions

github-actions Bot commented Oct 26, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for docs-nebula ready!

Name Link
🔨 Latest commit f6ac788
🔍 Latest deploy log https://github.com/DefinedNet/nebula-docs/actions/runs/40364959875
😎 Deploy Preview Url https://887d941f.docs-nebula.pages.dev
😎 Deploy Preview Alias https://release-docs.docs-nebula.pages.dev

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