Skip to content

Document missing CLI flags and client environment variables#687

Merged
lixmal merged 3 commits intomainfrom
doc-cli-flags-envvars
Apr 8, 2026
Merged

Document missing CLI flags and client environment variables#687
lixmal merged 3 commits intomainfrom
doc-cli-flags-envvars

Conversation

@lixmal
Copy link
Copy Markdown
Contributor

@lixmal lixmal commented Apr 8, 2026

Summary

Add documentation for ~35 missing CLI flags and create a new client environment variables reference page with ~47 NB_* env vars.

Changes

CLI reference (get-started/cli.mdx)

  • Add missing global flags: --config, --hostname, --service, --setup-key-file
  • Add missing up flags: --block-lan-access, --disable-ipv6, --dns-router-interval, --enable-lazy-connection, --extra-iface-blacklist, --mtu, --network-monitor, --no-browser, --profile
  • Add login flags section (--no-browser, --profile)
  • Add missing status flags: --check, --filter-by-connection-type, --ipv6
  • Add missing ssh flags: --user, --login, --tty, --strict-host-key-checking, --known-hosts, --no-browser, --no-cache
  • Add missing expose flag: --with-external-port; update --protocol to include tcp/udp/tls
  • Add service install --service-env flag with persistence explanation
  • Add service reconfigure --service-env flag
  • Add service reset-params section
  • Add debug trace section with real output examples showing allowed, denied, and routed packets
  • Add networks command section with select --append and deselect
  • Add profile command section
  • Add flag value syntax note (boolean =false, string "" clearing)
  • Expand --disable-profiles / --disable-update-settings with use case explanation for managed machines
  • Update --ssh-jwt-cache-ttl to document server-side 10-minute default token age
  • Reorder all flag blocks to match --help output

Environment variables (client/environment-variables.mdx, new page)

  • Document ~47 NB_* env vars across networking, WireGuard, firewall, ICE, DNS, retry, SSH, relay, and management categories
  • Each var verified against source code for correct defaults, platform, and behavior
  • Explain how to set env vars on the daemon via --service-env
  • Cross-linked from CLI page and troubleshooting page

Troubleshooting (help/troubleshooting-client.mdx)

  • Add "Tracing firewall rules" section linking to debug trace
  • Add "Advanced environment variables" section linking to env vars page

Screenshots

cli-wide-2026-04-08T11-14-56-498Z envvars-wide-2026-04-08T11-15-09-753Z troubleshooting-wide-2026-04-08T11-15-23-372Z

@lixmal lixmal force-pushed the doc-cli-flags-envvars branch from ffe0b7a to e4566ec Compare April 8, 2026 11:14
@lixmal lixmal changed the title [doc] Document missing CLI flags and client environment variables Document missing CLI flags and client environment variables Apr 8, 2026
- Add note that NB_CONN_MAX_RETRY_TIME_TIME double suffix is intentional
- Update expose examples to include TCP and TLS protocols
- Fix expose description to not imply HTTP-only
@lixmal lixmal force-pushed the doc-cli-flags-envvars branch from e1c229a to 8b3fcee Compare April 8, 2026 14:19
@lixmal lixmal merged commit 5a575ac into main Apr 8, 2026
1 check passed
@lixmal lixmal deleted the doc-cli-flags-envvars branch April 8, 2026 14:19
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.

3 participants