Skip to content

Updates for the NetBird 0.75 update#881

Merged
TechHutTV merged 3 commits into
netbirdio:mainfrom
PizzaLovingNerd:0-75
Jul 24, 2026
Merged

Updates for the NetBird 0.75 update#881
TechHutTV merged 3 commits into
netbirdio:mainfrom
PizzaLovingNerd:0-75

Conversation

@PizzaLovingNerd

@PizzaLovingNerd PizzaLovingNerd commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

Updates the documentation for the public-facing changes introduced in NetBird v0.75:

  • updates the desktop app, profiles, onboarding, client settings, SSH, overlapping resources, and debug-bundle documentation for the redesigned UI
  • distinguishes Connect on Startup from Launch NetBird UI at Login
  • corrects the Windows GPO, Intune, MDM, and Acronis deployment instructions
  • rewrites the lazy-connections documentation around Management configuration, NB_LAZY_CONN, and MDM policy
  • documents DNS lazy warm-up with NB_DNS_LAZY_WARMUP_TIMEOUT
  • updates traffic-event documentation for aggregated flow windows, counters, filtering, and pagination
  • documents Dex grant-type controls and the /oauth2/device/code endpoint
  • adds relay trusted-proxy configuration and security guidance
  • documents pprof exposure and security considerations
  • adds the Agent Network focused dashboard view

View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need. Autofix is disabled.

Summary by CodeRabbit

  • Documentation
    • Updated desktop app guidance for first launch and UX behavior, resources (search/filter/toggle), system tray actions, session expiration/renewal, profiles, SSH, quantum resistance, connect-on-startup, inbound traffic blocking, and overlapping route selection.
    • Added Agent Network “focused dashboard view” docs and refreshed lazy-connection documentation (settings, env/MDM precedence, DNS warm-up, and deprecated options/flags).
    • Expanded get-started, installation, environment variables, and debug bundle instructions (local ZIP behavior, upload vs local outcomes, capture options, and platform paths).
    • Refreshed traffic event logging to the aggregated flow model; updated self-hosted/auth, relay/proxy trust (trusted proxies), HA scaling, and grantTypes/device authorization endpoint guidance.

@coderabbitai

coderabbitai Bot commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: a96144e1-ec07-4010-9e41-47de1691dc44

📥 Commits

Reviewing files that changed from the base of the PR and between a681e69 and c823b83.

📒 Files selected for processing (12)
  • src/pages/client/desktop-app.mdx
  • src/pages/client/mdm-integration.mdx
  • src/pages/client/profiles.mdx
  • src/pages/get-started/install/linux.mdx
  • src/pages/get-started/install/windows.mdx
  • src/pages/help/troubleshooting-client.mdx
  • src/pages/manage/activity/traffic-events-logging.mdx
  • src/pages/manage/for-partners/acronis-integration.mdx
  • src/pages/manage/integrations/mdm-deployment/intune-netbird-integration.mdx
  • src/pages/selfhosted/maintenance/configuration-files.mdx
  • src/pages/selfhosted/maintenance/scaling/high-availability.mdx
  • src/pages/selfhosted/maintenance/scaling/set-up-external-relays.mdx
🚧 Files skipped from review as they are similar to previous changes (9)
  • src/pages/selfhosted/maintenance/scaling/set-up-external-relays.mdx
  • src/pages/get-started/install/linux.mdx
  • src/pages/client/mdm-integration.mdx
  • src/pages/selfhosted/maintenance/configuration-files.mdx
  • src/pages/selfhosted/maintenance/scaling/high-availability.mdx
  • src/pages/help/troubleshooting-client.mdx
  • src/pages/client/profiles.mdx
  • src/pages/manage/activity/traffic-events-logging.mdx
  • src/pages/client/desktop-app.mdx

📝 Walkthrough

Walkthrough

This documentation update aligns desktop-app workflows, lazy-connection controls, debug-bundle behavior, traffic-event aggregation, and self-hosted configuration guidance with current product behavior.

Changes

Desktop workflows and installation

