diff --git a/monkey/infection_monkey/readme.md b/monkey/infection_monkey/readme.md index 63029a62b..d52091595 100644 --- a/monkey/infection_monkey/readme.md +++ b/monkey/infection_monkey/readme.md @@ -50,6 +50,7 @@ Tested on Ubuntu 16.04. 2. Install the python packages listed in requirements.txt using pip - `cd [code location]/infection_monkey` + - `python3.7 -m pipenv lock -r --dev > requirements.txt` - `python3.7 -m pip install -r requirements.txt` 3. Build Sambacry binaries @@ -94,3 +95,24 @@ You can either build them yourself or download pre-built binaries. - Available here: - 32bit: - 64bit: + + + +### Troubleshooting + +Some of the possible errors that may come up while trying to build the infection monkey: + +#### Linux + +When committing your changes for the first time, you may encounter some errors thrown by the pre-commit hooks. This is most likely because some python dependencies are missing from your system. +To resolve this, use `pipenv` to create a `requirements.txt` for both the `infection_monkey/` and `monkey_island/` requirements and install it with `pip`. + + - `cd [code location]/infection_monkey` + - `python3.7 -m pipenv lock -r --dev > requirements.txt` + - `python3.7 -m pip install -r requirements.txt` + + and + + - `cd [code location]/monkey_island` + - `python3.7 -m pipenv lock -r --dev > requirements.txt` + - `python3.7 -m pip install -r requirements.txt` diff --git a/monkey/monkey_island/readme.md b/monkey/monkey_island/readme.md index 4351dacff..8de0a49a9 100644 --- a/monkey/monkey_island/readme.md +++ b/monkey/monkey_island/readme.md @@ -132,3 +132,19 @@ #### How to run 1. From the `monkey` directory, run `python3.7 ./monkey_island.py` + + +#### Troubleshooting + +When committing your changes for the first time, you may encounter some errors thrown by the pre-commit hooks. This is most likely because some python dependencies are missing from your system. +To resolve this, use `pipenv` to create a `requirements.txt` for both the `infection_monkey/` and `monkey_island/` requirements and install it with `pip`. + + - `cd [code location]/infection_monkey` + - `python3.7 -m pipenv lock -r --dev > requirements.txt` + - `python3.7 -m pip install -r requirements.txt` + + and + + - `cd [code location]/monkey_island` + - `python3.7 -m pipenv lock -r --dev > requirements.txt` + - `python3.7 -m pip install -r requirements.txt`