sendnrw/netbird-docs
2
0
Fork 0
mirror of https://github.com/netbirdio/docs.git synced 2026-09-28 17:59:05 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updates for the NetBird 0.75 update (#881)

Browse Source
This commit is contained in:
PizzaLovingNerd
2026-07-24 07:43:56 -07:00
committed by GitHub
parent f6ee418c4b
commit b867aa85c8
32 changed files with 303 additions and 269 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/pages/help/troubleshooting-client.mdx
+42 -21
View File
@@ -222,9 +222,19 @@ Adding the `--system-info (-S)` flag will add system information like network ro
netbird debug bundle --anonymize --system-info
```
This will output the path of the generated file. The output file is owned by and can only be accessed by the user
NetBird is running as, by default it is: `Administrator` on Windows, `root` on MacOS/Linux or the operating system\'s
equivalent.
NetBird always creates a local ZIP in the daemon's temporary directory, including when you choose to upload the bundle.
With a standard service installation, bundles are stored in:
| Platform | Default location |
|---|---|
| Linux | `/tmp/netbird.debug.<number>.zip` |
| macOS | `/tmp/netbird.debug.<number>.zip` |
| Windows | `C:\Windows\Temp\netbird.debug.<number>.zip` |
The CLI always prints the generated path. The desktop app displays the ZIP path and an **Open Folder** action when upload is disabled or fails; after a successful upload, it displays the upload key instead. If the operating system's temporary directory has been
overridden, use the path shown by the client. The ZIP is owned by the account running the NetBird daemon: `root` on
standard Linux and macOS installations and `LocalSystem` on Windows. Elevated permissions may be required to access it
directly.
On iOS, the `netbird` CLI is not available. Collect the bundle from the app instead, under **Settings → Troubleshoot**. See [NetBird client on iOS](/help/troubleshooting-client/ios).
@@ -241,6 +251,8 @@ The archive collects the most useful diagnostics into one file, and every bundle
| `resolv.conf`, `scutil_dns.txt`, `resolved_domains.txt` | DNS resolver configuration and the domains NetBird resolved |
| `network_map.json` | Sync response: peers, routes, DNS settings, and firewall rules |
| `config.txt`, `state.json` | Client configuration and internal client state |
| `service_params.json` | Service-install parameters when available; sensitive environment values are masked |
| `metrics.txt` | Buffered client metrics when available; peer identifiers are anonymized |
With `--anonymize`, IP addresses, domains, and interface names are replaced consistently across every file, so the bundle stays readable while sensitive values are masked. Private keys and SSH keys are never included, and the packet capture (`capture.pcap`) is left out of anonymized bundles because it holds raw decrypted packets.
@@ -283,6 +295,7 @@ netbird debug bundle --system-info --upload-bundle
This will output an `Upload file key`, which is effectively a random filename in our internal storage system
and can be safely shared with us through public channels such as GitHub Issues or Slack.
Uploading the bundle does not remove the local ZIP from the temporary directory.
```shell
netbird debug bundle --system-info --upload-bundle
@@ -296,28 +309,38 @@ Upload file key:
The flag `--anonymize` can be used to anonymize IP addresses and non-netbird.io domains in logs and status output when needed.
</Note>
### Debug bundle uploads with GUI
Since version `0.43.2` users can upload their debug bundle via the GUI client.
To generate a bundle via GUI, you can access the application then go to `Settings` > `Create Debug Bundle` and follow
the wizard to upload the bundle:
The desktop app can create and optionally upload a debug bundle without using the CLI. Open **Settings → Troubleshoot**.
<p>
<img src="/docs-static/img/help/troubleshooting-client/ui-settings.png" alt="service-user-overview" className="imagewrapper-big"/>
<img src="/docs-static/img/help/troubleshooting-client/ui-settings.png" alt="Troubleshoot settings in the NetBird desktop app" className="imagewrapper-big"/>
</p>
<Note>
If needed, you can update the upload URL and select to anonymize sensitive information like IP addresses and non-netbird.io domains in logs and status output.
</Note>
<p>
<img src="/docs-static/img/help/troubleshooting-client/ui-bundle-wizard.png" alt="service-user-overview" className="imagewrapper-big"/>
</p>
By default running with trace log enable before generating the bundle is selected. This will restart the client connections and provide a `disconnect to connected` information for our engineers.
If you uncheck this option, a bundle will be generated without running this step. Which is very useful when you have an
issue that recovers when restarting the client.
Choose the data and capture behavior that fits the issue:
* **Anonymize sensitive data** masks IP addresses, domains, interface names, and peer identifiers where supported.
* **Include system information** adds routes, interfaces, resolver state, and firewall information.
* **Upload Bundle to NetBird Servers** uploads the completed archive to NetBird's fixed debug-bundle service. Disable it to keep the bundle local.
* **Enable trace logging** temporarily raises the client log level while the bundle is collected.
* **Restart connection** cycles the NetBird connection during collection. Disable it when reconnecting makes the issue disappear.
* **Capture packets** adds a packet capture while collecting new logs. Packet captures are excluded from anonymized bundles because they contain raw packets.
* **Capture duration** accepts 1–30 minutes.
<p>
<img src="/docs-static/img/help/troubleshooting-client/ui-bundle-success.png" alt="service-user-overview" className="imagewrapper-big"/>
<img src="/docs-static/img/help/troubleshooting-client/ui-bundle-wizard.png" alt="Debug bundle capture options in the NetBird desktop app" className="imagewrapper-big"/>
</p>
Once the bundle generation is complete, you can click on `Copy Key` to get the uploaded key and share with NetBird\'s team.
Click **Create debug bundle**. You can cancel while logs are being collected. When the operation finishes:
* If **Upload Bundle to NetBird Servers** is enabled, the app displays an upload key. Copy the key and share it with the NetBird team.
* If upload is disabled, the app displays the ZIP location and an **Open Folder** button.
In both cases, the ZIP is stored locally in the platform's temporary directory listed above.
<p>
<img src="/docs-static/img/help/troubleshooting-client/ui-bundle-success.png" alt="Completed debug bundle uploaded with a key in the NetBird desktop app" className="imagewrapper-big"/>
</p>
If you kept the bundle local, attach the ZIP through the support channel you are using.
### Remote debug bundle generation
@@ -758,5 +781,3 @@ For `net-tools` (`ifconfig`, `route`, `netstat` tools):
- `route -n` to find built-in `100.*.0.0/16` route,
- neither `route` nor `netstat` support viewing content of custom routing tables,