Skip to content

Commit 4a08665

Browse files
feat: add a simple viewer script to the generated support bundle (#122)
Other changes: - deploy the script during build phase - update documentation f61c97a
1 parent 2ec52cc commit 4a08665

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

reporting-issues.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
# Generating Bundle
12
To generate a support bundle for reporting issues with either debugger or the full ODRD/LMFS solution run the following commands:
23

34
```
@@ -9,3 +10,27 @@ tar -czf support-dump.tgz build
910
```
1011

1112
The generated support-dump.tgz file can be included in bug reports & communication with support.
13+
14+
# Viewing Bundle
15+
16+
The view-bundle.sh script starts a simple webserver and attempts to open a browser window with the
17+
correct url (including specifying a valid API key).
18+
19+
```
20+
tar -xzf support-dump.tgz
21+
cd build
22+
./view-bundle.sh
23+
```
24+
25+
Note that any simple http server can be used to serve the index.html file in the build directior. The following
26+
would suffice:
27+
```
28+
python3 -m http.server
29+
```
30+
31+
# Viewing bundle with newer version of the debugger
32+
33+
The data used in the debugger is contained within the data.json file. This file can be copied
34+
out of support bundle and placed in the 'public' directory of a fleet-debugger github repo.
35+
Once copied, 'npm start' in the fleet-debugger repo will let this bundle be viewed with the
36+
newer UI.

0 commit comments

Comments
 (0)