sendnrw/netbird-docs
2
0
Fork 0
mirror of https://github.com/netbirdio/docs.git synced 2026-04-16 15:36:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: NET-85: document the --upload-bundle feature (#316)

Browse Source
This commit is contained in:
Krzysztof Nazarewski (kdn)
2025-05-13 09:26:06 +02:00
committed by GitHub
parent 4743997944
commit eb6589c3ef
4 changed files with 48 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
src/pages/how-to/troubleshooting-client.mdx
View File

@@ -106,7 +106,54 @@ names. Adding the `-S` flag will add system information like network routes and
netbird debug bundle -AS
```
This will output the path of the generated file, which can be accessed with administrative privileges.
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.
### Debug bundle uploads
<Note>
New in version `0.43.1`.
</Note>
Without local administrative privileges you can still share the debug bundles with us
by using the `-U` / `--upload-bundle` flag.
It will securely upload the debug bundle to our servers for access by the NetBird support team.
```shell
netbird debug bundle -AS -U
```
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 insecure channels such as GitHub Issues or Slack.
```text
> sudo netbird debug bundle -U
Local file:
/tmp/netbird.debug.2611377582.zip
Upload file key:
1234567890ab27fb37c88b3b4be7011e22aa2e5ca6f38ffa9c4481884941f726/12345678-90ab-cdef-1234-567890abcdef
```
### Debug bundle uploads with GUI
<Note>
New in version `0.43.2`.
</Note>
You can also use the GUI `Settings` > `Create Debug Bundle` wizard to upload the bundle:
<p>
<img src="/docs-static/img/troubleshooting-client/ui-settings.png" alt="service-user-overview" className="imagewrapper-big"/>
</p>
<p>
<img src="/docs-static/img/troubleshooting-client/ui-bundle-wizard.png" alt="service-user-overview" className="imagewrapper-big"/>
</p>
<p>
<img src="/docs-static/img/troubleshooting-client/ui-bundle-success.png" alt="service-user-overview" className="imagewrapper-big"/>
</p>
### Debug for a specific time