Layer / File(s) Summary
Desktop app behavior and settings
src/pages/client/desktop-app.mdx
Documents redesigned frontend behavior, resources, tray actions, settings, session renewal, and MDM UI policies.
Desktop onboarding and installation
src/pages/get-started/*, src/pages/get-started/install/*
Updates first-launch, browser authentication, and Linux dependency instructions.
Windows autostart and MDM guidance
src/pages/get-started/install/windows.mdx, src/pages/manage/for-partners/..., src/pages/manage/integrations/mdm-deployment/*, src/pages/client/mdm-integration.mdx
Replaces machine-wide installer autostart and AUTOSTART guidance with per-user desktop behavior and MDM controls.
Desktop settings task guides
src/pages/client/*, src/pages/manage/network-routes/*, src/pages/manage/peers/ssh.mdx
Replaces system-tray instructions with desktop-app navigation for security, startup, quantum resistance, routes, and SSH.
Profiles and focused dashboard
src/pages/client/profiles.mdx, src/pages/agent-network/index.mdx
Updates GUI profile management, state-directory guidance, and Agent Network focused-dashboard behavior.

Lazy connection controls

Layer / File(s) Summary
Lazy connection variables and policies
src/pages/client/environment-variables.mdx, src/pages/client/mdm-integration.mdx, src/pages/get-started/cli.mdx
Documents NB_LAZY_CONN, DNS warm-up timeout, lazyConnection, and deprecated controls.
Lazy connection lifecycle and overrides
src/pages/manage/peers/lazy-connection.mdx
Describes traffic-driven connections, inactivity handling, DNS warm-up, Management settings, and client overrides.

Debug bundle documentation

Layer / File(s) Summary
Debug bundle generation and capture
src/pages/client/desktop-app.mdx, src/pages/get-started/cli.mdx, src/pages/help/troubleshooting-client.mdx
Documents archive paths, ownership, contents, upload keys, capture options, and local ZIP retention.

Traffic events aggregation

Layer / File(s) Summary
Aggregated traffic records
src/pages/manage/activity/traffic-events-logging.mdx
Reworks traffic-event documentation around aggregation windows, counters, API fields, filters, examples, and routed-event behavior.

Self-hosted configuration

Layer / File(s) Summary
Runtime and relay settings
src/pages/selfhosted/environment-variables.mdx
Documents pprof listener behavior and trusted proxy settings.
Device authorization grants
src/pages/selfhosted/identity-providers/local.mdx, src/pages/selfhosted/maintenance/configuration-files.mdx
Documents grant-type restrictions and the conditional device authorization endpoint.
Relay proxy and load-balancer setup
src/pages/selfhosted/maintenance/scaling/*
Adds forwarded-header, trusted-proxy, CLI, and startup-validation guidance.

Estimated code review effort: 4 (Complex) | ~45 minutes

Possibly related PRs

Suggested reviewers: lixmal

Poem

I’m a rabbit with docs in my paws,
Hopping through settings and connection laws.
Lazy peers wake when packets arrive,
Debug ZIPs keep their local archive.
Proxies trust headers, flows count anew—
Fresh desktop paths guide the way through!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title is related to the PR, but it is too generic to clearly describe the main documentation changes. Use a more specific title that names the NetBird v0.75 documentation updates, such as desktop app, lazy connection, and deployment docs.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

src/pages/client/desktop-app.mdx

Oops! Something went wrong! :(

ESLint: 9.39.2

TypeError: Converting circular structure to JSON
--> starting at object with constructor 'Object'
| property 'configs' -> object with constructor 'Object'
| property 'flat' -> object with constructor 'Object'
| ...
| property 'plugins' -> object with constructor 'Object'
--- property 'react' closes the circle
Referenced from:
at JSON.stringify ()
at file:///node_modules/@eslint/eslintrc/lib/shared/config-validator.js:308:45
at Array.map ()
at ConfigValidator.formatErrors (file:///node_modules/@eslint/eslintrc/lib/shared/config-validator.js:299:23)
at ConfigValidator.validateConfigSchema (file:///node_modules/@eslint/eslintrc/lib/shared/config-validator.js:330:84)
at ConfigArrayFactory._normalizeConfigData (file:///node_modules/@eslint/eslintrc/lib/config-array-factory.js:676:19)
at ConfigArrayFactory._loadConfigData (file:///node_modules/@eslint/eslintrc/lib/config-array-factory.js:641:21)
at ConfigArrayFactory._loadExtendedShareableConfig (file:///node_modules/@eslint/eslintrc/lib/config-array-factory.js:946:21)
at ConfigArrayFactory._loadExtends (file:///node_modules/@eslint/eslintrc/lib/config-array-factory.js:814:25)
at ConfigArrayFactory._normalizeObjectConfigDataBody (file:///node_modules/@eslint/eslintrc/lib/config-array-factory.js:752:25)

src/pages/client/mdm-integration.mdx

Oops! Something went wrong! :(

ESLint: 9.39.2

TypeError: Converting circular structure to JSON
--> starting at object with constructor 'Object'
| property 'configs' -> object with constructor 'Object'
| property 'flat' -> object with constructor 'Object'
| ...
| property 'plugins' -> object with constructor 'Object'
--- property 'react' closes the circle
Referenced from:
at JSON.stringify ()
at file:///node_modules/@eslint/eslintrc/lib/shared/config-validator.js:308:45
at Array.map ()
at ConfigValidator.formatErrors (file:///node_modules/@eslint/eslintrc/lib/shared/config-validator.js:299:23)
at ConfigValidator.validateConfigSchema (file:///node_modules/@eslint/eslintrc/lib/shared/config-validator.js:330:84)
at ConfigArrayFactory._normalizeConfigData (file:///node_modules/@eslint/eslintrc/lib/config-array-factory.js:676:19)
at ConfigArrayFactory._loadConfigData (file:///node_modules/@eslint/eslintrc/lib/config-array-factory.js:641:21)
at ConfigArrayFactory._loadExtendedShareableConfig (file:///node_modules/@eslint/eslintrc/lib/config-array-factory.js:946:21)
at ConfigArrayFactory._loadExtends (file:///node_modules/@eslint/eslintrc/lib/config-array-factory.js:814:25)
at ConfigArrayFactory._normalizeObjectConfigDataBody (file:///node_modules/@eslint/eslintrc/lib/config-array-factory.js:752:25)

src/pages/client/profiles.mdx

Oops! Something went wrong! :(

ESLint: 9.39.2

TypeError: Converting circular structure to JSON
--> starting at object with constructor 'Object'
| property 'configs' -> object with constructor 'Object'
| property 'flat' -> object with constructor 'Object'
| ...
| property 'plugins' -> object with constructor 'Object'
--- property 'react' closes the circle
Referenced from:
at JSON.stringify ()
at file:///node_modules/@eslint/eslintrc/lib/shared/config-validator.js:308:45
at Array.map ()
at ConfigValidator.formatErrors (file:///node_modules/@eslint/eslintrc/lib/shared/config-validator.js:299:23)
at ConfigValidator.validateConfigSchema (file:///node_modules/@eslint/eslintrc/lib/shared/config-validator.js:330:84)
at ConfigArrayFactory._normalizeConfigData (file:///node_modules/@eslint/eslintrc/lib/config-array-factory.js:676:19)
at ConfigArrayFactory._loadConfigData (file:///node_modules/@eslint/eslintrc/lib/config-array-factory.js:641:21)
at ConfigArrayFactory._loadExtendedShareableConfig (file:///node_modules/@eslint/eslintrc/lib/config-array-factory.js:946:21)
at ConfigArrayFactory._loadExtends (file:///node_modules/@eslint/eslintrc/lib/config-array-factory.js:814:25)
at ConfigArrayFactory._normalizeObjectConfigDataBody (file:///node_modules/@eslint/eslintrc/lib/config-array-factory.js:752:25)

  • 9 others

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 10

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@src/pages/client/desktop-app.mdx`:
- Line 78: Update the disableAutostart links in src/pages/client/desktop-app.mdx
(78-78), src/pages/get-started/install/windows.mdx (39-39),
src/pages/manage/for-partners/acronis-integration.mdx (84-84), and
src/pages/manage/integrations/mdm-deployment/intune-netbird-integration.mdx
(107-107) to target an explicit disableAutostart anchor. Add
id="disableAutostart" to the corresponding table cell and note list item in
src/pages/client/mdm-integration.mdx, or make every fragment match the actual
rendered hash.

In `@src/pages/client/profiles.mdx`:
- Around line 31-32: Remove the duplicate image block using the
profiles-edit.png asset in the profiles documentation, or replace it with the
intended distinct asset. Ensure the screenshot is rendered only once and retain
the appropriate alt text.
- Around line 63-70: Update the profile storage table in the documented section
to include a verified FreeBSD row using `/var/db/netbird` as the default state
directory and an appropriate per-user `<id>.json` example, consistent with the
existing path format.

In `@src/pages/get-started/install/linux.mdx`:
- Around line 23-25: Update the RHEL support note in the Note block to remove
the incorrect claim that RHEL 9 lacks GTK 4. If RHEL 9 remains unsupported,
state that the requirement is WebKitGTK 6.0 support, and clarify that RHEL 10
obtains webkitgtk6.0 through EPEL.

In `@src/pages/help/troubleshooting-client.mdx`:
- Around line 225-237: Update the path-visibility statement near the generated
ZIP documentation to accurately distinguish clients: state that the CLI always
prints the generated path, while the desktop app shows it only when upload is
disabled, or document how the app exposes it for both upload outcomes. Keep the
existing temporary-directory and ownership details unchanged.

In `@src/pages/manage/activity/traffic-events-logging.mdx`:
- Around line 49-51: Update the successful-flow example in the activity logging
documentation so the protocol description is consistent: change the
receiver-perspective sentence to state that the flow was authorized over TCP on
port 443, matching the browser connection described elsewhere. Do not alter the
existing browser setup or commands.
- Around line 159-160: Update the documentation text near the 50,000 flow-record
limit to remove the “coming days” expansion promise and state only that the
limit may change. Preserve the existing limit information without adding a dated
commitment or status link.
- Line 116: Update the traffic-event aggregation documentation around the
grouping description and all related references, especially the section near
line 324, to remove source port and ICMP code from the aggregation key. Ensure
the documented key contains only protocol, destination address/port, and ICMP
type where applicable, while preserving the rest of the aggregation behavior.

In `@src/pages/selfhosted/maintenance/configuration-files.mdx`:
- Around line 308-313: Update the OAuth device-code verification command in the
maintenance configuration documentation to use curl’s POST method for
/oauth2/device/code, while preserving the existing 404 expectation and OIDC
discovery check.

In `@src/pages/selfhosted/maintenance/scaling/high-availability.mdx`:
- Around line 366-367: Require proxy/load-balancer configurations to strip
client-supplied X-Real-Ip and X-Real-Port, then overwrite them from the
validated client connection before Relay consumes them. Add this requirement to
the Relay frontend instructions at
src/pages/selfhosted/maintenance/scaling/high-availability.mdx lines 366-367,
the NB_TRUSTED_PROXIES environment-variable table entry at lines 406-406, and
the external-relay setup instructions at
src/pages/selfhosted/maintenance/scaling/set-up-external-relays.mdx lines 90-96.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 428b3ad2-cbdd-4d0e-a548-f460a397c672

📥 Commits

Reviewing files that changed from the base of the PR and between 03d15c3 and a681e69.

⛔ Files ignored due to path filters (5)
  • public/docs-static/img/client/profiles/manage-profiles.png is excluded by !**/*.png
  • public/docs-static/img/help/troubleshooting-client/ui-bundle-local-success.png is excluded by !**/*.png
  • public/docs-static/img/help/troubleshooting-client/ui-settings.png is excluded by !**/*.png
  • public/docs-static/img/manage/network-routes/overlapping-routes/select-network-routes.png is excluded by !**/*.png
  • public/docs-static/img/manage/peers/ssh/ssh-client.png is excluded by !**/*.png
