From d287573806ff5924ffcbb0219cc25e7a1e0c2302 Mon Sep 17 00:00:00 2001 From: Mike Salvatore Date: Thu, 10 Jun 2021 12:59:32 -0400 Subject: [PATCH] docs: Add instructions for user-provided certs to windows setup --- docs/content/setup/windows.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/docs/content/setup/windows.md b/docs/content/setup/windows.md index ef516bc24..17423e4a5 100644 --- a/docs/content/setup/windows.md +++ b/docs/content/setup/windows.md @@ -16,6 +16,39 @@ After running the installer, the following prompt should appear on the screen: 1. Follow the steps to complete the installation. 1. Run the Monkey Island by clicking on the desktop shortcut. +### Start Monkey Island with user-provided certificcate + +By default, Infection Monkey comes with a [self-signed SSL certificate](https://aboutssl.org/what-is-self-sign-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. If you haven't already, run the Monkey Island by clicking on the desktop + shortcut. This will populate MongoDB, as well as create and populate + `%AppData%\monkey_island`. +1. Stop the Monkey Island process. +1. (Optional but recommended) Move your `.crt` and `.key` files to `%AppData%\monkey_island`. +1. Edit `%AppData%\monkey_island\server_config.json` to configure Monkey Island + to use your certificate. Your config should look something like this: + + ```json {linenos=inline,hl_lines=["11-14"]} + { + "log_level": "DEBUG", + "environment": { + "server_config": "password", + "deployment": "windows" + }, + "mongodb": { + "start_mongodb": true + }, + "ssl_certificate": { + "ssl_certificate_file": "", + "ssl_certificate_key_file": "" + } + } + ``` +1. Run the Monkey Island by clicking on the desktop shortcut. + ## Troubleshooting ### Support