Documentation request
As Infection Monkey is becoming easier to contribute to we should create a more in-depth documentation section meant for devs and advanced users to quickly and easily grasp the architecture of the product.
This new page should answer questions like:
- What services is the Island comprised of? What are their responsibilities?
- What path does a request take to get from the Agent to the Island
Add a new page 🆕
What documentation you'd like us to add?
We should create a diagram that shows which machines are running which components of the product and how these components interact with each other.
After viewing this diagram, user should have a deeper knowledge that would allow him to:
- Get a head-start on contributing to infection monkey. User now knows out tech stack and what components would need to get modified to implement a specific idea/feature.
- Get a head-start on integrating his own tools. He would know what DB is used and what is stored there, what API's we have and what they do.
- Have a deeper knowledge on the product and answer questions like "why is IM opening port 5000 internally", "who is talking to who in the network and for what reason". As IM is used by security consultants, this intermediate level of knowledge would be useful for them.
Where in the documentation tree?
TBD, but initial thought is to add it to /reference/index.md
Documentation request
As Infection Monkey is becoming easier to contribute to we should create a more in-depth documentation section meant for devs and advanced users to quickly and easily grasp the architecture of the product.
This new page should answer questions like:
Add a new page 🆕
What documentation you'd like us to add?
We should create a diagram that shows which machines are running which components of the product and how these components interact with each other.
After viewing this diagram, user should have a deeper knowledge that would allow him to:
Where in the documentation tree?
TBD, but initial thought is to add it to
/reference/index.md