Updates for the NetBird 0.75 update#881
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (12)
🚧 Files skipped from review as they are similar to previous changes (9)
📝 WalkthroughWalkthroughThis documentation update aligns desktop-app workflows, lazy-connection controls, debug-bundle behavior, traffic-event aggregation, and self-hosted configuration guidance with current product behavior. ChangesDesktop workflows and installation
Lazy connection controls
Debug bundle documentation
Traffic events aggregation
Self-hosted configuration
Estimated code review effort: 4 (Complex) | ~45 minutes Possibly related PRs
Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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
src/pages/client/desktop-app.mdxOops! Something went wrong! :( ESLint: 9.39.2 TypeError: Converting circular structure to JSON src/pages/client/mdm-integration.mdxOops! Something went wrong! :( ESLint: 9.39.2 TypeError: Converting circular structure to JSON src/pages/client/profiles.mdxOops! Something went wrong! :( ESLint: 9.39.2 TypeError: Converting circular structure to JSON
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. Comment |
There was a problem hiding this comment.
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
⛔ Files ignored due to path filters (5)
public/docs-static/img/client/profiles/manage-profiles.pngis excluded by!**/*.pngpublic/docs-static/img/help/troubleshooting-client/ui-bundle-local-success.pngis excluded by!**/*.pngpublic/docs-static/img/help/troubleshooting-client/ui-settings.pngis excluded by!**/*.pngpublic/docs-static/img/manage/network-routes/overlapping-routes/select-network-routes.pngis excluded by!**/*.pngpublic/docs-static/img/manage/peers/ssh/ssh-client.pngis excluded by!**/*.png
📒 Files selected for processing (27)
src/pages/agent-network/index.mdxsrc/pages/client/block-inbound-connections.mdxsrc/pages/client/connect-on-startup.mdxsrc/pages/client/desktop-app.mdxsrc/pages/client/environment-variables.mdxsrc/pages/client/mdm-integration.mdxsrc/pages/client/post-quantum-cryptography.mdxsrc/pages/client/profiles.mdxsrc/pages/get-started/cli.mdxsrc/pages/get-started/index.mdxsrc/pages/get-started/install/index.mdxsrc/pages/get-started/install/linux.mdxsrc/pages/get-started/install/macos.mdxsrc/pages/get-started/install/windows.mdxsrc/pages/help/troubleshooting-client.mdxsrc/pages/manage/activity/traffic-events-logging.mdxsrc/pages/manage/for-partners/acronis-integration.mdxsrc/pages/manage/integrations/mdm-deployment/intune-netbird-integration.mdxsrc/pages/manage/integrations/mdm-deployment/windows-gpo-deployment.mdxsrc/pages/manage/network-routes/overlapping-routes.mdxsrc/pages/manage/peers/lazy-connection.mdxsrc/pages/manage/peers/ssh.mdxsrc/pages/selfhosted/environment-variables.mdxsrc/pages/selfhosted/identity-providers/local.mdxsrc/pages/selfhosted/maintenance/configuration-files.mdxsrc/pages/selfhosted/maintenance/scaling/high-availability.mdxsrc/pages/selfhosted/maintenance/scaling/set-up-external-relays.mdx
Updates the documentation for the public-facing changes introduced in NetBird v0.75:
NB_LAZY_CONN, and MDM policyNB_DNS_LAZY_WARMUP_TIMEOUT/oauth2/device/codeendpointNeed help on this PR? Tag
@codesmith-botwith what you need. Autofix is disabled.Summary by CodeRabbit