Update user guide (#194)

* upgrade cypress * update pics * more image update * changehostcolor screenshot * update beacon color and shape screenshot
cisagov · Sep 21, 2023 · d183b3c · d183b3c
1 parent cf403c7
commit d183b3c
Show file tree

Hide file tree

Showing 20 changed files with 50 additions and 21 deletions.
diff --git a/docs/UserGuide.md b/docs/UserGuide.md
@@ -61,9 +61,9 @@ Once logged in, you will be directed to the campaign cards screen. This is where
 
 ### **Uploading Campaigns**
 
-Redeye provides two ways to upload and visualize your campaign data.
+Redeye provides three ways to upload and visualize your campaign data.
 
-#### Server Folders (Multi\-Server and Single\-Server)
+#### Cobalt Strike
 
 <p align="center">
 <img src="https://github.com/cisagov/RedEye/blob/develop/docs/images/UploadServerFolders.png?raw=true" width="55%" />
@@ -72,7 +72,15 @@ Redeye provides two ways to upload and visualize your campaign data.
 When uploading multi-server or single-server folders, RedEye will automatically remove files that are\
 not necessary. To view a list of all the files that were removed, hover over the "File Removed" icon.
 
-#### Database Files
+#### Brute Ratel
+
+<p align="center">
+<img src="https://github.com/cisagov/RedEye/blob/develop/docs/images/UploadDBFiles.png?raw=true" width="55%" />
+</p>
+
+Upload, parse and visualize your Brute Ratel campaigns with this option.
+
+#### .Redeye File
 
 <p align="center">
 <img src="https://github.com/cisagov/RedEye/blob/develop/docs/images/UploadDBFiles.png?raw=true" width="55%" />
@@ -138,6 +146,14 @@ All beacons and the total number of commands executed by the beacon are displaye
 <img src="https://github.com/cisagov/RedEye/blob/develop/docs/images/BeaconsTab.png?raw=true" width="65%"/>
 </p>
 
+### Command Types Tab
+
+The Command Types tab displays a list of all commands and the number of times the command was executed by the beacons in the campaign.
+
+<p align="center">
+<img src="https://github.com/cisagov/RedEye/blob/develop/docs/images/CommandTypesTab.png?raw=true" width="75%"/>
+</p>
+
 #### Selecting Beacon from List
 
 Select a beacon from the Beacons Tab to find out more information, such as the commands, operators, comments, and metadata that it is associated with.
@@ -163,7 +179,7 @@ Within the new comment modal, you can favorite this comment, add a tag, and comm
 the command.
 
 <p align="center">
-<img src="https://github.com/cisagov/RedEye/blob/develop/docs/images/AddNewCommets.png?raw=true" width="85%"/>
+<img src="https://github.com/cisagov/RedEye/blob/develop/docs/images/AddNewComments.png?raw=true" width="85%"/>
 </p>
 
 #### Multi-Command Comment
@@ -180,14 +196,6 @@ Use the multi-command comment function to group multiple commands with one comme
 <img src="https://github.com/cisagov/RedEye/blob/develop/docs/images/AddCommandExistingComment.png?raw=true" width="75%"/>
 </p>
 
-### Command Types Tab
-
-The Command Types tab displays a list of all commands and the number of times the command was executed by the beacons in the campaign.
-
-<p align="center">
-<img src="https://github.com/cisagov/RedEye/blob/develop/docs/images/CommandTypesTab.png?raw=true" width="75%"/>
-</p>
-
 ### Timeline
 
 The timeline located above the graph provides users the ability to:
@@ -219,7 +227,21 @@ To display or hide beacons, check or uncheck the "Show Hidden Beacons, Host, and
 <img src="https://github.com/cisagov/RedEye/blob/develop/docs/images/ChangeHideBeacon.png?raw=true"  width="75%"/>
 </p>
 
-&nbsp;
+### Light Theme
+
+This toggle enables light theme mode for RedEye.
+
+<p align="center">
+<img src="https://github.com/cisagov/RedEye/blob/develop/docs/images/LightThemeMode.png?raw=true"  width="75%"/>
+</p>
+
+### Redacted Screenshot Mode
+
+When toggled, RedEye makes text unreadable in order to provide secure screenshots.
+
+<p align="center">
+<img src="https://github.com/cisagov/RedEye/blob/develop/docs/images/RedactedScreenShot.png?raw=true"  width="75%"/>
+</p>
 
 ### Graph
 

diff --git a/docs/images/AddCommandExistingComment.png b/docs/images/AddCommandExistingComment.png
diff --git a/docs/images/AddNewComments.png b/docs/images/AddNewComments.png
diff --git a/docs/images/AddNewCommets.png b/docs/images/AddNewCommets.png
diff --git a/docs/images/BeaconsTab.png b/docs/images/BeaconsTab.png
diff --git a/docs/images/ChangeHostColor.png b/docs/images/ChangeHostColor.png
diff --git a/docs/images/CommandTypesTab.png b/docs/images/CommandTypesTab.png
diff --git a/docs/images/CommentsTab.png b/docs/images/CommentsTab.png
diff --git a/docs/images/GraphControls.png b/docs/images/GraphControls.png
diff --git a/docs/images/HostsTab.png b/docs/images/HostsTab.png
diff --git a/docs/images/LightThemeMode.png b/docs/images/LightThemeMode.png
diff --git a/docs/images/Presentation Selection.png b/docs/images/Presentation Selection.png
diff --git a/docs/images/Presentation View.png b/docs/images/Presentation View.png
diff --git a/docs/images/RedactedScreenShot.png b/docs/images/RedactedScreenShot.png
diff --git a/docs/images/UpdateBeaconColorShape.png b/docs/images/UpdateBeaconColorShape.png
diff --git a/docs/images/UploadBruteRatel.png b/docs/images/UploadBruteRatel.png
diff --git a/docs/images/UploadCobaltStrike.png b/docs/images/UploadCobaltStrike.png
diff --git a/docs/images/UploadRedEyeFile.png b/docs/images/UploadRedEyeFile.png
diff --git a/package.json b/package.json
@@ -150,7 +150,7 @@
 		"builder-util": "^23.0.2",
 		"concurrently": "^8.0.1",
 		"cross-env": "^7.0.3",
-		"cypress": "^13.0.0",
+		"cypress": "^13.2.0",
 		"cypress-map": "^1.19.1",
 		"cypress-multi-reporters": "^1.6.1",
 		"cypress-real-events": "^1.7.6",

diff --git a/yarn.lock b/yarn.lock
@@ -4025,13 +4025,20 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@types/node@npm:^16.18.39, @types/node@npm:^16.9.2":
+"@types/node@npm:^16.9.2":
   version: 16.18.40
   resolution: "@types/node@npm:16.18.40"
   checksum: a683930491b4fd7cb2dc7684e32bbeedc4a83fb1949a7b15ea724fbfaa9988cec59091f169a3f1090cb91992caba8c1a7d50315b2c67c6e2579a3788bb09eec4
   languageName: node
   linkType: hard
 
+"@types/node@npm:^18.17.5":
+  version: 18.17.18
+  resolution: "@types/node@npm:18.17.18"
+  checksum: 59cbd906363d37017fe9ba0c08c1446e440d4d977459609c5f90b8fb7eb41f273ce8af30c5a5b5d599d7de934c1b3702bc9fc27caf8d2270e5cdb659c5232991
+  languageName: node
+  linkType: hard
+
 "@types/nodemon@npm:^1.19.0":
   version: 1.19.2
   resolution: "@types/nodemon@npm:1.19.2"
@@ -6638,13 +6645,13 @@ __metadata:
   languageName: node
   linkType: hard
 
-"cypress@npm:^13.0.0":
-  version: 13.0.0
-  resolution: "cypress@npm:13.0.0"
+"cypress@npm:^13.2.0":
+  version: 13.2.0
+  resolution: "cypress@npm:13.2.0"
   dependencies:
     "@cypress/request": ^3.0.0
     "@cypress/xvfb": ^1.2.4
-    "@types/node": ^16.18.39
+    "@types/node": ^18.17.5
     "@types/sinonjs__fake-timers": 8.1.1
     "@types/sizzle": ^2.3.2
     arch: ^2.2.0
@@ -6687,7 +6694,7 @@ __metadata:
     yauzl: ^2.10.0
   bin:
     cypress: bin/cypress
-  checksum: 223dddfd85dbde5e3a915e87b6cb176b99a9e5bcc24baa40cd5b9ca4a93315a95cf53c5c6ac3a6984f59be55ffc8b58b93a713c0ddcb63a5f4996229cce70329
+  checksum: 7647814f07626bd63e7b8dc4d066179fa40bf492c588bbc2626d983a2baab6cb77c29958dc92442f277e0a8e94866decc51c4de306021739c47e32baf5970219
   languageName: node
   linkType: hard
 
@@ -14879,7 +14886,7 @@ __metadata:
     cors: ^2.8.5
     cross-env: ^7.0.3
     crypto-js: ^4.0.0
-    cypress: ^13.0.0
+    cypress: ^13.2.0
     cypress-map: ^1.19.1
     cypress-multi-reporters: ^1.6.1
     cypress-real-events: ^1.7.6