diff --git a/public/docs-static/img/troubleshooting-client/ui-bundle-success.png b/public/docs-static/img/troubleshooting-client/ui-bundle-success.png new file mode 100644 index 00000000..b8fe6c05 Binary files /dev/null and b/public/docs-static/img/troubleshooting-client/ui-bundle-success.png differ diff --git a/public/docs-static/img/troubleshooting-client/ui-bundle-wizard.png b/public/docs-static/img/troubleshooting-client/ui-bundle-wizard.png new file mode 100644 index 00000000..1ca94e6c Binary files /dev/null and b/public/docs-static/img/troubleshooting-client/ui-bundle-wizard.png differ diff --git a/public/docs-static/img/troubleshooting-client/ui-settings.png b/public/docs-static/img/troubleshooting-client/ui-settings.png new file mode 100644 index 00000000..31384fb2 Binary files /dev/null and b/public/docs-static/img/troubleshooting-client/ui-settings.png differ diff --git a/src/pages/how-to/troubleshooting-client.mdx b/src/pages/how-to/troubleshooting-client.mdx index 528441fb..da8f8af3 100644 --- a/src/pages/how-to/troubleshooting-client.mdx +++ b/src/pages/how-to/troubleshooting-client.mdx @@ -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 + + +New in version `0.43.1`. + + +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 + + +New in version `0.43.2`. + + +You can also use the GUI `Settings` > `Create Debug Bundle` wizard to upload the bundle: + +

+ service-user-overview +

+ +

+ service-user-overview +

+ +

+ service-user-overview +

### Debug for a specific time