-
Notifications
You must be signed in to change notification settings - Fork 207
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Review and update client deployment documentation (#951)
Major overhaul. Significant changes include: - Reorganized content so that it better matches the sequence that users will follow. - Added Tabbed command blocks for commands where multiple platforms can be used. - Updates to macOS including additional info such as how to jump the security hurdles. - Added more info showing how to verify service installation status on each platform. - Added section for MSI repacking using the CLI. - Added section showing where to get client configs in the GUI. - Removed `--sysv` option and explained which init systems we handle. - Refreshed outdated screenshots. - Added GIF animations as they are more engaging than terminal screenshots. - Generally clarified as much as possible, added extra notes and many links to related materials. - Some spelling fixes (American spelling preferred over British). - Update image creation guidelines to include terminal session recordings. - Start work on prose style guidelines doc (in /dev). The client deployment page is really very long now and will need to be split up in future.
- Loading branch information
1 parent
459a165
commit eeb42a7
Showing
37 changed files
with
2,443 additions
and
436 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
281 changes: 281 additions & 0 deletions
281
content/docs/deployment/clients/client_config_orgs.excalidraw
Large diffs are not rendered by default.
Oops, something went wrong.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
315 changes: 315 additions & 0 deletions
315
content/docs/deployment/clients/create_msi_add.excalidraw
Large diffs are not rendered by default.
Oops, something went wrong.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
186 changes: 186 additions & 0 deletions
186
content/docs/deployment/clients/create_msi_uploaded.excalidraw
Large diffs are not rendered by default.
Oops, something went wrong.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
144 changes: 144 additions & 0 deletions
144
content/docs/deployment/clients/remote_upgrade_msi.excalidraw
Large diffs are not rendered by default.
Oops, something went wrong.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
312 changes: 312 additions & 0 deletions
312
content/docs/deployment/clients/remote_upgrade_msi_2.excalidraw
Large diffs are not rendered by default.
Oops, something went wrong.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
Output ./run_client_manual.gif | ||
# Output ./run_client_manual.mp4 | ||
|
||
# Settings: | ||
Set Shell bash | ||
Set FontSize 16 | ||
Set FontFamily "Iosevka Term" | ||
Set Height 800 | ||
Set Width 1200 | ||
Set LetterSpacing 1.0 | ||
Set LoopOffset 0 | ||
Set Theme "deep" | ||
Set PlaybackSpeed 1.0 | ||
Set Margin 0 | ||
Set Padding 20 | ||
# Set MarginFill "#ffffff" | ||
# Set BorderRadius 10 | ||
|
||
# Setup | ||
Hide | ||
Type "PS1='\[\033[1;34m\]root@computer \[\033[1;32m\]~ \[\033[1;34m\]# \[$(tput sgr0)\]'" | ||
Enter | ||
Type "alias velociraptor='velociraptor-v0.73.3-linux-amd64'" | ||
Enter | ||
Type "find /tmp -type f -iname 'Velociraptor.writeback*' -delete" | ||
Enter | ||
Type "sed -i 's|/home/me/Sync/zxcv/servers/velociraptor/datastore3|/tmp|g' ./client.config.yaml" | ||
Enter | ||
Type "clear" | ||
Enter | ||
Sleep 1s | ||
Show | ||
Sleep 1s | ||
|
||
# Type a command in the terminal. | ||
Type "velociraptor --config client.config.yaml client -v" | ||
|
||
# Pause for dramatic effect... | ||
Sleep 2s | ||
|
||
Set PlaybackSpeed 0.5 | ||
|
||
# Run the command by pressing enter. | ||
Enter | ||
|
||
Sleep 565ms | ||
Screenshot ./run_client_manual.png | ||
|
||
# Admire the output for a bit. | ||
Sleep 3s |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
Output ./wix_build.gif | ||
Output ./wix_build.mp4 | ||
|
||
# Settings: | ||
Set Shell bash | ||
Set FontSize 16 | ||
Set FontFamily "Iosevka Term" | ||
Set Height 800 | ||
Set Width 1200 | ||
Set LetterSpacing 1.0 | ||
Set LoopOffset 0 | ||
Set Theme "deep" | ||
Set PlaybackSpeed 1.0 | ||
Set Margin 0 | ||
Set Padding 20 | ||
# Set MarginFill "#ffffff" | ||
# Set BorderRadius 10 | ||
|
||
# Setup | ||
Hide | ||
Type "ssh windoze" | ||
Enter | ||
Sleep 2s | ||
Type "prompt" | ||
Enter | ||
Type "cd Downloads\wix" | ||
Enter | ||
Type "cls" | ||
Enter | ||
Sleep 1s | ||
Show | ||
|
||
Sleep 1s | ||
|
||
# Type a command in the terminal. | ||
Type "build_amd64.bat" | ||
|
||
# Pause for dramatic effect... | ||
Sleep 2s | ||
|
||
# Run the command by pressing enter. | ||
Enter | ||
|
||
Sleep 10s | ||
Screenshot ./wix_build.png | ||
|
||
# Admire the output for a bit. | ||
Sleep 10s | ||
|
||
Type "dir *.msi" | ||
Enter | ||
|
||
Sleep 2s | ||
|
||
Hide | ||
Type "exit" | ||
Enter |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.