Added troubleshooting section to infection monkey readme and monkey_island readme.

This commit is contained in:
Ilija Lazoroski 2021-06-15 20:55:34 +02:00 committed by Mike Salvatore
parent ef3cbe51cf
commit b586bc5624
2 changed files with 38 additions and 0 deletions

View File

@ -50,6 +50,7 @@ Tested on Ubuntu 16.04.
2. Install the python packages listed in requirements.txt using pip 2. Install the python packages listed in requirements.txt using pip
- `cd [code location]/infection_monkey` - `cd [code location]/infection_monkey`
- `python3.7 -m pipenv lock -r --dev > requirements.txt`
- `python3.7 -m pip install -r requirements.txt` - `python3.7 -m pip install -r requirements.txt`
3. Build Sambacry binaries 3. Build Sambacry binaries
@ -94,3 +95,24 @@ You can either build them yourself or download pre-built binaries.
- Available here: - Available here:
- 32bit: <https://github.com/guardicore/monkey/releases/download/1.6/traceroute32> - 32bit: <https://github.com/guardicore/monkey/releases/download/1.6/traceroute32>
- 64bit: <https://github.com/guardicore/monkey/releases/download/1.6/traceroute64> - 64bit: <https://github.com/guardicore/monkey/releases/download/1.6/traceroute64>
### 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`

View File

@ -132,3 +132,19 @@
#### How to run #### How to run
1. From the `monkey` directory, run `python3.7 ./monkey_island.py` 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`