diff --git a/docs/content/development/adding-post-breach-actions.md b/docs/content/development/adding-post-breach-actions.md index 033a6118c..659bb9473 100644 --- a/docs/content/development/adding-post-breach-actions.md +++ b/docs/content/development/adding-post-breach-actions.md @@ -16,7 +16,7 @@ If all you want to do is execute shell commands, then there's no need to add a n ## How to add a new PBA -### From the Infection Monkey Side +### Modify the Infection Monkey Agent #### Framework @@ -43,7 +43,7 @@ If your PBA consists only of simple shell commands, you can reuse the generic PB Otherwise, you'll need to override the `run` method with your own implementation. See the `communicate_as_new_user.py` PBA for reference. Make sure to send the relevant PostBreachTelem upon success/failure. You can log during the PBA as well. -### From the Monkey Island Side +### Modify the Monkey Island #### Configuration diff --git a/docs/content/development/adding-system-info-collectors.md b/docs/content/development/adding-system-info-collectors.md index 7a50f32b5..71cea6000 100644 --- a/docs/content/development/adding-system-info-collectors.md +++ b/docs/content/development/adding-system-info-collectors.md @@ -16,7 +16,7 @@ If all you want to do is execute a shell command, then there's no need to add a ## How to add a new System Info Collector -### From the Infection Monkey Side +### Modify the Infection Monkey Agent #### Framework @@ -41,7 +41,7 @@ class MyNewCollector(SystemInfoCollector): Override the `collect` method with your own implementation. See the `EnvironmentCollector.py` System Info Collector for reference. You can log during collection as well. -### From the Monkey Island Side +### Modify the Monkey Island #### Configuration diff --git a/docs/content/development/setup-development-environment.md b/docs/content/development/setup-development-environment.md index ad9a4675b..f2e739f3a 100644 --- a/docs/content/development/setup-development-environment.md +++ b/docs/content/development/setup-development-environment.md @@ -10,7 +10,7 @@ tags: ["contribute"] To set up a development environment using scripts, look at the readme under [`/deployment_scripts`](https://github.com/guardicore/monkey/blob/develop/deployment_scripts). If you want to set it up manually or run into problems, keep reading. -## Agent +## The Infection Monkey Agent The agent (which we sometimes refer to as the Infection Monkey) is a single Python project under the [`infection_monkey`](https://github.com/guardicore/monkey/blob/master/monkey/infection_monkey) folder. The Infection Monkey agent was built for Python 3.7. You can get it up and running by setting up a [virtual environment](https://docs.python-guide.org/dev/virtualenvs/) and installing the requirements listed in the [`requirements.txt`](https://github.com/guardicore/monkey/blob/master/monkey/infection_monkey/requirements.txt) inside it.