Skip to content

Commit 7a5c576

Browse files
committed
feat: NET-85: document the --upload-bundle feature
1 parent 48b5e27 commit 7a5c576

File tree

4 files changed

+48
-1
lines changed

4 files changed

+48
-1
lines changed
53 KB
Loading
49.4 KB
Loading
116 KB
Loading

src/pages/how-to/troubleshooting-client.mdx

Lines changed: 48 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,54 @@ names. Adding the `-S` flag will add system information like network routes and
106106
netbird debug bundle -AS
107107
```
108108

109-
This will output the path of the generated file, which can be accessed with administrative privileges.
109+
This will output the path of the generated file. The output file is owned by and can only be accessed by the user
110+
NetBird is running as, by default it is: `Administator` on Windows, `root` on MacOS/Linux or the operating system's
111+
equivalent.
112+
113+
### Debug bundle uploads
114+
115+
<Note>
116+
New in version `0.43.1`.
117+
</Note>
118+
119+
Without local administrative privileges you can still share the debug bundles with us
120+
by using the `-U` / `--upload-bundle` flag.
121+
It will securely upload the debug bundle to our servers for access by the NetBird support team.
122+
123+
```shell
124+
netbird debug bundle -AS -U
125+
```
126+
127+
This will output an `Upload file key`, which is effectively a random filename in our internal storage system
128+
and can be safely shared with us through insecure channels such as GitHub Issues or Slack.
129+
130+
```text
131+
> sudo netbird debug bundle -U
132+
Local file:
133+
/tmp/netbird.debug.2611377582.zip
134+
Upload file key:
135+
1234567890ab27fb37c88b3b4be7011e22aa2e5ca6f38ffa9c4481884941f726/12345678-90ab-cdef-1234-567890abcdef
136+
```
137+
138+
### Debug bundle uploads with GUI
139+
140+
<Note>
141+
New in version `0.43.2`.
142+
</Note>
143+
144+
You can also use the GUI `Settings` > `Create Debug Bundle` wizard to upload the bundle:
145+
146+
<p>
147+
<img src="/docs-static/img/troubleshooting-client/ui-settings.png" alt="service-user-overview" className="imagewrapper-big"/>
148+
</p>
149+
150+
<p>
151+
<img src="/docs-static/img/troubleshooting-client/ui-bundle-wizard.png" alt="service-user-overview" className="imagewrapper-big"/>
152+
</p>
153+
154+
<p>
155+
<img src="/docs-static/img/troubleshooting-client/ui-bundle-success.png" alt="service-user-overview" className="imagewrapper-big"/>
156+
</p>
110157
111158
### Debug for a specific time
112159

0 commit comments

Comments
 (0)