diff --git a/docs/content/_index.md b/docs/content/_index.md index 0f61ab72c..90e7cef56 100644 --- a/docs/content/_index.md +++ b/docs/content/_index.md @@ -15,12 +15,12 @@ The Infection Monkey is comprised of two parts: * Monkey - A tool which infects other machines and propagates to them * Monkey Island - A dedicated UI to visualize the Infection Monkey's progress inside the data center -To read more about the Monkey and download it, visit [our homepage](https://www.guardicore.com/infectionmonkey/). +To read more about the Monkey and download it, visit [our homepage](https://infectionmonkey.com/). ## Getting Started -If you haven't downloaded Infection Monkey yet you can do so [from our homepage](infectionmonkey.com). After downloadling the Monkey, install it using one of our [setup guides](setup), and read our [getting started guide](usage/getting-started) for a quick-start on Monkey! +If you haven't downloaded Infection Monkey yet you can do so [from our homepage](https://infectionmonkey.com/). After downloadling the Monkey, install it using one of our [setup guides](setup), and read our [getting started guide](usage/getting-started) for a quick-start on Monkey! ## Support and community -If you need help or want to talk all things Monkey, you can [join our public Slack workspace](https://join.slack.com/t/infectionmonkey/shared_invite/enQtNDU5MjAxMjg1MjU1LWM0NjVmNWE2ZTMzYzAxOWJiYmMxMzU0NWU3NmUxYjcyNjk0YWY2MDkwODk4NGMyNDU4NzA4MDljOWNmZWViNDU) or [contact us via email](mailto:support@infectionmonkey.com). +If you need help or want to talk all things Monkey, you can [join our public Slack workspace](https://join.slack.com/t/infectionmonkey/shared_invite/enQtNDU5MjAxMjg1MjU1LWM0NjVmNWE2ZTMzYzAxOWJiYmMxMzU0NWU3NmUxYjcyNjk0YWY2MDkwODk4NGMyNDU4NzA4MDljOWNmZWViNDU) or [contact us via Email](mailto:support@infectionmonkey.com). diff --git a/docs/content/development/adding-system-info-collectors.md b/docs/content/development/adding-system-info-collectors.md new file mode 100644 index 000000000..9bc404d7c --- /dev/null +++ b/docs/content/development/adding-system-info-collectors.md @@ -0,0 +1,6 @@ +--- +title: "Adding System Info Collectors" +date: 2020-06-09T11:03:42+03:00 +draft: true +--- + diff --git a/docs/content/setup/_index.md b/docs/content/setup/_index.md index a48b839ba..89100cde1 100644 --- a/docs/content/setup/_index.md +++ b/docs/content/setup/_index.md @@ -4,12 +4,14 @@ date = 2020-05-26T20:55:04+03:00 weight = 5 chapter = true pre = ' ' -tags = ["setup", "windows"] +tags = ["setup"] +++ # Setting up Infection Monkey -Setting up Infection Monkey is really easy! First, you need to [download the Infection Monkey from our site](infectionmonkey.com). We have different setup guides for different environments. +Setting up Infection Monkey is really easy! First, you need to [download the Infection Monkey from our site](https://infectionmonkey.com/). + +Once you've downloaded an installer, you can follow the relevant guide for your environment: {{% children %}} diff --git a/docs/content/setup/aws.md b/docs/content/setup/aws.md index db287e960..48142114d 100644 --- a/docs/content/setup/aws.md +++ b/docs/content/setup/aws.md @@ -9,7 +9,7 @@ tags: ["setup", "aws"] ## Deployment -On the Infection Monkey’s AWS Marketplace page, click **Continue to Subscribe**. +On the [Infection Monkey’s AWS Marketplace page](https://aws.amazon.com/marketplace/pp/GuardiCore-Infection-Monkey/B07B3J7K6D), click **Continue to Subscribe**. 1. Choose the desired region. 1. Choose an EC2 instance type with at least 1GB of RAM for optimal performance or stick with the recommended. @@ -27,3 +27,9 @@ When ready, you can browse to the Infection Monkey running on your fresh deploy You will be presented a login page. Use the username **monkey**, and the new EC2 instace’s instance ID for password. You can find the instance id by going to the EC2 console and selecting your instance. It should appear in the details pane below. ![AWS instance ID](../../images/setup/aws/aws-instance-id.png "AWS instance ID") + +## Upgrading + +Currently there's no "upgrade-in-place" option when a new version comes out. To get the new version, you can deploy a new machine from the marketplace. If you'd like to keep your existing configuration, you can export it to a file by using the Export button and then import it to the new Monkey Island. + +![Export configuration](../../images/setup/export-configuration.png "Export configuration") diff --git a/docs/content/setup/azure.md b/docs/content/setup/azure.md index 4fafcbe69..a4a2eda84 100644 --- a/docs/content/setup/azure.md +++ b/docs/content/setup/azure.md @@ -26,3 +26,9 @@ Select [Infection Monkey from the Azure Marketplace](https://azuremarketplace.mi At this point, Azure will instance and deploy your new machine. When ready, you can browse to the Infection Monkey running on your fresh deployment at: `https://{public-ip-address}:5000` + +## Upgrading + +Currently there's no "upgrade-in-place" option when a new version comes out. To get the new version, you can deploy a new machine from the marketplace. If you'd like to keep your existing configuration, you can export it to a file by using the Export button and then import it to the new Monkey Island. + +![Export configuration](../../images/setup/export-configuration.png "Export configuration") diff --git a/docs/content/setup/debian.md b/docs/content/setup/debian.md index 3eeb94fcb..b91bdb74c 100644 --- a/docs/content/setup/debian.md +++ b/docs/content/setup/debian.md @@ -54,3 +54,11 @@ sudo apt install -f ### The Monkey Island interface isn't accessible after installation To check the status of the Monkey Island after the installation, run the following command: `sudo service monkey-island status`. + +## Upgrading + +To upgrade when a new version comes out, download the new Monkey `.deb` file and install it. You should see a message like `Unpacking monkey-island (1.8.2) over (1.8.0)`. After which, the installation should complete successfully. + +If you'd like to keep your existing configuration, you can export it to a file by using the Export button and then import it to the new server. + +![Export configuration](../../images/setup/export-configuration.png "Export configuration") diff --git a/docs/content/setup/docker.md b/docs/content/setup/docker.md index 36657b156..8d63eeaea 100644 --- a/docs/content/setup/docker.md +++ b/docs/content/setup/docker.md @@ -20,3 +20,11 @@ sudo mkdir -p /var/monkey-mongo/data/db sudo docker run --name monkey-mongo --network=host -v /var/monkey-mongo/data/db:/data/db -d mongo sudo docker run --name monkey-island --network=host -d guardicore/monkey-island:1.8.2 ``` + +## Upgrading + +There's no "upgrade-in-place" option for Docker. To get the new version, download it, stop the current container, and run the installation commands again with the new file. + +If you'd like to keep your existing configuration, you can export it to a file by using the Export button and then import it to the new server. + +![Export configuration](../../images/setup/export-configuration.png "Export configuration") diff --git a/docs/content/setup/vmware.md b/docs/content/setup/vmware.md index 7274b2eff..5ee958188 100644 --- a/docs/content/setup/vmware.md +++ b/docs/content/setup/vmware.md @@ -52,3 +52,11 @@ username `root` and password `G3aJ9szrvkxTmfAG`. After logging in, edit the inte ```sh sudo ifdown ens160 && ifup ens160 ``` + +## Upgrading + +There's no "upgrade-in-place" option for Docker. To get the new version, download it, stop the current container, and run the installation commands again with the new file. + +If you'd like to keep your existing configuration, you can export it to a file by using the Export button and then import it to the new server. + +![Export configuration](../../images/setup/export-configuration.png "Export configuration") diff --git a/docs/content/setup/windows.md b/docs/content/setup/windows.md index ad46ca2cf..d8a6c84e9 100644 --- a/docs/content/setup/windows.md +++ b/docs/content/setup/windows.md @@ -25,3 +25,11 @@ The installer requires [Windows update #2999226](https://support.microsoft.com/e ### Supported browsers The Monkey Island supports Chrome (and Chrome-based) browsers. Some Windows Servers only have Internet Explorer installed. Make sure to use Chrome or a similar modern browser. [You can download Google Chrome from here](https://www.google.com/chrome/). + +## Upgrading + +To upgrade, download the new installer and run it. The new Monkey version should be installed over the old one. + +If you'd like to keep your existing configuration, you can export it to a file by using the Export button and then import it to the new server. + +![Export configuration](../../images/setup/export-configuration.png "Export configuration") diff --git a/docs/content/usage/configuration/_index.md b/docs/content/usage/configuration/_index.md new file mode 100644 index 000000000..3a94a38f2 --- /dev/null +++ b/docs/content/usage/configuration/_index.md @@ -0,0 +1,13 @@ +--- +title: "Configuration" +date: 2020-06-07T19:08:51+03:00 +draft: false +chapter: true +weight: 3 +--- + +The Monkey is very configurable, nearly every part of it can be modified to turn it to a fast acting worm or into a port scanning and system information collecting machine. + +See these documentation pages for information on each configuration value: + +{{% children description=true %}} diff --git a/docs/content/usage/configuration/basic-credentials.md b/docs/content/usage/configuration/basic-credentials.md new file mode 100644 index 000000000..10102f860 --- /dev/null +++ b/docs/content/usage/configuration/basic-credentials.md @@ -0,0 +1,8 @@ +--- +title: "Credentials" +date: 2020-06-09T12:20:08+03:00 +draft: false +description: "Configure credentials that the Monkey uses for propagation" +--- + +In this screen you can feed the Monkey with “stolen” credentials for your network, simulating an attacker with inside knowledge. diff --git a/docs/content/usage/configuration/basic-network.md b/docs/content/usage/configuration/basic-network.md new file mode 100644 index 000000000..bee2a10b2 --- /dev/null +++ b/docs/content/usage/configuration/basic-network.md @@ -0,0 +1,12 @@ +--- +title: "Network" +date: 2020-06-09T12:20:14+03:00 +draft: false +description: "Configure settings related to the Monkey's network activity" +--- + +Here you can control multiple important settings, such as: + +* Network propagation depth - How many hops from the base machine will the Monkey spread +* Local network scan - Should the Monkey attempt to attack any machine in its subnet +* Scanner IP/subnet list - Specific IP ranges that the Monkey should try to attack. diff --git a/docs/content/usage/file-checksums.md b/docs/content/usage/file-checksums.md index 3c02928cb..fd0849d3c 100644 --- a/docs/content/usage/file-checksums.md +++ b/docs/content/usage/file-checksums.md @@ -5,7 +5,7 @@ draft: true weight: 100 --- -The official distribution of Infection Monkey is compiled and supplied by Guardicore ([download from our official site here](infectionmonkey.com)). The team signs all software packages to certify that a particular Infection Monkey package is a valid and unaltered Infection Monkey release. Before installing Monkey, you should validate the package using the SHA-256 checksum. +The official distribution of Infection Monkey is compiled and supplied by Guardicore ([download from our official site here](https://infectionmonkey.com/)). The team signs all software packages to certify that a particular Infection Monkey package is a valid and unaltered Infection Monkey release. Before installing Monkey, you should validate the package using the SHA-256 checksum. ## How to get SHA-256 checksum diff --git a/docs/content/usage/how-to-configure-the-monkey.md b/docs/content/usage/how-to-configure-the-monkey.md deleted file mode 100644 index a89e7ed8b..000000000 --- a/docs/content/usage/how-to-configure-the-monkey.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: "How to Configure the Monkey" -date: 2020-06-07T19:08:51+03:00 -draft: false -weight: 3 ---- - -The Monkey is very configurable, nearly every part of it can be modified to turn it to a fast acting worm or into a port scanning and system information collecting machine. - -The configuration is split into two parts, **Basic** and everything else. The **Basic** options are pretty self explanatory and are split into two sections: - -## Credentials - -In this screen you can feed the Monkey with “stolen” credentials for your network, simulating an attacker with inside knowledge. - -## Network - -Here you can control multiple important settings, such as: - -* Network propagation depth - How many hops from the base machine will the Monkey spread -* Local network scan - Should the Monkey attempt to attack any machine in its subnet -* Scanner IP/subnet list - Specific IP ranges that the Monkey should try to attack. diff --git a/docs/static/images/setup/export-configuration.png b/docs/static/images/setup/export-configuration.png new file mode 100644 index 000000000..542e30a95 Binary files /dev/null and b/docs/static/images/setup/export-configuration.png differ diff --git a/docs/themes/learn b/docs/themes/learn index 681260ff5..1a641ac78 160000 --- a/docs/themes/learn +++ b/docs/themes/learn @@ -1 +1 @@ -Subproject commit 681260ff572608d039323c3763a685ee3c14c7e3 +Subproject commit 1a641ac78945b45d4e9274a4b8bfe445e0e9eae5