📒 Files selected for processing (27)
  • src/pages/agent-network/index.mdx
  • src/pages/client/block-inbound-connections.mdx
  • src/pages/client/connect-on-startup.mdx
  • src/pages/client/desktop-app.mdx
  • src/pages/client/environment-variables.mdx
  • src/pages/client/mdm-integration.mdx
  • src/pages/client/post-quantum-cryptography.mdx
  • src/pages/client/profiles.mdx
  • src/pages/get-started/cli.mdx
  • src/pages/get-started/index.mdx
  • src/pages/get-started/install/index.mdx
  • src/pages/get-started/install/linux.mdx
  • src/pages/get-started/install/macos.mdx
  • src/pages/get-started/install/windows.mdx
  • src/pages/help/troubleshooting-client.mdx
  • src/pages/manage/activity/traffic-events-logging.mdx
  • src/pages/manage/for-partners/acronis-integration.mdx
  • src/pages/manage/integrations/mdm-deployment/intune-netbird-integration.mdx
  • src/pages/manage/integrations/mdm-deployment/windows-gpo-deployment.mdx
  • src/pages/manage/network-routes/overlapping-routes.mdx
  • src/pages/manage/peers/lazy-connection.mdx
  • src/pages/manage/peers/ssh.mdx
  • src/pages/selfhosted/environment-variables.mdx
  • src/pages/selfhosted/identity-providers/local.mdx
  • src/pages/selfhosted/maintenance/configuration-files.mdx
  • src/pages/selfhosted/maintenance/scaling/high-availability.mdx
  • src/pages/selfhosted/maintenance/scaling/set-up-external-relays.mdx

Comment thread src/pages/client/desktop-app.mdx Outdated
Comment thread src/pages/client/profiles.mdx
Comment thread src/pages/client/profiles.mdx
Comment thread src/pages/get-started/install/linux.mdx
Comment thread src/pages/help/troubleshooting-client.mdx
Comment thread src/pages/manage/activity/traffic-events-logging.mdx Outdated
Comment thread src/pages/manage/activity/traffic-events-logging.mdx Outdated
Comment thread src/pages/manage/activity/traffic-events-logging.mdx Outdated
Comment thread src/pages/selfhosted/maintenance/configuration-files.mdx
Comment thread src/pages/selfhosted/maintenance/scaling/high-availability.mdx Outdated
@TechHutTV
TechHutTV merged commit b867aa8 into netbirdio:main Jul 24, 2026
3 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.

3 participants