Merge pull request #1541 from guardicore/1530-docs-use-backup-data-dir

Documentation updates for data directory deletion/backup on installing a new version

docs/content/FAQ/_index.md

@@ -8,6 +8,8 @@ pre: "<i class='fas fa-question'></i> "
 Below are some of the most common questions we receive about the Infection Monkey. If the answer you're looking for isn't here, talk with us [on our Slack channel](https://infectionmonkey.slack.com/join/shared_invite/enQtNDU5MjAxMjg1MjU1LWM0NjVmNWE2ZTMzYzAxOWJiYmMxMzU0NWU3NmUxYjcyNjk0YWY2MDkwODk4NGMyNDU4NzA4MDljOWNmZWViNDU), email us at [support@infectionmonkey.com](mailto:support@infectionmonkey.com) or [open an issue on GitHub](https://github.com/guardicore/monkey).
 
 - [Where can I get the latest version of the Infection Monkey?](#where-can-i-get-the-latest-version-of-the-infection-monkey)
+- [I updated to a new version of the Infection Monkey and I'm being asked to delete my existing data directory. Why?](#i-updated-to-a-new-version-of-the-infection-monkey-and-im-being-asked-to-delete-my-existing-data-directory-why)
+- [How can I use an old data directory?](#how-can-i-use-an-old-data-directory)
 - [How long does a single Infection Monkey agent run? Is there a time limit?](#how-long-does-a-single-infection-monkey-agent-run-is-there-a-time-limit)
 - [Is the Infection Monkey a malware/virus?](#is-the-infection-monkey-a-malwarevirus)
 - [Reset/enable the Monkey Island password](#resetenable-the-monkey-island-password)
@@ -35,6 +37,24 @@ For the latest **stable** release, visit [our downloads page](https://www.guardi
 
 If you want to see what has changed between versions, refer to the [releases page on GitHub](https://github.com/guardicore/monkey/releases). For the latest development version, visit the [develop version on GitHub](https://github.com/guardicore/monkey/tree/develop).
 
+## I updated to a new version of the Infection Monkey and I'm being asked to delete my existing data directory. Why?
+
+The [data directory]({{< ref "/reference/data_directory" >}}) contains the
+Infection Monkey's database and other internal
+data. For the new version of Infection Monkey to work flawlessly, a data
+directory with a compatible structure needs to be set up.
+
+If you would like to save the data gathered from the Monkey's previous runs,
+you can make a backup of your [existing data directory]({{< ref
+"/reference/data_directory" >}}) before deleting it.
+
+## How can I use an old data directory?
+
+To use the data stored in a data directory from an older version, reinstall the
+version of the Monkey Island which matches your data directory's version. Then,
+copy the backup of your old data directory to the [appropriate location]({{<
+ref "/reference/data_directory" >}}).
+
 ## How long does a single Infection Monkey agent run? Is there a time limit?
 
 The Infection Monkey agent shuts off either when it can't find new victims or it has exceeded the quota of victims as defined in the configuration.

docs/content/reference/data_directory.md

@@ -16,3 +16,30 @@ configuration files, etc.
 
 On Linux, the default path is `$HOME/.monkey_island`.
 On Windows, the default path is `%AppData%\monkey_island`.
+
+## How do I configure the location of the data directory on Linux?
+
+The location of the data directory is set in the `data_dir` field in the
+`server_config.json` file.
+
+1. Create a custom `server_config.json` file and set the `data_dir` field. Its
+   contents will look like:
+
+    ```json
+    {
+      "log_level": "DEBUG",
+      "environment": {
+        "server_config": "password"
+      },
+      "mongodb": {
+            "start_mongodb": true
+      },
+      "data_dir": "<PATH_TO_DATA_DIR>"
+    }
+    ```
+
+1. Start the Infection Monkey with the `--server-config` parameter.
+
+    ```bash
+    $ InfectionMonkey-VERSION.AppImage --server-config <PATH_TO_SERVER_CONFIG>
+    ```

docs/content/setup/linux.md

@@ -36,6 +36,13 @@ installed, but the ones that we've tested are:
 1. Access the Monkey Island web UI by pointing your browser at
    `https://localhost:5000`.
 
+{{% 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 %}}
+
 ### Start Monkey Island with user-provided certificate
 
 By default, Infection Monkey comes with a [self-signed SSL

docs/content/setup/windows.md

@@ -20,6 +20,13 @@ 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.
 
+{{% 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 %}}
+
 ### Start Monkey Island with user-provided certificate
 
 By default, Infection Monkey comes with a [self-signed SSL certificate](https://aboutssl.org/what-is-self-sign-certificate/). In