diff --git a/README.md b/README.md index 77631e9ef..eac517183 100644 --- a/README.md +++ b/README.md @@ -64,13 +64,19 @@ These plugins are ready to use but are not included by default and are not maint These requirements are for the computer running the core framework: * Any Linux or MacOS -* Python 3.9+ (with Pip3) + * Python 3.10+ (with Pip3) * Recommended hardware to run on is 8GB+ RAM and 2+ CPUs -* Recommended: GoLang 1.17+ to dynamically compile GoLang-based agents. +* Recommended: [GoLang 1.24+](https://go.dev/doc/install) to dynamically compile GoLang-based agents. * NodeJS (v16+ recommended for v5 VueJS UI) ## Installation +Note: we HIGHLY recommend installing Caldera in a Python virtual environment to avoid issues with pip packages. You can use an existing environment if you wish or create a new one from scratch: +```Bash +python3 -m venv .calderavenv +source .calderavenv/bin/activate +``` + Concise installation steps: ```Bash git clone https://github.com/mitre/caldera.git --recursive @@ -89,7 +95,6 @@ Next, install the PIP requirements: ```Bash pip3 install -r requirements.txt ``` -**Super-power your Caldera server installation! [Install GoLang (1.19+)](https://go.dev/doc/install)** Finally, start the server. ```Bash