monkey/docs/content/setup/windows.md

4.0 KiB

title date draft pre weight tags
Windows 2020-05-26T20:57:10+03:00 false <i class="fab fa-windows"></i> 2
setup
windows

Deployment

{{% notice tip %}} Don't get scared if the Infection Monkey gets flagged as malware during the installation. {{% /notice %}}

After running the installer, the following prompt should appear on the screen:

Windows installer screenshot

  1. Follow the steps to complete the installation.
  2. Run the Monkey Island by clicking on the desktop shortcut.

{{% notice info %}} If you're prompted to delete your data directory and you're not sure what to do, see the [FAQ]({{< ref "/faq/#i-updated-to-a-new-version-of-the-infection-monkey-and-im-being-asked-to-delete-my-existing-data-directory-why"

}}) for more information. {{% /notice %}}

Configuring the server

You can configure the server by editing the configuration file located in installation directory. The default path is C:\Program Files\Guardicore\Monkey Island\monkey\monkey_island\cc\server_config.json.

Start Monkey Island with user-provided certificate

By default, Infection Monkey comes with a self-signed SSL certificate. In enterprise or other security-sensitive environments, it is recommended that the user provide Infection Monkey with a certificate that has been signed by a private certificate authority.

  1. Stop the Monkey Island process.
  2. (Optional but recommended) Move your .crt and .key files to %AppData%\monkey_island.
  3. Modify the server_config.json (by default located in C:\Program Files\Guardicore\Monkey Island\monkey\monkey_island\cc\server_config.json) by adding the following lines:
    {
      ...
      "ssl_certificate": {
            "ssl_certificate_file": "%AppData%\\monkey_island\\my_cert.crt",
            "ssl_certificate_key_file": "%AppData%\\monkey_island\\my_key.key"
      },
      ...
    }
    
  4. Run the Monkey Island by clicking on the desktop shortcut.
  5. Access the Monkey Island web UI by pointing your browser at https://localhost:5000.

Change logging level

  1. Stop the Island server.
  2. Modify the server_config.json (by default located in C:\Program Files\Guardicore\Monkey Island\monkey\monkey_island\cc\server_config.json) by adding the following lines:
    {
        ...
        "log_level": "INFO",
        ...
    }
    
  3. Run the Monkey Island by clicking on the desktop shortcut.
  4. Access the Monkey Island web UI by pointing your browser at https://localhost:5000.

Troubleshooting

Support

Only English system locale is supported. If your command prompt gives output in a different language, the Infection Monkey is not guaranteed to work.

For supported Windows versions, take a look at the OS support page.

Missing Windows update

The installer requires Windows update #2999226. If you're having trouble running the installer, please make sure to install the update via Windows Update or manually from the link above.

Supported browsers

The Monkey Island supports Chrome (and Chrome-based) browsers. If your Windows server only has Internet Explorer installed, please install Chrome or a similar modern browser. You can download Google Chrome here.

Upgrading

To upgrade the Infection Monkey on Windows, download the new installer and run it. The new Monkey version will be installed over the old version.

If you'd like to keep your existing configuration, you can export it to a file using the Export config button and then import it to the new Monkey Island.

Export configuration