From c059e2bf4d0050f7e08b38944c1065c2fde4d278 Mon Sep 17 00:00:00 2001 From: Dan Fedele Date: Mon, 7 Nov 2022 11:28:13 -0500 Subject: Bugfixes and more documentation --- README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index d8e3368..c4b1f2e 100644 --- a/README.md +++ b/README.md @@ -6,12 +6,22 @@ And if you don't like my modifications, I encourage you to fork this repo and ma ## Usage If you just started up a new instance of **Kali**, to get it to a "proper working setup" that I've come to like, simply run the following command from a terminal: -`git clone https://github.com/AgroDan/golden-kali.git && sudo bash ./golden-kali/setup.sh` +```bash +git clone https://github.com/AgroDan/golden-kali.git && sudo bash ./golden-kali/setup.sh +``` -The previous command used to be a `curl` instruction piped to `bash`. I changed that to a `git clone` instead to change up the way files would be included. It was cleaner and I was able to mess around with. I may be installing malicious software, but I wish no mal-intent to you. Peace, love, and hack all the things. +The previous command used to be a `curl` instruction piped to `bash`. I changed that to a `git clone` instead to change up the way files would be included. It was cleaner and I was able to mess around with ansible's conditional logic a bit more. Note you are still allowing code to execute as the root user to install various tools that *I personally* find very useful. They may not be what you find useful, they may not be what you prefer. Please review the code above as it is all open source for your assurance. Know this: I may be installing malicious software, but I wish no mal-intent to you. Peace, love, and hack all the things. ## Changelog I made some significant changes to this repository from the previous iteration. First, the name has been changed to `golden-kali`. Second, I have removed support for ParrotOS. It's generally something I don't use all that often to support it, so this is what you have. I'm sure you can apply all of the ideas here for a ParrotOS build as well if that's your thing. -Many of the changes here came as a result of this repository being included as a necessary install step process for the Red Team at [DoE's Cyberforce Competition](https://cyberforce.energy.gov/cyberforce-competition/) in 2022. The code was modified heavily for the event's exhaustive playbook. I took what I had learned there and simply applied it here. \ No newline at end of file +Many of the changes here came as a result of this repository being included as a necessary install step process for the Red Team at [DoE's Cyberforce Competition](https://cyberforce.energy.gov/cyberforce-competition/) in 2022. The code was modified heavily for the event's exhaustive playbook. I took what I had learned there and simply applied it here. + +## Caveat Emptor + +Through exhaustive testing and re-testing, we have determined that this will install approximately XX Gigabytes of data onto your Kali machine. It is advised that you have at least YY Gigabytes free before running this installer! + +Despite all of our efforts, no one has been able to get this script to work on Apple's M1 architecture. This is for AMD64 only. Sorry! + +This script takes a _long_ time to complete. The longest step is patching and updating the machine before executing any of the plays. It is advised for your own sanity to ensure that your machine is patched to the latest before running this script. \ No newline at end of file -- cgit v1.2.3